org.da.protoframework.model.core

Class ServiceInstance<S extends Service<?>,I extends InterfaceDefinition>

java.lang.Object

org.da.protoframework.model.core.ServiceInstance<S,I>

Type Parameters:

S - the associated Service type

I - the associated InterfaceDefinition type

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

ListenServiceInstance, PublishServiceInstance, ReceiveEventServiceInstance, RequestServiceInstance, ResponseServiceInstance, SendEventServiceInstance, SubscribeServiceInstance

public abstract class ServiceInstance<S extends Service<?>,I extends InterfaceDefinition>
extends java.lang.Object
implements java.lang.Cloneable

Represent the instanciation of a Service on a Module.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.reflect.Method	attachmethod The Module attach / detach method.
protected Datas	datas The Service datas.
protected boolean	externalTimeStamp True if the timestamp of the service has been set externally.
protected I	interDef The associated interface definition.
protected boolean	isActive Return true if the Service is active.
protected Module	module The associated Module.
protected java.lang.reflect.Method	recmethod The Module receive method.
protected java.lang.reflect.Method	sendmethod The Module send method.
protected S	service The associated Service.

Constructor Summary

Constructors

Constructor and Description
ServiceInstance(S service, I interDef, Module module) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addProtocol(org.da.protoframework.com.netty.ProtocolKey key, org.da.protoframework.com.netty.Protocol protocol) Add a Protocol.
protected void	afterInvoke() Performed after the Service has been invoked.
boolean	attach() Attach to the modules providers.
boolean	attach(ModuleIDKey key) Attach a module to the modules providers.
boolean	attach(ModuleKey key) Attach a module to the modules providers.
protected void	beforeInvoke() Performed before the Service is invoked.
ServiceInstance<S,I>	clone() Clone the service.
boolean	copyFromService(ServiceInstance<?,?> service) Copy the values of the output datas of a service to this service.
boolean	copyFromService(ServiceInstance<?,?> service, boolean strict) Copy the values of the output datas of a service to this service.
boolean	copyFromService(ServiceInstance<?,?> service, boolean clone, boolean strict) Copy the values of the output datas of a service to this service.
int	countDatas() Return the number of Datas in the Service.
ServiceInstance<S,I>	createCopy() Return a copy of the service.
boolean	detach() Detach from the modules providers.
boolean	detach(ModuleIDKey key) Detach a module from the modules providers.
boolean	detach(ModuleKey key) Detach a module from the modules providers.
boolean	error(char errorType) Invoke the Service.
protected int	fireEventLogger() Fire the event logger factory and return the current incocation count.
ServiceInstance<?,?>	getBroadcast() Return the broadcast service instance associated with this service instance.
Data<?>	getData(java.lang.String name) Return the Data of a specified name.
Data.Array	getDataAsArray(java.lang.String name) Return the Data of a specified name, as an array. it will return null if the Data is not an array.
Data.MapData	getDataAsMap(java.lang.String name) Return the Data of a specified name, as a Map. it will return null if the Data is not a Map.
Data.Structure	getDataAsStructure(java.lang.String name) Return the Data of a specified name, as a structure. it will return null if the Data is not a structure.
Data.Switch	getDataAsSwitch(java.lang.String name) Return the Data of a specified name, as a Switch. it will return null if the Data is not a Switch.
Data.Union	getDataAsUnion(java.lang.String name) Return the Data of a specified name, as an Union. it will return null if the Data is not a Union.
Datas	getDatas() Return the Service instance datas.
Type	getDataType(java.lang.String name) Return the type of the Data a specified name.
java.lang.Object	getDataValue(java.lang.String name) Return a data value.
java.util.Map<java.lang.String,Data<?>>	getDataValues() Return the Service instance datas.
I	getDefinition() Return the associated interface definition.
long	getElapsedTime() Return the elapsed time is milliseconds since the start of the framework (using the getTimestampMillis().
char	getErrorType() Return the error type for the ServiceState.
java.lang.String	getFullName() Return the Service full instance name.
long	getID() Return the Service ID.
java.util.Map<ModuleIDKey,ServiceInstance<?,?>>	getInstanceListeners() Return the Service instance subscribers.
java.util.Map<ModuleIDKey,ServiceInstance<?,?>>	getInstanceSubscribers() Return the Service instance subscribers.
long	getInvokerAppliID() Return the long ID of the application which last invoked the Service.
Module	getInvokerModule() Return the module which last invoked the Service.
long	getInvokerModuleID() Return the long ID of the module which last invoked the Service.
NamespaceKey	getKey() Return the Service instance key.
Module	getModule() Return the Service module.
ModuleIDKey	getModuleIDKey() Return the ModuleID key of this Service Module.
ModuleKey	getModuleKey() Return the Module key of this Service Module.
java.lang.String	getName() Return the Service instance name.
java.net.URI	getNamespace() Return the service namespace.
java.lang.String	getNamespaceAsString() Return the service namespace as a String.
NamespaceKey	getNotNullKey() Return the Service instance key, making sure the key is never null.
java.util.Map<org.da.protoframework.com.netty.ProtocolKey,org.da.protoframework.com.netty.Protocol>	getProtocols() Return the Map of protocols for the Service.
java.lang.reflect.Method	getSendMethod() Return the Module send method.
long	getSendRequestID() Return the Service request ID if the Service maintains a request ID.
S	getService() Return the associated Service.
java.lang.String	getServiceKeyName() Return the namespace identification of the associated service.
org.da.protoframework.model.core.ServiceState	getState() Return the state of the Service.
java.time.Duration	getTimestamp() Return the Service instance timestamp.
long	getTimestampMillis() Return the Service instance timestamp in ms.
Type	getType(NamespaceKey key) Return the type of a specified key.
Type	getType(java.lang.String name) Return the type of a specified name.
java.lang.Object	getValue(java.lang.String name) Return a data value.
java.util.List<java.lang.Object>	getValueAsArray(java.lang.String name) Return a data value as an array.
boolean	getValueAsBoolean(java.lang.String name) Return a data value as a boolean.
byte	getValueAsByte(java.lang.String name) Return a data value as a byte.
char	getValueAsChar(java.lang.String name) Return a data value as a char.
double	getValueAsDouble(java.lang.String name) Return a data value as a double.
double	getValueAsDouble(java.lang.String name, short unit) Return a data value as a double.
float	getValueAsFloat(java.lang.String name) Return a data value as a float.
float	getValueAsFloat(java.lang.String name, short unit) Return a data value as a float.
int	getValueAsInt(java.lang.String name) Return a data value as an int.
org.json.JSONElement	getValueAsJSON(java.lang.String name) Return a data value as a JSONObject.
long	getValueAsLong(java.lang.String name) Return a data value as a long.
short	getValueAsShort(java.lang.String name) Return a data value as a short.
java.lang.String	getValueAsString(java.lang.String name) Return a data value as a String.
java.util.List<java.lang.Object>	getValueAsStructure(java.lang.String name) Return a data value as a Structure.
java.net.URL	getValueAsURL(java.lang.String name) Return a data value as an URL.
org.mdiutil.xml.tree.XMLNode	getValueAsXML(java.lang.String name) Return a data value as an XMLNode.
static ServiceInstance<?,?>	getVoidService() Return an empty Service instance, which does nothing.
boolean	hasBroadcast() Return true if there is a broadcast service instance associated with this service instance.
boolean	hasChanged() Return true if at least one Data in the service has changed since the last reception.
boolean	hasChanged(java.lang.String name) Return true if the Data with a specified name has changed since the last reception.
boolean	hasData(java.lang.String name) Return true if there is a Data for a specified name.
boolean	hasData(java.lang.String name, boolean isInput) Return true if there is a Data for a specified name.
boolean	hasDatas(boolean isInput) Return true if the Service instance has some datas for receiving or invoking services.
boolean	hasQualifiedName(java.lang.String name) Return true if the qualified name of the Service is equal to a specified key.
boolean	hasQualifiedName(java.lang.String uri, java.lang.String name) Return true if the qualified name of the Service is equal to a specified key.
boolean	hasRequestID() Return true if the Service maintains a request ID.
protected boolean	hasUpdateCap() Return Module.hasAllUpdateCap() by default.
boolean	invoke() Invoke the Service.
protected boolean	invoke(char invokeType) Invoke the Service.
boolean	invokeAndBlock() Invoke the Service.
boolean	invokeAndCopy() Invoke the Service.
boolean	invokedByMe() Return true if the invocation of this service was performed by this module.
boolean	isActive() Return true if the Service is active.
boolean	isCopyingDatas() Return true if the datas of the service must be copied before being sent.
boolean	isEnabled() Return if the underlying module is enabled.
boolean	isInvoked() Return true if the service has been invoked at least once.
boolean	isNominal() Return true if the state of the Service is nominal.
boolean	isNotified() Return true if the service has been notified at least once.
abstract boolean	isProvidingData() Return true if this Service instanciation provides data to its associated Service.
boolean	isSubscribedTo(java.lang.String topic) Return true if the Service instance is subscribed to a specified topic.
abstract boolean	isSubscriber() Return true if this Service instanciation subscribes to its associated Service.
boolean	isUsingExecutorMode() Return true if the service if the executor mode is used to send services.
void	notified(char type) Be notified of the execution of the Service.
void	notified(char type, boolean forceBlock) Be notified of the execution of the Service.
void	notified(char type, char invokeType) Be notified of the execution of the Service.
void	notified(char type, char invokeType, Datas datas) Be notified of the execution of the Service.
void	notified(char type, int count, boolean forceBlock) Be notified of the execution of the Service.
void	notified(char type, int count, char invokeType) Be notified of the execution of the Service.
void	notified(char type, int count, char invokeType, Datas datas) Be notified of the execution of the Service.
protected void	notifiedAttachDetach(char type) Called for a MessageConstants.ATTACH MessageConstants.DETACH or notification.
protected void	notifiedException(char type) Called for a MessageConstants.EXCEPTION notification.
protected void	notifiedInvoke(char type, int count, char invokeType) Called for a MessageConstants.INVOKE notification.
void	notifiedOnError(char errorType) Be notified of the execution of the Service.
void	preSetup() pre-setup the Service instance.
void	setActive(boolean isActive) Set if the Service is active.
protected void	setAttachEntryPointMethod(java.lang.reflect.Method method) Set the attach / detach entry-point method.
void	setBroadcast(ServiceInstance<?,?> broadcast) Set the broadcast service instance associated with this service instance.
short	setDataBooleanValue(java.lang.String name, boolean value) Set a boolean Data value.
short	setDataByteValue(java.lang.String name, byte value) Set a byte Data value.
short	setDataCharValue(java.lang.String name, char value) Set a char Data value.
short	setDataDoubleValue(java.lang.String name, double value) Set a double Data value.
short	setDataDoubleValue(java.lang.String name, double value, short unit) Set a double Data value.
short	setDataFileValue(java.lang.String name, java.io.File value) Set a File Data value.
short	setDataFloatValue(java.lang.String name, float value) Set a float Data value.
short	setDataFloatValue(java.lang.String name, float value, short unit) Set a float Data value.
short	setDataIntValue(java.lang.String name, int value) Set an int Data value.
short	setDataJSONValue(java.lang.String name, org.json.JSONElement value) Set a JSON Data value.
short	setDataLongValue(java.lang.String name, long value) Set a long Data value.
short	setDataShortValue(java.lang.String name, short value) Set a short Data value.
short	setDataStringValue(java.lang.String name, java.lang.String value) Set a String Data value.
short	setDataURLValue(java.lang.String name, java.lang.String value) Set an URL Data value.
short	setDataURLValue(java.lang.String name, java.net.URL value) Set an URL Data value.
short	setDataValue(java.lang.String name, java.lang.Object value) Set a Data value.
short	setDataXMLValue(java.lang.String name, org.json.JSONElement value) Set a JSONObject Data value.
short	setDataXMLValue(java.lang.String name, java.lang.String value) Set an XML Data value.
short	setDataXMLValue(java.lang.String name, org.mdiutil.xml.tree.XMLNode value) Set an XML Data value.
protected void	setEntryPointMethod(java.lang.reflect.Method method) Set the entry-point method.
void	setInvoker(long appliD, long moduleID) Set the application ID and module ID which last invoked the Service.
void	setReceivedRequestID(long requestID) Set the request ID received by the Service instance.
void	setState(org.da.protoframework.model.core.ServiceState state) Set the ServiceState.
void	setTime(java.time.Duration duration) Set the Service instance timestamp.
void	setTime(long time) Set the Service instance timestamp.
protected void	setTimeInternal() Internally set the timestamp of the service.
void	setUp() SetUp the Service instance.
void	shutdown() Shutdown the Service Instance.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

interDef

protected I extends InterfaceDefinition interDef

The associated interface definition.

service

protected S extends Service<?> service

The associated Service.

module

protected Module module

The associated Module.

sendmethod

protected java.lang.reflect.Method sendmethod

The Module send method.

recmethod

protected java.lang.reflect.Method recmethod

The Module receive method.

attachmethod

protected java.lang.reflect.Method attachmethod

The Module attach / detach method.

datas

protected Datas datas

The Service datas.

externalTimeStamp

protected boolean externalTimeStamp

True if the timestamp of the service has been set externally.

isActive

protected boolean isActive

Return true if the Service is active.

Constructor Detail

ServiceInstance

public ServiceInstance(S service,
                       I interDef,
                       Module module)

Constructor. Note that by default a Service is automatically active when created.

Parameters:

service - the Service

interDef - the intefaces definition

module - the Module

Method Detail

getSendMethod

public java.lang.reflect.Method getSendMethod()

Return the Module send method.

Returns:

the method

getVoidService

public static ServiceInstance<?,?> getVoidService()

Return an empty Service instance, which does nothing.

Returns:

the empty Service instance

isUsingExecutorMode

public boolean isUsingExecutorMode()

Return true if the service if the executor mode is used to send services.

Returns:

true if the service if the executor mode is used to send services

setBroadcast

public void setBroadcast(ServiceInstance<?,?> broadcast)

Set the broadcast service instance associated with this service instance.

Parameters:

broadcast - the broadcast service instance

hasBroadcast

public boolean hasBroadcast()

Return true if there is a broadcast service instance associated with this service instance.

Returns:

true if there is a broadcast service instance associated with this service instance

getBroadcast

public ServiceInstance<?,?> getBroadcast()

Return the broadcast service instance associated with this service instance.

Returns:

the broadcast service instance

copyFromService

public boolean copyFromService(ServiceInstance<?,?> service)

Copy the values of the output datas of a service to this service. Note that the framework will try to copy as much content for each data as it is possible

Parameters:

service - the service to copy

Returns:

true if the copy could be performed

See Also:

Data.copy(org.da.protoframework.model.core.Data, boolean)

copyFromService

public boolean copyFromService(ServiceInstance<?,?> service,
                               boolean strict)

Copy the values of the output datas of a service to this service. The way the copy is performed depend on the value of the strict argument:

• If the value of the argument is true, only the datas of same name and same type will be copied
• If the value of the argument is false, the framework will try to copy as much content for each data as it is possible (as when using the Data.copy(org.da.protoframework.model.core.Data, boolean) with the second argument set to true)

Parameters:

service - the service to copy

strict - true if the framework should check if the types of the datas are identical to make the copy for each data

Returns:

true if the copy could be performed

copyFromService

public boolean copyFromService(ServiceInstance<?,?> service,
                               boolean clone,
                               boolean strict)

Copy the values of the output datas of a service to this service. The way the copy is performed depend on the value of the strict argument:

• If the value of the argument is true, only the datas of same name and same type will be copied
• If the value of the argument is false, the framework will try to copy as much content for each data as it is possible (as when using the Data.copy(org.da.protoframework.model.core.Data, boolean) with the second argument set to true)

Parameters:

service - the service to copy

clone - if the data content must be cloned

strict - true if the framework should check if the types of the datas are identical to make the copy for each data

Returns:

true if the copy could be performed

clone

public ServiceInstance<S,I> clone()

Clone the service. Return this service by default.

Overrides:

clone in class java.lang.Object

Returns:

this service

createCopy

public ServiceInstance<S,I> createCopy()

Return a copy of the service. Return this service by default.

Returns:

this service

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getServiceKeyName

public java.lang.String getServiceKeyName()

Return the namespace identification of the associated service.

Returns:

the associated service identification

shutdown

public void shutdown()

Shutdown the Service Instance. Do nothing by default.

getModuleKey

public ModuleKey getModuleKey()

Return the Module key of this Service Module.

Returns:

the Module key

getModuleIDKey

public ModuleIDKey getModuleIDKey()

Return the ModuleID key of this Service Module.

Returns:

the ModuleID key

getModule

public Module getModule()

Return the Service module.

Returns:

the module

isActive

public boolean isActive()

Return true if the Service is active. Note that by default a Service is automatically active when created.

Returns:

true if the Service is active

getState

public org.da.protoframework.model.core.ServiceState getState()

Return the state of the Service. Note that is can return:

• null of ServiceState.NOMINAL for a nominal state
• Another Service state for an error state

If the state is not a nominal state, the ServiceState.isNominal() will return false.

Returns:

the Service State

getErrorType

public char getErrorType()

Return the error type for the ServiceState. It will return MessageConstants.ERROR_NO_ERROR for a nominal state.

Returns:

the error type for the ServiceState

See Also:

getState()

isNominal

public boolean isNominal()

Return true if the state of the Service is nominal.

Returns:

true if the state of the Service is nominal

See Also:

getState()

setState

public void setState(org.da.protoframework.model.core.ServiceState state)

Set the ServiceState.

Parameters:

state - the ServiceState

See Also:

getState()

isSubscriber

public abstract boolean isSubscriber()

Return true if this Service instanciation subscribes to its associated Service.

Returns:

true if this Service instanciation subscribes to its associated Service

isProvidingData

public abstract boolean isProvidingData()

Return true if this Service instanciation provides data to its associated Service.

Returns:

true if this Service instanciation provides data to its associated Service

hasRequestID

public boolean hasRequestID()

Return true if the Service maintains a request ID.

Returns:

true if the Service maintains a request ID

getSendRequestID

public long getSendRequestID()

Return the Service request ID if the Service maintains a request ID.

Returns:

the Service request ID if the Service maintains a request ID

setReceivedRequestID

public void setReceivedRequestID(long requestID)

Set the request ID received by the Service instance. Do nothing by default.

Parameters:

requestID - the request ID

setActive

public void setActive(boolean isActive)

Set if the Service is active.

Parameters:

isActive - true if the Service is active

isSubscribedTo

public boolean isSubscribedTo(java.lang.String topic)

Return true if the Service instance is subscribed to a specified topic.

Parameters:

topic - the topic

Returns:

true if the Service instance is subscribed to the topic

getID

public long getID()

Return the Service ID.

Returns:

the Service ID

getDataValues

public java.util.Map<java.lang.String,Data<?>> getDataValues()

Return the Service instance datas.

Returns:

the Service instance datas

countDatas

public int countDatas()

Return the number of Datas in the Service.

Returns:

the number of Datas in the Service

getDatas

public Datas getDatas()

Return the Service instance datas.

Returns:

the Service instance datas

addProtocol

public void addProtocol(org.da.protoframework.com.netty.ProtocolKey key,
                        org.da.protoframework.com.netty.Protocol protocol)

Add a Protocol.

Parameters:

key - the Protocol key

protocol - the Protocol

getProtocols

public java.util.Map<org.da.protoframework.com.netty.ProtocolKey,org.da.protoframework.com.netty.Protocol> getProtocols()

Return the Map of protocols for the Service.

Returns:

the Map of protocols for the Service

setTime

public void setTime(long time)

Set the Service instance timestamp. It is the timestamp of the last reception or emission.

Parameters:

time - the timestamp

setTime

public void setTime(java.time.Duration duration)

Set the Service instance timestamp. It is the timestamp of the last reception or emission.

Parameters:

duration - the timestamp

setTimeInternal

protected void setTimeInternal()

Internally set the timestamp of the service.

getTimestamp

public java.time.Duration getTimestamp()

Return the Service instance timestamp.

Returns:

the Service timestamp

getTimestampMillis

public long getTimestampMillis()

Return the Service instance timestamp in ms.

Returns:

the Service timestamp

getElapsedTime

public long getElapsedTime()

Return the elapsed time is milliseconds since the start of the framework (using the getTimestampMillis().

Returns:

the elapsed time

getService

public S getService()

Return the associated Service.

Returns:

the Service

getInstanceListeners

public java.util.Map<ModuleIDKey,ServiceInstance<?,?>> getInstanceListeners()

Return the Service instance subscribers.

Returns:

the subscribers

getInstanceSubscribers

public java.util.Map<ModuleIDKey,ServiceInstance<?,?>> getInstanceSubscribers()

Return the Service instance subscribers.

Returns:

the subscribers

getDefinition

public I getDefinition()

Return the associated interface definition.

Returns:

the interface definition

getFullName

public java.lang.String getFullName()

Return the Service full instance name. It will be the name of the element without the URI if it has no URI, or the name concatenated with the URI if it has a URI. For example:

• "theService"
• "http://my.uri:theService"

Returns:

the Service full instance name

getName

public java.lang.String getName()

Return the Service instance name.

Returns:

the Service instance name

getNamespace

public java.net.URI getNamespace()

Return the service namespace.

Returns:

the service namespace

getNamespaceAsString

public java.lang.String getNamespaceAsString()

Return the service namespace as a String.

Returns:

the service namespace as a String

hasQualifiedName

public boolean hasQualifiedName(java.lang.String uri,
                                java.lang.String name)

Return true if the qualified name of the Service is equal to a specified key.

Parameters:

uri - the key URI as a String

name - the key name

Returns:

true if the qualified name of the Service is equal to the specified key

hasQualifiedName

public boolean hasQualifiedName(java.lang.String name)

Return true if the qualified name of the Service is equal to a specified key.

Parameters:

name - the key name

Returns:

true if the qualified name of the Service is equal to the specified key

getKey

public NamespaceKey getKey()

Return the Service instance key.

Returns:

the Service instance key

getNotNullKey

public NamespaceKey getNotNullKey()

Return the Service instance key, making sure the key is never null. For a null key, it will return the key of the Void Service instance.

Returns:

the Service instance key

getDataAsStructure

public Data.Structure getDataAsStructure(java.lang.String name)

Return the Data of a specified name, as a structure. it will return null if the Data is not a structure.

Parameters:

name - the name

Returns:

the Data

getDataAsArray

public Data.Array getDataAsArray(java.lang.String name)

Return the Data of a specified name, as an array. it will return null if the Data is not an array.

Parameters:

name - the name

Returns:

the Data

getDataAsMap

public Data.MapData getDataAsMap(java.lang.String name)

Return the Data of a specified name, as a Map. it will return null if the Data is not a Map.

Parameters:

name - the name

Returns:

the Data

getDataAsUnion

public Data.Union getDataAsUnion(java.lang.String name)

Return the Data of a specified name, as an Union. it will return null if the Data is not a Union.

Parameters:

name - the name

Returns:

the Data

getDataAsSwitch

public Data.Switch getDataAsSwitch(java.lang.String name)

Return the Data of a specified name, as a Switch. it will return null if the Data is not a Switch.

Parameters:

name - the name

Returns:

the Data

getData

public Data<?> getData(java.lang.String name)

Return the Data of a specified name.

Parameters:

name - the name

Returns:

the Data

getDataType

public Type getDataType(java.lang.String name)

Return the type of the Data a specified name.

Parameters:

name - the name of the Data

Returns:

the Data Type

getType

public Type getType(java.lang.String name)

Return the type of a specified name.

Parameters:

name - the type name

Returns:

the type

getType

public Type getType(NamespaceKey key)

Return the type of a specified key.

Parameters:

key - the type key

Returns:

the type

hasData

public boolean hasData(java.lang.String name,
                       boolean isInput)

Return true if there is a Data for a specified name.

Parameters:

name - the name

isInput - true for input datas

Returns:

true if there is a Data for the specified name

hasData

public boolean hasData(java.lang.String name)

Return true if there is a Data for a specified name.

Parameters:

name - the name

Returns:

true if there is a Data for the specified name

hasDatas

public boolean hasDatas(boolean isInput)

Return true if the Service instance has some datas for receiving or invoking services.

Parameters:

isInput - true for receiving services

Returns:

true if the Service instance has some datas

hasChanged

public boolean hasChanged()

Return true if at least one Data in the service has changed since the last reception.

Returns:

true if at least one Data in the service has changed since the last reception

hasChanged

public boolean hasChanged(java.lang.String name)

Return true if the Data with a specified name has changed since the last reception.

Parameters:

name - the data name

Returns:

true if the Data with the specified name has changed since the last reception

setDataValue

public short setDataValue(java.lang.String name,
                          java.lang.Object value)

Set a Data value.

Parameters:

name - the data name

value - the data value

Returns:

the state of the data set (see DataState)

getDataValue

public java.lang.Object getDataValue(java.lang.String name)

Return a data value.

Parameters:

name - the data name

Returns:

the data value

setDataIntValue

public short setDataIntValue(java.lang.String name,
                             int value)

Set an int Data value.

Parameters:

name - the data name

value - the data int value

Returns:

the state of the data set (see DataState)

getValueAsInt

public int getValueAsInt(java.lang.String name)

Return a data value as an int.

Parameters:

name - the data name

Returns:

the data value

setDataByteValue

public short setDataByteValue(java.lang.String name,
                              byte value)

Set a byte Data value.

Parameters:

name - the data name

value - the data byte value

Returns:

the state of the data set (see DataState)

getValueAsByte

public byte getValueAsByte(java.lang.String name)

Return a data value as a byte.

Parameters:

name - the data name

Returns:

the data value

setDataLongValue

public short setDataLongValue(java.lang.String name,
                              long value)

Set a long Data value.

Parameters:

name - the data name

value - the data long value

Returns:

the state of the data set (see DataState)

getValueAsLong

public long getValueAsLong(java.lang.String name)

Return a data value as a long.

Parameters:

name - the data name

Returns:

the data value

setDataCharValue

public short setDataCharValue(java.lang.String name,
                              char value)

Set a char Data value.

Parameters:

name - the data name

value - the data char value

Returns:

the state of the data set (see DataState)

getValueAsChar

public char getValueAsChar(java.lang.String name)

Return a data value as a char.

Parameters:

name - the data name

Returns:

the data value

setDataShortValue

public short setDataShortValue(java.lang.String name,
                               short value)

Set a short Data value.

Parameters:

name - the data name

value - the data short value

Returns:

the state of the data set (see DataState)

getValueAsShort

public short getValueAsShort(java.lang.String name)

Return a data value as a short.

Parameters:

name - the data name

Returns:

the data value

setDataFloatValue

public short setDataFloatValue(java.lang.String name,
                               float value)

Set a float Data value.

Parameters:

name - the data name

value - the data float value

Returns:

the state of the data set (see DataState)

getValueAsFloat

public float getValueAsFloat(java.lang.String name)

Return a data value as a float.

Parameters:

name - the data name

Returns:

the data value

getValueAsFloat

public float getValueAsFloat(java.lang.String name,
                             short unit)

Return a data value as a float.

Parameters:

name - the data name

unit - the unit

Returns:

the data value

setDataFloatValue

public short setDataFloatValue(java.lang.String name,
                               float value,
                               short unit)

Set a float Data value.

Parameters:

name - the data name

value - the data float value

unit - the unit

Returns:

the state of the data set (see DataState)

setDataDoubleValue

public short setDataDoubleValue(java.lang.String name,
                                double value)

Set a double Data value.

Parameters:

name - the data name

value - the data double value

Returns:

the state of the data set (see DataState)

getValueAsDouble

public double getValueAsDouble(java.lang.String name)

Return a data value as a double.

Parameters:

name - the data name

Returns:

the data value

setDataDoubleValue

public short setDataDoubleValue(java.lang.String name,
                                double value,
                                short unit)

Set a double Data value.

Parameters:

name - the data name

value - the data double value

unit - the unit

Returns:

the state of the data set (see DataState)

getValueAsDouble

public double getValueAsDouble(java.lang.String name,
                               short unit)

Return a data value as a double.

Parameters:

name - the data name

unit - the unit

Returns:

the data value

setDataBooleanValue

public short setDataBooleanValue(java.lang.String name,
                                 boolean value)

Set a boolean Data value.

Parameters:

name - the data name

value - the data boolean value

Returns:

the state of the data set (see DataState)

getValueAsBoolean

public boolean getValueAsBoolean(java.lang.String name)

Return a data value as a boolean.

Parameters:

name - the data name

Returns:

the data value

setDataStringValue

public short setDataStringValue(java.lang.String name,
                                java.lang.String value)

Set a String Data value.

Parameters:

name - the data name

value - the data String value

Returns:

the state of the data set (see DataState)

getValueAsString

public java.lang.String getValueAsString(java.lang.String name)

Return a data value as a String.

Parameters:

name - the data name

Returns:

the data value

setDataXMLValue

public short setDataXMLValue(java.lang.String name,
                             java.lang.String value)

Set an XML Data value.

Parameters:

name - the data name

value - the data XML value, as a String

Returns:

the state of the data set (see DataState)

setDataJSONValue

public short setDataJSONValue(java.lang.String name,
                              org.json.JSONElement value)

Set a JSON Data value.

Parameters:

name - the data name

value - the data JSON value, as a String

Returns:

the state of the data set (see DataState)

getValueAsXML

public org.mdiutil.xml.tree.XMLNode getValueAsXML(java.lang.String name)

Return a data value as an XMLNode.

Parameters:

name - the data name

Returns:

the data value

setDataXMLValue

public short setDataXMLValue(java.lang.String name,
                             org.mdiutil.xml.tree.XMLNode value)

Set an XML Data value.

Parameters:

name - the data name

value - the data XML value

Returns:

the state of the data set (see DataState)

getValueAsJSON

public org.json.JSONElement getValueAsJSON(java.lang.String name)

Return a data value as a JSONObject.

Parameters:

name - the data name

Returns:

the data value

setDataXMLValue

public short setDataXMLValue(java.lang.String name,
                             org.json.JSONElement value)

Set a JSONObject Data value.

Parameters:

name - the data name

value - the data JSONElement value

Returns:

the state of the data set (see DataState)

setDataURLValue

public short setDataURLValue(java.lang.String name,
                             java.lang.String value)

Set an URL Data value.

Parameters:

name - the data name

value - the data URL value, as a String

Returns:

the state of the data set (see DataState)

setDataFileValue

public short setDataFileValue(java.lang.String name,
                              java.io.File value)

Set a File Data value.

Parameters:

name - the data name

value - the data File value, as a String

Returns:

the state of the data set (see DataState)

setDataURLValue

public short setDataURLValue(java.lang.String name,
                             java.net.URL value)

Set an URL Data value.

Parameters:

name - the data name

value - the data URL value

Returns:

the state of the data set (see DataState)

getValue

public java.lang.Object getValue(java.lang.String name)

Return a data value.

Parameters:

name - the data name

Returns:

the data value

getValueAsURL

public java.net.URL getValueAsURL(java.lang.String name)

Return a data value as an URL.

Parameters:

name - the data name

Returns:

the data value

getValueAsArray

public java.util.List<java.lang.Object> getValueAsArray(java.lang.String name)

Return a data value as an array.

Parameters:

name - the data name

Returns:

the data value

getValueAsStructure

public java.util.List<java.lang.Object> getValueAsStructure(java.lang.String name)

Return a data value as a Structure.

Parameters:

name - the data name

Returns:

the data value

setEntryPointMethod

protected void setEntryPointMethod(java.lang.reflect.Method method)

Set the entry-point method. The method will be set by default as a notified method.

Parameters:

method - the method

setAttachEntryPointMethod

protected void setAttachEntryPointMethod(java.lang.reflect.Method method)

Set the attach / detach entry-point method.

Parameters:

method - the attach / detach entry-point method

preSetup

public void preSetup()
              throws FrameworkException

pre-setup the Service instance.

Throws:

FrameworkException

setUp

public void setUp()

SetUp the Service instance. Do nothing by default.

attach

public boolean attach(ModuleIDKey key)

Attach a module to the modules providers.

Parameters:

key - the module Key

Returns:

true if the Module could be attached to the providers list

attach

public boolean attach(ModuleKey key)

Attach a module to the modules providers.

Parameters:

key - the module Key

Returns:

true if the Module could be attached to the providers list

detach

public boolean detach(ModuleIDKey key)

Detach a module from the modules providers.

Parameters:

key - the module Key

Returns:

true if the Module could be attached to the providers list

detach

public boolean detach(ModuleKey key)

Detach a module from the modules providers.

Parameters:

key - the module Key

Returns:

true if the Module could be attached to the providers list

attach

public boolean attach()

Attach to the modules providers.

Returns:

true if the Module could be attached to the providers list

detach

public boolean detach()

Detach from the modules providers.

Returns:

true if the Module could be detached from the providers list

error

public boolean error(char errorType)

Invoke the Service. This will do nothing if isActive() is false.

Parameters:

errorType - the error type

Returns:

true if the Service has been invoked

isEnabled

public boolean isEnabled()

Return if the underlying module is enabled. An enabled module can invoke services or be notified from services.

Returns:

true if the underlying module is a enabled

isInvoked

public boolean isInvoked()

Return true if the service has been invoked at least once. This will return true only for service providers after they have invoked this service for the first time.

Returns:

true if the service has been invoked

isNotified

public boolean isNotified()

Return true if the service has been notified at least once. This will return true only for service subscriber before they have been notified from this service for the first time.

Returns:

true if the service has been notified

fireEventLogger

protected int fireEventLogger()

Fire the event logger factory and return the current incocation count.

Returns:

the current incocation count

hasUpdateCap

protected boolean hasUpdateCap()

Return Module.hasAllUpdateCap() by default.

Returns:

true if the Service has an update cap property

invokeAndBlock

public boolean invokeAndBlock()

Invoke the Service. This will do nothing if isActive() is false.

Returns:

true if the Service has been invoked

invokeAndCopy

public boolean invokeAndCopy()

Invoke the Service. This will do nothing if isActive() is false.

Returns:

true if the Service has been invoked

invoke

public boolean invoke()

Invoke the Service. This will do nothing if isActive() is false.

Returns:

true if the Service has been invoked

invoke

protected boolean invoke(char invokeType)

Invoke the Service. This will do nothing if isActive() is false.

Parameters:

invokeType - the invocation type

Returns:

true if the Service has been invoked

isCopyingDatas

public final boolean isCopyingDatas()

Return true if the datas of the service must be copied before being sent.

Returns:

true if the datas of the service must be copied before being sent

beforeInvoke

protected void beforeInvoke()

Performed before the Service is invoked. Do nothing by default.

afterInvoke

protected void afterInvoke()

Performed after the Service has been invoked. Do nothing by default.

setInvoker

public void setInvoker(long appliD,
                       long moduleID)

Set the application ID and module ID which last invoked the Service.

Parameters:

appliD - the application ID

moduleID - the module ID

invokedByMe

public boolean invokedByMe()

Return true if the invocation of this service was performed by this module.

Returns:

true if the invocation of this service was performed by this module

getInvokerAppliID

public long getInvokerAppliID()

Return the long ID of the application which last invoked the Service.

Returns:

the ID

getInvokerModuleID

public long getInvokerModuleID()

Return the long ID of the module which last invoked the Service.

Returns:

the ID

getInvokerModule

public Module getInvokerModule()

Return the module which last invoked the Service.

Returns:

the Module

notifiedOnError

public void notifiedOnError(char errorType)
                     throws FrameworkException

Be notified of the execution of the Service. This will do nothing if isActive() is false.

Parameters:

errorType - the error type

Throws:

FrameworkException

notifiedInvoke

protected void notifiedInvoke(char type,
                              int count,
                              char invokeType)

Called for a MessageConstants.INVOKE notification.

Parameters:

invokeType - the invocation type

count - the invocation count

type - the notification type

notifiedException

protected void notifiedException(char type)

Called for a MessageConstants.EXCEPTION notification. By default defers to MessageConstants.INVOKE.

Parameters:

type - the notification type

notifiedAttachDetach

protected void notifiedAttachDetach(char type)

Called for a MessageConstants.ATTACH MessageConstants.DETACH or notification.

Parameters:

type - the notification type

notified

public void notified(char type,
                     int count,
                     char invokeType,
                     Datas datas)
              throws FrameworkException

Be notified of the execution of the Service. This will do nothing if isActive() is false.

Parameters:

type - the notification type

count - the invocation count

invokeType - the invocation type

datas - the datas

Throws:

FrameworkException

notified

public void notified(char type,
                     char invokeType,
                     Datas datas)
              throws FrameworkException

Be notified of the execution of the Service. This will do nothing if isActive() is false.

Parameters:

type - the notification type

invokeType - the invocation type

datas - the datas

Throws:

FrameworkException

notified

public void notified(char type)
              throws FrameworkException

Be notified of the execution of the Service. This will do nothing if isActive() is false.

Parameters:

type - the notification type

Throws:

FrameworkException

notified

public void notified(char type,
                     boolean forceBlock)
              throws FrameworkException

Be notified of the execution of the Service. This will do nothing if isActive() is false.

Parameters:

type - the notification type

forceBlock - true for a force blocking invocation

Throws:

FrameworkException

notified

public void notified(char type,
                     char invokeType)
              throws FrameworkException

Be notified of the execution of the Service. This will do nothing if isActive() is false.

Parameters:

type - the notification type

invokeType - the invocation type

Throws:

FrameworkException

notified

public void notified(char type,
                     int count,
                     boolean forceBlock)
              throws FrameworkException

Be notified of the execution of the Service. This will do nothing if isActive() is false.

Parameters:

type - the notification type

count - the invocation count

forceBlock - true for a force blocking invocation

Throws:

FrameworkException

notified

public void notified(char type,
                     int count,
                     char invokeType)
              throws FrameworkException

Be notified of the execution of the Service. This will do nothing if isActive() is false.

Parameters:

type - the notification type

count - the invocation count

invokeType - the invocation type

Throws:

FrameworkException