org.processmining.plugins.operationalsupport

Class OSServiceManagerPlugin

java.lang.Object

org.processmining.plugins.operationalsupport.OSServiceManagerPlugin

All Implemented Interfaces:

org.processmining.framework.util.socket.ServiceEnvironment

public class OSServiceManagerPlugin
extends java.lang.Object
implements org.processmining.framework.util.socket.ServiceEnvironment

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

Constructor Summary

Constructors

Constructor and Description
OSServiceManagerPlugin()

Method Summary

Modifier and Type	Method and Description
void	cancel() A service uses this method to signal that it has been canceled (i.e., the socket is closed).
boolean	isCancelled() Provides the information about the state of the environment.
void	log(java.lang.String message) A service uses this method to log messages in the environment.
void	log(java.lang.String message, org.processmining.framework.plugin.events.Logger.MessageLevel level) A service uses this method to log messages in the environment.
void	log(java.lang.Throwable t) A service uses this method to log occurrence of an exception in the environment.
void	manage(org.processmining.framework.plugin.PluginContext context, OSService service)
void	manageUI(org.processmining.contexts.uitopia.UIPluginContext context, OSService service)
void	stillAlive() While listening on its socket, a service will regularly invoke this method.

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

Constructor Detail

OSServiceManagerPlugin

public OSServiceManagerPlugin()

Method Detail

manageUI

public void manageUI(org.processmining.contexts.uitopia.UIPluginContext context,
                     OSService service)
              throws java.io.IOException

Throws:

java.io.IOException

manage

public void manage(org.processmining.framework.plugin.PluginContext context,
                   OSService service)
            throws java.io.IOException

Throws:

java.io.IOException

isCancelled

public boolean isCancelled()

Description copied from interface: org.processmining.framework.util.socket.ServiceEnvironment

Provides the information about the state of the environment. A service uses this method to decide when to close its socket.

Specified by:

isCancelled in interface org.processmining.framework.util.socket.ServiceEnvironment

Returns:

true - if the socket should be closed false - if the service should continue listening on the socket.

log

public void log(java.lang.String message,
                org.processmining.framework.plugin.events.Logger.MessageLevel level)

Description copied from interface: org.processmining.framework.util.socket.ServiceEnvironment

A service uses this method to log messages in the environment.

Specified by:

log in interface org.processmining.framework.util.socket.ServiceEnvironment

Parameters:

message - is the message that should be logged

level - is the type of message

log

public void log(java.lang.String message)

Description copied from interface: org.processmining.framework.util.socket.ServiceEnvironment

A service uses this method to log messages in the environment.

Specified by:

log in interface org.processmining.framework.util.socket.ServiceEnvironment

Parameters:

message - is the message that should be logged

log

public void log(java.lang.Throwable t)

Description copied from interface: org.processmining.framework.util.socket.ServiceEnvironment

A service uses this method to log occurrence of an exception in the environment.

Specified by:

log in interface org.processmining.framework.util.socket.ServiceEnvironment

Parameters:

t - is the exception that occurred and should be logged

cancel

public void cancel()

Description copied from interface: org.processmining.framework.util.socket.ServiceEnvironment

A service uses this method to signal that it has been canceled (i.e., the socket is closed).

Specified by:

cancel in interface org.processmining.framework.util.socket.ServiceEnvironment

stillAlive

public void stillAlive()

Description copied from interface: org.processmining.framework.util.socket.ServiceEnvironment

While listening on its socket, a service will regularly invoke this method. This method periodically signals to the environment that the service is still listening to its socket.

Specified by:

stillAlive in interface org.processmining.framework.util.socket.ServiceEnvironment