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

Class LogModelStub

java.lang.Object

de.mid.innovator.m2msdk.model.log.LogModelStub

All Implemented Interfaces:

LogModelInterface, Serializable, Remote

public class LogModelStub
extends Object
implements LogModelInterface

Stub class living on client side and always forwarding the calls to the server.

Version:

11.3.1

Author:

jmback

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
LogModelStub(LogModelInterface iLog)

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 level)	Check if messages of the given log level are logged.
void	prepareEvents()	Prepare all new events.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

LogModelStub

public LogModelStub(LogModelInterface iLog)

Method Details

append

public void append(LogLevel level,
 Object obj)
            throws RemoteException

Description copied from interface: LogModelInterface

Append a new log event to the log model.

Specified by:

append in interface LogModelInterface

Parameters:

level - Log level

obj - Message object

Throws:

RemoteException

cleanEvent

public void cleanEvent(LogLevel level)
                throws RemoteException

Description copied from interface: LogModelInterface

Clean all archived log events with a specific level.

Specified by:

cleanEvent in interface LogModelInterface

Parameters:

level - Log level

Throws:

RemoteException

getLogEvent

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

Description copied from interface: LogModelInterface

Get all archived log events of a specific level.

Specified by:

getLogEvent in interface LogModelInterface

Parameters:

level - Log level

Returns:

List of log events

Throws:

RemoteException

M2MException

hasAborted

public boolean hasAborted()
                   throws RemoteException,
M2MException

Description copied from interface: LogModelInterface

Has there been an abort exception thrown?

Specified by:

hasAborted in interface LogModelInterface

Returns:

True, if there has been an abort exception thrown.

Throws:

RemoteException

M2MException

isLevelLogged

public boolean isLevelLogged(LogLevel level)
                      throws RemoteException

Description copied from interface: LogModelInterface

Check if messages of the given log level are logged.

Specified by:

isLevelLogged in interface LogModelInterface

Parameters:

level - log level to check

Returns:

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

Throws:

RemoteException

getChangeAsXML

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

Description copied from interface: LogModelInterface

Get all archived change messages as a XML file content.

Specified by:

getChangeAsXML in interface LogModelInterface

Returns:

all changes as a XML string

Throws:

RemoteException

M2MException

getErrorAsXML

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

Description copied from interface: LogModelInterface

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

Specified by:

getErrorAsXML in interface LogModelInterface

Returns:

all changes as a XML string

Throws:

RemoteException

M2MException

archiveEvents

public ArrayList<LogEventInterface> archiveEvents()
                                           throws RemoteException

Description copied from interface: LogModelInterface

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

Specified by:

archiveEvents in interface LogModelInterface

Returns:

List of prepared log events

Throws:

RemoteException

prepareEvents

public void prepareEvents()
                   throws RemoteException

Description copied from interface: LogModelInterface

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.

Specified by:

prepareEvents in interface LogModelInterface

Throws:

RemoteException

finalizeSession

public void finalizeSession()
                     throws RemoteException

Description copied from interface: LogModelInterface

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

Specified by:

finalizeSession in interface LogModelInterface

Throws:

RemoteException

getLastLogEvent

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

Description copied from interface: LogModelInterface

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

Specified by:

getLastLogEvent in interface LogModelInterface

Parameters:

level - Log level

Returns:

List of log events

Throws:

RemoteException

M2MException