org.da.protoframework.model.core

Class RequestServiceInstance

java.lang.Object

org.da.protoframework.model.core.ServiceInstance<org.da.protoframework.model.core.RequestResponseService,org.da.protoframework.model.def.RequestInterfaceDefinition>

org.da.protoframework.model.core.RequestServiceInstance

All Implemented Interfaces:

java.lang.Cloneable

public class RequestServiceInstance
extends ServiceInstance<org.da.protoframework.model.core.RequestResponseService,org.da.protoframework.model.def.RequestInterfaceDefinition>

Represent a request Service instance on a Module.

Field Summary

Fields inherited from class org.da.protoframework.model.core.ServiceInstance

attachmethod, datas, externalTimeStamp, interDef, isActive, module, recmethod, sendmethod, service

Constructor Summary

Constructors

Constructor and Description
RequestServiceInstance(org.da.protoframework.model.core.RequestResponseService service, org.da.protoframework.model.def.RequestInterfaceDefinition def, Module module) Constructor.

Method Summary

Modifier and Type	Method and Description
protected void	beforeInvoke() Performed before the Service is invoked.
RequestServiceInstance	clone() Clone the service.
boolean	copyFromService(ServiceInstance<?,?> service, boolean strict) Copy the values of the output datas of a service to this service.
Data<?>	getData(java.lang.String name) Return the Data of a specified name.
java.util.Map<ModuleIDKey,ServiceInstance<?,?>>	getInstanceListeners() Return the Service instance subscribers.
java.util.Map<ModuleIDKey,ServiceInstance<?,?>>	getInstanceSubscribers() Return the Service instance subscribers.
long	getNextRequestID() Return the requestID for the next invokcation of the service.
long	getProcessingDuration() Return the time spent to processs the last request.
long	getProcessingDuration(long requestID) Return the time spent to processs a request.
long	getReceivedRequestID() Return the request ID received by the Service instance.
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, 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.
protected boolean	invoke(char invokeType) Invoke the Service.
boolean	invokeBlocking() Invoke the Service.
boolean	isProvidingData() Return true.
boolean	isSubscriber() Return true.
void	notifiedInvoke(char type, int count, char invokeType) Called for a MessageConstants.INVOKE notification.
void	preSetup() Setup the 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	setDataFloatValue(java.lang.String name, float value) 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, 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.
void	setReceivedRequestID(long requestID) Set the request ID received by the Service instance.
void	setUp() SetUp the Service instance.

Methods inherited from class org.da.protoframework.model.core.ServiceInstance

addProtocol, afterInvoke, attach, attach, attach, copyFromService, copyFromService, countDatas, createCopy, detach, detach, detach, error, fireEventLogger, getDataAsArray, getDataAsMap, getDataAsStructure, getDataAsSwitch, getDataAsUnion, getDatas, getDataType, getDataValue, getDataValues, getDefinition, getElapsedTime, getErrorType, getFullName, getID, getInvokerAppliID, getInvokerModule, getInvokerModuleID, getKey, getModule, getModuleIDKey, getModuleKey, getName, getNamespace, getNamespaceAsString, getProtocols, getSendMethod, getSendRequestID, getService, getState, getTimestamp, getTimestampMillis, getType, getType, getValue, getValueAsArray, getValueAsBoolean, getValueAsByte, getValueAsChar, getValueAsDouble, getValueAsDouble, getValueAsFloat, getValueAsFloat, getValueAsInt, getValueAsJSON, getValueAsLong, getValueAsShort, getValueAsString, getValueAsStructure, getValueAsURL, getValueAsXML, getVoidService, hasChanged, hasData, hasQualifiedName, hasQualifiedName, hasRequestID, hasUpdateCap, invoke, invokeAndBlock, invokeAndCopy, invokedByMe, isActive, isCopyingDatas, isEnabled, isInvoked, isNominal, isNotified, isSubscribedTo, isUsingExecutorMode, notified, notified, notified, notified, notified, notified, notified, notifiedAttachDetach, notifiedException, notifiedOnError, setActive, setAttachEntryPointMethod, setDataDoubleValue, setDataFileValue, setDataFloatValue, setDataXMLValue, setEntryPointMethod, setInvoker, setState, setTime, setTime, setTimeInternal, shutdown, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

RequestServiceInstance

public RequestServiceInstance(org.da.protoframework.model.core.RequestResponseService service,
                              org.da.protoframework.model.def.RequestInterfaceDefinition def,
                              Module module)

Constructor.

Parameters:

service - the Service

def - the Interface Definition

module - the Module

Method Detail

clone

public RequestServiceInstance clone()

Clone the service.

Overrides:

clone in class ServiceInstance<org.da.protoframework.model.core.RequestResponseService,org.da.protoframework.model.def.RequestInterfaceDefinition>

Returns:

this service

getInstanceSubscribers

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

Return the Service instance subscribers.

Overrides:

getInstanceSubscribers in class ServiceInstance<org.da.protoframework.model.core.RequestResponseService,org.da.protoframework.model.def.RequestInterfaceDefinition>

Returns:

the subscribers

getInstanceListeners

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

Return the Service instance subscribers.

Overrides:

getInstanceListeners in class ServiceInstance<org.da.protoframework.model.core.RequestResponseService,org.da.protoframework.model.def.RequestInterfaceDefinition>

Returns:

the subscribers

getNextRequestID

public long getNextRequestID()

Return the requestID for the next invokcation of the service.

Returns:

the requestID

invokeBlocking

public boolean invokeBlocking()

Invoke the Service. The invocation must block the current thread until the response is received. This will do nothing if ServiceInstance.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 ServiceInstance.isActive() is false.

Overrides:

invoke in class ServiceInstance<org.da.protoframework.model.core.RequestResponseService,org.da.protoframework.model.def.RequestInterfaceDefinition>

Parameters:

invokeType - the invocation type

Returns:

true if the Service has been invoked

notifiedInvoke

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

Called for a MessageConstants.INVOKE notification.

Overrides:

notifiedInvoke in class ServiceInstance<org.da.protoframework.model.core.RequestResponseService,org.da.protoframework.model.def.RequestInterfaceDefinition>

Parameters:

invokeType - the invocation type

count - the invocation count

type - the notification type

getProcessingDuration

public long getProcessingDuration(long requestID)

Return the time spent to processs a request.

Parameters:

requestID - the request ID

Returns:

the time in ms

getProcessingDuration

public long getProcessingDuration()

Return the time spent to processs the last request.

Returns:

the time in ms

setReceivedRequestID

public void setReceivedRequestID(long requestID)

Set the request ID received by the Service instance.

Overrides:

setReceivedRequestID in class ServiceInstance<org.da.protoframework.model.core.RequestResponseService,org.da.protoframework.model.def.RequestInterfaceDefinition>

Parameters:

requestID - the request ID

getReceivedRequestID

public long getReceivedRequestID()

Return the request ID received by the Service instance.

Returns:

the request ID

isSubscriber

public boolean isSubscriber()

Return true.

Specified by:

isSubscriber in class ServiceInstance<org.da.protoframework.model.core.RequestResponseService,org.da.protoframework.model.def.RequestInterfaceDefinition>

Returns:

true

isProvidingData

public boolean isProvidingData()

Return true.

Specified by:

isProvidingData in class ServiceInstance<org.da.protoframework.model.core.RequestResponseService,org.da.protoframework.model.def.RequestInterfaceDefinition>

Returns:

true

hasDatas

public boolean hasDatas(boolean isInput)

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

Overrides:

hasDatas in class ServiceInstance<org.da.protoframework.model.core.RequestResponseService,org.da.protoframework.model.def.RequestInterfaceDefinition>

Parameters:

isInput - true for receiving services

Returns:

true if the Service instance has some datas

hasData

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

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

Overrides:

hasData in class ServiceInstance<org.da.protoframework.model.core.RequestResponseService,org.da.protoframework.model.def.RequestInterfaceDefinition>

Parameters:

name - the name

isInput - true for input datas

Returns:

true if there is a Data for the specified name

preSetup

public void preSetup()
              throws FrameworkException

Setup the Service instance.

Overrides:

preSetup in class ServiceInstance<org.da.protoframework.model.core.RequestResponseService,org.da.protoframework.model.def.RequestInterfaceDefinition>

Throws:

FrameworkException

setUp

public void setUp()

SetUp the Service instance.

Overrides:

setUp in class ServiceInstance<org.da.protoframework.model.core.RequestResponseService,org.da.protoframework.model.def.RequestInterfaceDefinition>

beforeInvoke

protected void beforeInvoke()

Performed before the Service is invoked.

Overrides:

beforeInvoke in class ServiceInstance<org.da.protoframework.model.core.RequestResponseService,org.da.protoframework.model.def.RequestInterfaceDefinition>

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)

Overrides:

copyFromService in class ServiceInstance<org.da.protoframework.model.core.RequestResponseService,org.da.protoframework.model.def.RequestInterfaceDefinition>

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

getData

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

Return the Data of a specified name.

Overrides:

getData in class ServiceInstance<org.da.protoframework.model.core.RequestResponseService,org.da.protoframework.model.def.RequestInterfaceDefinition>

Parameters:

name - the name

Returns:

the Data

hasChanged

public boolean hasChanged(java.lang.String name)

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

Overrides:

hasChanged in class ServiceInstance<org.da.protoframework.model.core.RequestResponseService,org.da.protoframework.model.def.RequestInterfaceDefinition>

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.

Overrides:

setDataValue in class ServiceInstance<org.da.protoframework.model.core.RequestResponseService,org.da.protoframework.model.def.RequestInterfaceDefinition>

Parameters:

name - the data name

value - the data value

Returns:

the state of the data set (see DataState)

setDataIntValue

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

Set an int Data value.

Overrides:

setDataIntValue in class ServiceInstance<org.da.protoframework.model.core.RequestResponseService,org.da.protoframework.model.def.RequestInterfaceDefinition>

Parameters:

name - the data name

value - the data int value

Returns:

the state of the data set (see DataState)

setDataByteValue

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

Set a byte Data value.

Overrides:

setDataByteValue in class ServiceInstance<org.da.protoframework.model.core.RequestResponseService,org.da.protoframework.model.def.RequestInterfaceDefinition>

Parameters:

name - the data name

value - the data byte value

Returns:

the state of the data set (see DataState)

setDataLongValue

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

Set a long Data value.

Overrides:

setDataLongValue in class ServiceInstance<org.da.protoframework.model.core.RequestResponseService,org.da.protoframework.model.def.RequestInterfaceDefinition>

Parameters:

name - the data name

value - the data long value

Returns:

the state of the data set (see DataState)

setDataCharValue

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

Set a char Data value.

Overrides:

setDataCharValue in class ServiceInstance<org.da.protoframework.model.core.RequestResponseService,org.da.protoframework.model.def.RequestInterfaceDefinition>

Parameters:

name - the data name

value - the data char value

Returns:

the state of the data set (see DataState)

setDataShortValue

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

Set a short Data value.

Overrides:

setDataShortValue in class ServiceInstance<org.da.protoframework.model.core.RequestResponseService,org.da.protoframework.model.def.RequestInterfaceDefinition>

Parameters:

name - the data name

value - the data short value

Returns:

the state of the data set (see DataState)

setDataFloatValue

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

Set a float Data value.

Overrides:

setDataFloatValue in class ServiceInstance<org.da.protoframework.model.core.RequestResponseService,org.da.protoframework.model.def.RequestInterfaceDefinition>

Parameters:

name - the data name

value - the data float value

Returns:

the state of the data set (see DataState)

setDataDoubleValue

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

Set a double Data value.

Overrides:

setDataDoubleValue in class ServiceInstance<org.da.protoframework.model.core.RequestResponseService,org.da.protoframework.model.def.RequestInterfaceDefinition>

Parameters:

name - the data name

value - the data double value

Returns:

the state of the data set (see DataState)

setDataBooleanValue

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

Set a boolean Data value.

Overrides:

setDataBooleanValue in class ServiceInstance<org.da.protoframework.model.core.RequestResponseService,org.da.protoframework.model.def.RequestInterfaceDefinition>

Parameters:

name - the data name

value - the data boolean value

Returns:

the state of the data set (see DataState)

setDataStringValue

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

Set a String Data value.

Overrides:

setDataStringValue in class ServiceInstance<org.da.protoframework.model.core.RequestResponseService,org.da.protoframework.model.def.RequestInterfaceDefinition>

Parameters:

name - the data name

value - the data String 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.

Overrides:

setDataURLValue in class ServiceInstance<org.da.protoframework.model.core.RequestResponseService,org.da.protoframework.model.def.RequestInterfaceDefinition>

Parameters:

name - the data name

value - the data URL 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.

Overrides:

setDataURLValue in class ServiceInstance<org.da.protoframework.model.core.RequestResponseService,org.da.protoframework.model.def.RequestInterfaceDefinition>

Parameters:

name - the data name

value - the data URL value

Returns:

the state of the data set (see DataState)

setDataXMLValue

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

Set an XML Data value.

Overrides:

setDataXMLValue in class ServiceInstance<org.da.protoframework.model.core.RequestResponseService,org.da.protoframework.model.def.RequestInterfaceDefinition>

Parameters:

name - the data name

value - the data XML value

Returns:

the state of the data set (see DataState)

setDataXMLValue

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

Set an XML Data value.

Overrides:

setDataXMLValue in class ServiceInstance<org.da.protoframework.model.core.RequestResponseService,org.da.protoframework.model.def.RequestInterfaceDefinition>

Parameters:

name - the data name

value - the data XML value

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.

Overrides:

setDataJSONValue in class ServiceInstance<org.da.protoframework.model.core.RequestResponseService,org.da.protoframework.model.def.RequestInterfaceDefinition>

Parameters:

name - the data name

value - the data JSON value

Returns:

the state of the data set (see DataState)