Package de.mid.innovator.m2msdk.model.log

Interface LogModelInterface

All Superinterfaces:

Remote, Serializable

All Known Implementing Classes:

LogModel, LogModelSkeleton, LogModelStub

public interface LogModelInterface
extends Serializable, Remote

Interface to access log model.

Version:

10.1.1

Author:

jmback

Method Summary

Modifier and Type	Method	Description
void	append(LogLevel level, Object obj)	Append a new log event to the log model.
ArrayList<LogEventInterface>	archiveEvents()	Archive all prepared events.
void	cleanEvent(LogLevel level)	Clean all archived log events with a specific level.
void	finalizeSession()	End the current log model and finalize all included objects.
org.jdom2.Document	getChangeAsXML()	Get all archived change messages as a XML file content.
org.jdom2.Document	getErrorAsXML()	Get all archived warnings, errors and fatal error messages as a XML file content.
ArrayList<LogEventInterface>	getLastLogEvent(LogLevel level)	Get all archived log events of a specific level since last call of this method.
ArrayList<LogEventInterface>	getLogEvent(LogLevel level)	Get all archived log events of a specific level.
boolean	hasAborted()	Has there been an abort exception thrown?
boolean	isLevelLogged(LogLevel iLevel)	Check if messages of the given log level are logged.
void	prepareEvents()	Prepare all new events.

Method Details

append

void append(LogLevel level,
 Object obj)
     throws RemoteException

Append a new log event to the log model.

Parameters:

level - Log level

obj - Message object

Throws:

RemoteException

isLevelLogged

boolean isLevelLogged(LogLevel iLevel)
               throws RemoteException

Check if messages of the given log level are logged.

Parameters:

iLevel - log level to check

Returns:

true, if the log level is equal or greater than the log level set by option "LogLevel".

Throws:

RemoteException

getLogEvent

ArrayList<LogEventInterface> getLogEvent(LogLevel level)
                                  throws RemoteException,
M2MException

Get all archived log events of a specific level.

Parameters:

level - Log level

Returns:

List of log events

Throws:

RemoteException

M2MException

getLastLogEvent

ArrayList<LogEventInterface> getLastLogEvent(LogLevel level)
                                      throws RemoteException,
M2MException

Get all archived log events of a specific level since last call of this method.

Parameters:

level - Log level

Returns:

List of log events

Throws:

RemoteException

M2MException

hasAborted

boolean hasAborted()
            throws RemoteException,
M2MException

Has there been an abort exception thrown?

Returns:

True, if there has been an abort exception thrown.

Throws:

RemoteException

M2MException

cleanEvent

void cleanEvent(LogLevel level)
         throws RemoteException

Clean all archived log events with a specific level.

Parameters:

level - Log level

Throws:

RemoteException

prepareEvents

void prepareEvents()
            throws RemoteException

Prepare all new events. Since the preparation accesses the model element model, this call has to be synchronized with the model element model access. Preparation means that a prepared message is no longer related to the model element model, e.g. contains only strings. It it now ready to be serialized and archived.

Throws:

RemoteException

archiveEvents

ArrayList<LogEventInterface> archiveEvents()
                                    throws RemoteException

Archive all prepared events. An archived event is also available to be visualized to the user.

Returns:

List of prepared log events

Throws:

RemoteException

getChangeAsXML

org.jdom2.Document getChangeAsXML()
                           throws RemoteException,
M2MException

Get all archived change messages as a XML file content.

Returns:

all changes as a XML string

Throws:

RemoteException

M2MException

getErrorAsXML

org.jdom2.Document getErrorAsXML()
                          throws RemoteException,
M2MException

Get all archived warnings, errors and fatal error messages as a XML file content.

Returns:

all changes as a XML string

Throws:

RemoteException

M2MException

finalizeSession

void finalizeSession()
              throws RemoteException

End the current log model and finalize all included objects. Close files, streams, etc.

Throws:

RemoteException