org.da.protoframework.model.core

Class Module

java.lang.Object

org.da.protoframework.model.core.Module

All Implemented Interfaces:

org.da.protoframework.com.netty.ProtocolListener

public abstract class Module
extends java.lang.Object
implements org.da.protoframework.com.netty.ProtocolListener

Represent a Module.

Field Summary

Fields

Modifier and Type	Field and Description
protected Application	appli The Application definition.
protected java.lang.reflect.Method	attachMethod The Module attach method.
protected ModuleDefinition	def The Module definition.
protected java.lang.reflect.Method	endMethod The Module end method.
protected java.lang.reflect.Method	finishInvokeMethod The Module finishInvoke method.
protected java.lang.reflect.Method	initMethod The Module init method.
protected java.lang.reflect.Method	preConfigureMethod The Module preConfigure method.
protected java.util.Map<NamespaceKey,ServiceInstance<?,?>>	providerServices The Maps of provider Services.
protected java.lang.reflect.Method	receiveMethod The Module receive method.
protected java.lang.reflect.Method	sendMethod The Module send method.
protected int	startDelay The Module start delay in ms.
protected java.lang.reflect.Method	startMethod The Module start method.
protected java.util.Map<NamespaceKey,ServiceInstance<?,?>>	subscriberServices The Maps of subscriber Services.
protected java.lang.reflect.Method	triggerMethod The Module trigger method.

Constructor Summary

Constructors

Constructor and Description
Module(Application appli, java.lang.String name) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	addPropertyType(java.lang.String key, java.lang.Class<?> type, java.lang.String defaultValue, boolean isMandatory) Add a new property type.
boolean	addPropertyType(java.lang.String key, java.lang.Class<?> type, java.lang.String defaultValue, boolean isMandatory, boolean inArray) Add a new property type.
boolean	addPropertyType(java.lang.String key, java.lang.Class<?> type, java.lang.String defaultValue, short unit, boolean isMandatory) Add a new property type.
boolean	addPropertyType(java.lang.String key, java.lang.Class<?> type, java.lang.String defaultValue, short unit, boolean isMandatory, boolean inArray) Add a new property type.
void	complete(org.da.protoframework.com.netty.Protocol protocol, boolean doStart) Called when the Protocol setUp has completed.
abstract void	create() Create the Module instance.
Application	getApplication() Return the parent Application.
long	getApplicationID() Return the application ID.
protected java.lang.reflect.Method	getAttachMethod(java.lang.String methodName) Return the Method with a specified name and the ServiceInstance and a message type character as argument.
java.lang.ClassLoader	getClassLoader() Return the ClassLoader used for the Module.
ModuleDefinition	getDefinition() Return the Module definition.
long	getElapsedTime(long currentTime) Return the elapsed time since the start of the framework.
java.util.concurrent.ExecutorService	getExecutorService() Return the ExecutorService.
long	getID() Return the module ID.
protected java.lang.reflect.Method	getInitPreConfMethod(java.lang.String methodName) Return the Method with a specified name and the Module as argument.
protected java.lang.reflect.Method	getMethod(java.lang.String methodName) Return the Method with a specified name and the ServiceInstance as argument.
protected java.lang.reflect.Method	getMethodImpl(java.lang.String entryPoint, java.lang.Class<?>[] args) Return a method with a specified name and arguments.
protected abstract java.lang.Class<?>	getModuleClass() Return the Module class.
ModuleIDKey	getModuleIDKey() Return this Module ID key.
abstract java.lang.Object	getModuleInstance() Return the Module instance.
ModuleKey	getModuleKey() Return this Module key.
java.lang.String	getName() Return the module name.
org.da.protoframework.model.def.NamedProperty	getNamedProperty(java.lang.String key) Return a named property.
java.lang.String	getNotNullPropertyStringValue(java.lang.String key) Return the value of a property as a String.
org.da.protoframework.model.def.PropertyArray	getPropertyArray(java.lang.String key) Return a property array.
java.util.List<java.lang.Object>	getPropertyArrayValue(java.lang.String key) Return the value of a property as an array.
java.util.List<java.lang.Boolean>	getPropertyBooleanArrayValue(java.lang.String key) Return the value of a property as a boolean array.
boolean	getPropertyBooleanValue(java.lang.String key) Return the value of a property as a boolean.
java.util.List<java.time.Duration>	getPropertyDurationArrayValue(java.lang.String key) Return the value of a property as a Duration array.
java.time.Duration	getPropertyDurationValue(java.lang.String key) Return the value of a property as a Duration.
java.util.List<java.io.File>	getPropertyFileArrayValue(java.lang.String key) Return the value of a property as a File array.
java.io.File	getPropertyFileValue(java.lang.String key) Return the value of a property as a File.
java.util.List<java.lang.Float>	getPropertyFloatArrayValue(java.lang.String key) Return the value of a property as a float array.
float	getPropertyFloatValue(java.lang.String key) Return the value of a property as a float.
float	getPropertyFloatValue(java.lang.String key, short unit) Return the value of a property as a float.
java.util.List<java.lang.Integer>	getPropertyIntArrayValue(java.lang.String key) Return the value of a property as an int array.
int	getPropertyIntValue(java.lang.String key) Return the value of a property as an int.
int	getPropertyIntValue(java.lang.String key, short unit) Return the value of a property as an int.
java.util.Map<java.lang.String,java.lang.String>	getPropertyMapValue(java.lang.String key) Return the value of a property as a Map.
ScreenPosition	getPropertyPositionValue(java.lang.String key) Return the value of a property as a ScreenPosition.
java.util.List<java.lang.String>	getPropertyStringArrayValue(java.lang.String key) Return the value of a property as a String array.
java.lang.String	getPropertyStringValue(java.lang.String key) Return the value of a property as a String.
java.net.URI	getPropertyURIValue(java.lang.String key) Return the value of a property as an URI.
java.net.URI	getPropertyURIValue(java.lang.String key, boolean exists) Return the value of a property as an URI.
java.util.List<java.net.URL>	getPropertyURLArrayValue(java.lang.String key) Return the value of a property as an URL array.
java.util.List<java.net.URL>	getPropertyURLArrayValue(java.lang.String key, boolean exists) Return the value of a property as an URL array.
java.net.URL	getPropertyURLValue(java.lang.String key) Return the value of a property as an URL.
java.net.URL	getPropertyURLValue(java.lang.String key, boolean exists) Return the value of a property as an URL.
java.lang.Object	getPropertyValue(java.lang.String key) Return the value of a property.
ServiceInstance<?,?>	getProviderService(long id) Return the Service provider instance with a specified ID.
ServiceInstance<?,?>	getProviderService(NamespaceKey key) Return the Service provider instance with a specified key.
ServiceInstance<?,?>	getProviderService(java.lang.String name) Return the Service provider instance with a specified name.
ServiceInstance<?,?>	getProviderService(java.lang.String uri, java.lang.String name) Return true if there is a Service provider instance with a specified key.
java.util.Map<NamespaceKey,ServiceInstance<?,?>>	getProviderServices() Return the provider Services instances.
protected java.lang.reflect.Method	getReceiveMethod(ServiceInstance<?,?> service) Return the Method used for the notification of a Service.
ServiceInstance<?,?>	getService(long id) Return the Service instance with a specified ID.
ServiceInstance<?,?>	getService(NamespaceKey key) Return the Service instance with a specified key.
ServiceInstance<?,?>	getService(NamespaceKey key, boolean isSilent) Return the Service instance with a specified key.
ServiceInstance<?,?>	getService(java.lang.String name) Return the Service instance with a specified name.
ServiceInstance<?,?>	getService(java.lang.String name, boolean isSilent) Return the Service instance with a specified name.
ServiceInstance<?,?>	getService(java.lang.String uri, java.lang.String name) Return the Service instance with a specified key.
ServiceInstance<?,?>	getService(java.lang.String uri, java.lang.String name, boolean isSilent) Return the Service instance with a specified key.
ServiceDefinition	getServiceDefinition(NamespaceKey key) Return the Service definition with a specified key.
ServiceDefinition	getServiceDefinition(java.lang.String name) Return the Service definition with a specified name.
ServiceDefinition	getServiceDefinition(java.lang.String name, boolean isSilent) Return the Service definition with a specified name.
ServiceDefinition	getServiceDefinition(java.lang.String uri, java.lang.String name) Return the Service definition with a specified key.
java.util.Map<NamespaceKey,ServiceInstance<?,?>>	getServices() Return the Services instances.
protected java.lang.reflect.Method	getStartEndMethod(java.lang.String methodName) Return the Method with a specified name and no argument.
long	getStartTimeStamp() Return the time stamp at the start of the framework.
ServiceInstance<?,?>	getSubscriberService(long id) Return the Service subscriber instance with a specified ID.
ServiceInstance<?,?>	getSubscriberService(NamespaceKey key) Return the Service subscriber instance with a specified key.
ServiceInstance<?,?>	getSubscriberService(java.lang.String name) Return the Service subscriber instance with a specified name.
ServiceInstance<?,?>	getSubscriberService(java.lang.String uri, java.lang.String name) Return true if there is a Service subscriber instance with a specified key.
java.util.Map<NamespaceKey,ServiceInstance<?,?>>	getSubscriberServices() Return the subscriber Services instances.
java.util.Timer	getTimer() Return the general modules Timer.
protected java.lang.reflect.Method	getTwoArgsMethod(java.lang.String methodName) Return the Method with a specified name and two ServiceInstance as argument.
Type	getType(NamespaceKey key) Return the type of a specified key.
Type	getType(java.lang.String name) Return the type of a specified name.
Type	getType(java.lang.String uri, java.lang.String name) Return the type of a specified key.
int	getUpdateCap() Return the update cap value in ms.
boolean	hasAllUpdateCap() Return true if the Module has an update cap for all output services.
protected boolean	hasCyclicTasks() Return true if there are cyclic tasks.
boolean	hasDefinedProperty(java.lang.String key) Return true if there is a property for a specified key.
boolean	hasProviderService(long id) Return true if there is a Service provider instance with a specified ID.
boolean	hasProviderService(NamespaceKey key) Return true if there is a Service provider instance with a specified key.
boolean	hasProviderService(java.lang.String name) Return true if there is a Service provider instance with a specified name.
boolean	hasPublishUpdateCap() Return true if the Module has an update cap for publish output services.
boolean	hasService(long id) Return true if there is a Service instance with a specified ID.
boolean	hasService(NamespaceKey key) Return true if there is a Service instance with a specified key.
boolean	hasService(java.lang.String name) Return true if there is a Service instance with a specified name.
boolean	hasService(java.lang.String uri, java.lang.String name) Return true if there is a Service instance with a specified key.
boolean	hasSubscriberForService(NamespaceKey key) Return true if there is at least one subscriber for a service.
boolean	hasSubscriberService(long id) Return true if there is a Service subscriber instance with a specified ID.
boolean	hasSubscriberService(NamespaceKey key) Return true if there is a Service subscriber instance with a specified key.
boolean	hasSubscriberService(java.lang.String name) Return true if there is a Service subscriber instance with a specified name.
boolean	hasSubscriberService(java.lang.String uri, java.lang.String name) Return true if there is a Service subscriber instance with a specified key.
void	init() Initialize the Module.
boolean	isEnabled() Return if the module is enabled.
boolean	isInstance() Return true if the module is an instance of a template module.
boolean	isMaster() Return true if the module is a master module.
boolean	isPreStarted() Return true if the Module is pre-started.
boolean	isReified() Return true if the Module is instanciated (reified).
boolean	isStarted() Return true if the Module is started.
void	lockInvoke() Lock the invocation of the Services on the Module.
void	preConfigure() Pre-configure the Module.
static void	purge() Purge the currently active list of tasks in the cyclic timers.
protected void	receiveImpl(ServiceInstance<?,?> service) Invoke the Method used for the notification of a Service.
void	schedule(java.util.TimerTask task, long delay) Schedules the specified task for execution after the specified delay.
void	schedule(java.util.TimerTask task, long delay, long period) Schedules the specified task for repeated fixed-delay execution, beginning after the specified delay.
boolean	setEnabled(ModuleIDKey key, boolean enable) Enable or disable a module.
boolean	setEnabled(ModuleKey key, boolean enable) Enable or disable a module.
void	setExecutorService(java.util.concurrent.ExecutorService exeService) Set the ExecutorService.
void	setUp() Setup the Module.
protected void	setupServices() Setup the Module Services.
void	shutdown() Shutdown the module.
void	start() Start the Module.
protected void	startCustomTasks() Start custom code tasks when starting the Module.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

def

protected final ModuleDefinition def

The Module definition.

appli

protected final Application appli

The Application definition.

preConfigureMethod

protected java.lang.reflect.Method preConfigureMethod

The Module preConfigure method.

initMethod

protected java.lang.reflect.Method initMethod

The Module init method.

startMethod

protected java.lang.reflect.Method startMethod

The Module start method.

startDelay

protected int startDelay

The Module start delay in ms.

finishInvokeMethod

protected java.lang.reflect.Method finishInvokeMethod

The Module finishInvoke method.

receiveMethod

protected java.lang.reflect.Method receiveMethod

The Module receive method.

attachMethod

protected java.lang.reflect.Method attachMethod

The Module attach method.

sendMethod

protected java.lang.reflect.Method sendMethod

The Module send method.

triggerMethod

protected java.lang.reflect.Method triggerMethod

The Module trigger method.

endMethod

protected java.lang.reflect.Method endMethod

The Module end method.

providerServices

protected final java.util.Map<NamespaceKey,ServiceInstance<?,?>> providerServices

The Maps of provider Services.

subscriberServices

protected final java.util.Map<NamespaceKey,ServiceInstance<?,?>> subscriberServices

The Maps of subscriber Services.

Constructor Detail

Module

public Module(Application appli,
              java.lang.String name)

Constructor.

Parameters:

appli - the parent Application

name - the Module name

Method Detail

isMaster

public boolean isMaster()

Return true if the module is a master module.

Returns:

true if the module is a master module

setEnabled

public boolean setEnabled(ModuleKey key,
                          boolean enable)

Enable or disable a module. It is only possible to enable or disable a module if:

• The module which tries to enable or disable it is a master module
• The module which you try to enable or disable is not a master module

Parameters:

key - the key of the module to enable or disable

enable - true to enable to module, false to disable it

Returns:

true if the operation was successful

setEnabled

public boolean setEnabled(ModuleIDKey key,
                          boolean enable)

Enable or disable a module. It is only possible to enable or disable a module if:

• The module which tries to enable or disable it is a master module
• The module which you try to enable or disable is not a master module

Parameters:

key - the key of the module to enable or disable

enable - true to enable to module, false to disable it

Returns:

true if the operation was successful

isEnabled

public boolean isEnabled()

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

Returns:

true if the module is a enabled

isInstance

public boolean isInstance()

Return true if the module is an instance of a template module.

Returns:

true if the module is an instance of a template module

purge

public static void purge()

Purge the currently active list of tasks in the cyclic timers.

addPropertyType

public boolean addPropertyType(java.lang.String key,
                               java.lang.Class<?> type,
                               java.lang.String defaultValue,
                               boolean isMandatory)

Add a new property type.

Parameters:

key - the property key

type - the property type

defaultValue - the property default value

isMandatory - true if the property is mandatory

Returns:

true if the property type could be set

addPropertyType

public boolean addPropertyType(java.lang.String key,
                               java.lang.Class<?> type,
                               java.lang.String defaultValue,
                               boolean isMandatory,
                               boolean inArray)

Add a new property type.

Parameters:

key - the property key

type - the property type

defaultValue - the property default value

isMandatory - true if the property is mandatory

inArray - true if the property is in in array

Returns:

true if the property type could be set

addPropertyType

public boolean addPropertyType(java.lang.String key,
                               java.lang.Class<?> type,
                               java.lang.String defaultValue,
                               short unit,
                               boolean isMandatory)

Add a new property type.

Parameters:

key - the property key

type - the property type

defaultValue - the property default value

unit - the property unit

isMandatory - true if the property is mandatory

Returns:

true if the property type could be set

addPropertyType

public boolean addPropertyType(java.lang.String key,
                               java.lang.Class<?> type,
                               java.lang.String defaultValue,
                               short unit,
                               boolean isMandatory,
                               boolean inArray)

Add a new property type.

Parameters:

key - the property key

type - the property type

defaultValue - the property default value

unit - the property unit

isMandatory - true if the property is mandatory

inArray - true if the property is in in array

Returns:

true if the property type could be set

getModuleKey

public ModuleKey getModuleKey()

Return this Module key.

Returns:

this Module key

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getTimer

public java.util.Timer getTimer()

Return the general modules Timer. Note that there is only one timer for all the modules.

Returns:

the general modules Timer

schedule

public void schedule(java.util.TimerTask task,
                     long delay)

Schedules the specified task for execution after the specified delay. Get the underlying timer to schedule this task.

Parameters:

task - task to be scheduled.

delay - delay in milliseconds before task is to be executed.

schedule

public void schedule(java.util.TimerTask task,
                     long delay,
                     long period)

Schedules the specified task for repeated fixed-delay execution, beginning after the specified delay. Get the underlying timer to schedule this task.

Parameters:

task - task to be scheduled.

delay - delay in milliseconds before task is to be executed.

period - time in milliseconds between successive task executions.

setExecutorService

public void setExecutorService(java.util.concurrent.ExecutorService exeService)

Set the ExecutorService.

Parameters:

exeService - the ExecutorService

getExecutorService

public java.util.concurrent.ExecutorService getExecutorService()

Return the ExecutorService.

Returns:

the ExecutorService

isReified

public boolean isReified()

Return true if the Module is instanciated (reified). Defer to Application.isReified().

Returns:

true if the Module is instanciated

getName

public java.lang.String getName()

Return the module name.

Returns:

the module name

getID

public long getID()

Return the module ID.

Returns:

the module ID

getApplicationID

public long getApplicationID()

Return the application ID.

Returns:

the application ID

getApplication

public Application getApplication()

Return the parent Application.

Returns:

the parent Application

getProviderServices

public java.util.Map<NamespaceKey,ServiceInstance<?,?>> getProviderServices()

Return the provider Services instances.

Returns:

the provider Services instances

getSubscriberServices

public java.util.Map<NamespaceKey,ServiceInstance<?,?>> getSubscriberServices()

Return the subscriber Services instances.

Returns:

the subscriber Services instances

getServices

public java.util.Map<NamespaceKey,ServiceInstance<?,?>> getServices()

Return the Services instances.

Returns:

the Services instances

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

getType

public Type getType(java.lang.String uri,
                    java.lang.String name)

Return the type of a specified key.

Parameters:

uri - the service namespace uri as a String key

name - the service name

Returns:

the type

hasProviderService

public boolean hasProviderService(java.lang.String name)

Return true if there is a Service provider instance with a specified name.

Parameters:

name - the Service name

Returns:

true if there is a Service provider instance with the specified name

hasProviderService

public boolean hasProviderService(NamespaceKey key)

Return true if there is a Service provider instance with a specified key.

Parameters:

key - the Service key

Returns:

true if there is a Service provider instance with the specified key

getProviderService

public ServiceInstance<?,?> getProviderService(java.lang.String name)

Return the Service provider instance with a specified name.

Parameters:

name - the Service name

Returns:

the Service provider instance with the specified name

getProviderService

public ServiceInstance<?,?> getProviderService(NamespaceKey key)

Return the Service provider instance with a specified key.

Parameters:

key - the Service key

Returns:

the Service provider instance with the specified key

getProviderService

public ServiceInstance<?,?> getProviderService(java.lang.String uri,
                                               java.lang.String name)

Return true if there is a Service provider instance with a specified key.

Parameters:

uri - the service namespace uri as a String key

name - the service name

Returns:

the Service provider instance with the specified key

hasProviderService

public boolean hasProviderService(long id)

Return true if there is a Service provider instance with a specified ID.

Parameters:

id - the Service ID

Returns:

true if there is a Service provider instance with the specified ID

getProviderService

public ServiceInstance<?,?> getProviderService(long id)

Return the Service provider instance with a specified ID.

Parameters:

id - the Service ID

Returns:

the Service provider instance with the specified ID

hasSubscriberService

public boolean hasSubscriberService(java.lang.String name)

Return true if there is a Service subscriber instance with a specified name.

Parameters:

name - the Service name

Returns:

true if there is a Service subscriber instance with the specified name

hasSubscriberService

public boolean hasSubscriberService(NamespaceKey key)

Return true if there is a Service subscriber instance with a specified key.

Parameters:

key - the Service key

Returns:

true if there is a Service subscriber instance with the specified key

hasSubscriberService

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

Return true if there is a Service subscriber instance with a specified key.

Parameters:

uri - the service namespace uri as a String key

name - the service name

Returns:

true if there is a Service instance with the specified key

hasService

public boolean hasService(java.lang.String name)

Return true if there is a Service instance with a specified name.

Parameters:

name - the Service name

Returns:

true if there is a Service instance with the specified name

hasSubscriberForService

public boolean hasSubscriberForService(NamespaceKey key)

Return true if there is at least one subscriber for a service.

Parameters:

key - the service key

Returns:

true if there is at least one subscriber for the service

hasService

public boolean hasService(NamespaceKey key)

Return true if there is a Service instance with a specified key.

Parameters:

key - the Service key

Returns:

true if there is a Service instance with the specified key

hasService

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

Return true if there is a Service instance with a specified key.

Parameters:

uri - the service namespace uri as a String key

name - the service name

Returns:

true if there is a Service instance with the specified key

getSubscriberService

public ServiceInstance<?,?> getSubscriberService(java.lang.String name)

Return the Service subscriber instance with a specified name.

Parameters:

name - the Service name

Returns:

the Service subscriber instance with the specified name

getSubscriberService

public ServiceInstance<?,?> getSubscriberService(NamespaceKey key)

Return the Service subscriber instance with a specified key.

Parameters:

key - the Service key

Returns:

the Service subscriber instance with the specified key

getSubscriberService

public ServiceInstance<?,?> getSubscriberService(java.lang.String uri,
                                                 java.lang.String name)

Return true if there is a Service subscriber instance with a specified key.

Parameters:

uri - the service namespace uri as a String key

name - the service name

Returns:

the Service subscriber instance with the specified key

getService

public ServiceInstance<?,?> getService(NamespaceKey key)

Return the Service instance with a specified key.

Parameters:

key - the Service key

Returns:

the Service instance with the specified key

getServiceDefinition

public ServiceDefinition getServiceDefinition(NamespaceKey key)

Return the Service definition with a specified key.

Parameters:

key - the service key

Returns:

the Service definition with the specified key

getServiceDefinition

public ServiceDefinition getServiceDefinition(java.lang.String uri,
                                              java.lang.String name)

Return the Service definition with a specified key.

Parameters:

uri - the service namespace uri as a String key

name - the service name

Returns:

the Service definition with the specified key

getServiceDefinition

public ServiceDefinition getServiceDefinition(java.lang.String name)

Return the Service definition with a specified name.

Parameters:

name - the service name

Returns:

the Service definition with the specified name

getServiceDefinition

public ServiceDefinition getServiceDefinition(java.lang.String name,
                                              boolean isSilent)

Return the Service definition with a specified name.

Parameters:

name - the service name

isSilent - true if no message should be logged if the service is not found

Returns:

the Service definition with the specified name

getService

public ServiceInstance<?,?> getService(java.lang.String uri,
                                       java.lang.String name,
                                       boolean isSilent)

Return the Service instance with a specified key.

Parameters:

uri - the service namespace uri as a String key

name - the service name

isSilent - true if no message should be logged if the service is not found

Returns:

the Service instance with the specified key

getService

public ServiceInstance<?,?> getService(NamespaceKey key,
                                       boolean isSilent)

Return the Service instance with a specified key.

Parameters:

key - the service namespace ey

isSilent - true if no message should be logged if the service is not found

Returns:

the Service instance with the specified key

getService

public ServiceInstance<?,?> getService(java.lang.String uri,
                                       java.lang.String name)

Return the Service instance with a specified key.

Parameters:

uri - the service namespace uri as a String key

name - the service name

Returns:

the Service instance with the specified key

getService

public ServiceInstance<?,?> getService(java.lang.String name,
                                       boolean isSilent)

Return the Service instance with a specified name.

Parameters:

name - the Service name

isSilent - true if no message should be logged if the service is not found

Returns:

the Service instance with the specified name

getService

public ServiceInstance<?,?> getService(java.lang.String name)

Return the Service instance with a specified name.

Parameters:

name - the Service name

Returns:

the Service instance with the specified name

hasSubscriberService

public boolean hasSubscriberService(long id)

Return true if there is a Service subscriber instance with a specified ID.

Parameters:

id - the Service ID

Returns:

true if there is a Service subscriber instance with the specified ID

hasService

public boolean hasService(long id)

Return true if there is a Service instance with a specified ID.

Parameters:

id - the Service ID

Returns:

true if there is a Service instance with the specified ID

getSubscriberService

public ServiceInstance<?,?> getSubscriberService(long id)

Return the Service subscriber instance with a specified ID.

Parameters:

id - the Service ID

Returns:

the Service subscriber instance with the specified ID

getService

public ServiceInstance<?,?> getService(long id)

Return the Service instance with a specified ID.

Parameters:

id - the Service ID

Returns:

the Service instance with the specified ID

getDefinition

public ModuleDefinition getDefinition()

Return the Module definition.

Returns:

the Module definition

getStartTimeStamp

public long getStartTimeStamp()

Return the time stamp at the start of the framework.

Returns:

the time stamp at the start of the framework

getElapsedTime

public long getElapsedTime(long currentTime)

Return the elapsed time since the start of the framework.

Parameters:

currentTime - the current time

Returns:

the elapsed time since the start of the framework

getPropertyValue

public java.lang.Object getPropertyValue(java.lang.String key)

Return the value of a property.

Parameters:

key - the property key

Returns:

the property value

getNamedProperty

public org.da.protoframework.model.def.NamedProperty getNamedProperty(java.lang.String key)

Return a named property.

Parameters:

key - the property key

Returns:

the property

getPropertyArray

public org.da.protoframework.model.def.PropertyArray getPropertyArray(java.lang.String key)

Return a property array.

Parameters:

key - the property key

Returns:

the property array

hasPublishUpdateCap

public boolean hasPublishUpdateCap()

Return true if the Module has an update cap for publish output services.

Returns:

true if the Module has an update cap for publish output services

hasAllUpdateCap

public boolean hasAllUpdateCap()

Return true if the Module has an update cap for all output services.

Returns:

true if the Module has an update cap for all output services

getUpdateCap

public int getUpdateCap()

Return the update cap value in ms.

Returns:

the update cap value in ms

hasDefinedProperty

public boolean hasDefinedProperty(java.lang.String key)

Return true if there is a property for a specified key.

Parameters:

key - the the property key

Returns:

true if there is a property for the specified key

getPropertyIntValue

public int getPropertyIntValue(java.lang.String key)

Return the value of a property as an int.

Parameters:

key - the property key

Returns:

the property value

getPropertyIntValue

public int getPropertyIntValue(java.lang.String key,
                               short unit)

Return the value of a property as an int.

Parameters:

key - the property key

unit - the unit

Returns:

the property value

getPropertyIntArrayValue

public java.util.List<java.lang.Integer> getPropertyIntArrayValue(java.lang.String key)

Return the value of a property as an int array.

Parameters:

key - the property key

Returns:

the property value

getPropertyBooleanValue

public boolean getPropertyBooleanValue(java.lang.String key)

Return the value of a property as a boolean.

Parameters:

key - the property key

Returns:

the property value

getPropertyBooleanArrayValue

public java.util.List<java.lang.Boolean> getPropertyBooleanArrayValue(java.lang.String key)

Return the value of a property as a boolean array.

Parameters:

key - the property key

Returns:

the property value

getPropertyFloatValue

public float getPropertyFloatValue(java.lang.String key)

Return the value of a property as a float.

Parameters:

key - the property key

Returns:

the property value

getPropertyFloatValue

public float getPropertyFloatValue(java.lang.String key,
                                   short unit)

Return the value of a property as a float.

Parameters:

key - the property key

unit - the unit

Returns:

the property value

getPropertyFloatArrayValue

public java.util.List<java.lang.Float> getPropertyFloatArrayValue(java.lang.String key)

Return the value of a property as a float array.

Parameters:

key - the property key

Returns:

the property value

getNotNullPropertyStringValue

public java.lang.String getNotNullPropertyStringValue(java.lang.String key)

Return the value of a property as a String. The value is guaranteed not to be null.

Parameters:

key - the property key

Returns:

the property value

getPropertyStringValue

public java.lang.String getPropertyStringValue(java.lang.String key)

Return the value of a property as a String.

Parameters:

key - the property key

Returns:

the property value

getPropertyStringArrayValue

public java.util.List<java.lang.String> getPropertyStringArrayValue(java.lang.String key)

Return the value of a property as a String array. This is valid for array of properties of type String.

Parameters:

key - the property key

Returns:

the property value

getPropertyArrayValue

public java.util.List<java.lang.Object> getPropertyArrayValue(java.lang.String key)

Return the value of a property as an array. This is valid for array of properties.

Parameters:

key - the property key

Returns:

the property value

getPropertyURLValue

public java.net.URL getPropertyURLValue(java.lang.String key)

Return the value of a property as an URL.

Parameters:

key - the property key

Returns:

the property value

getPropertyURLValue

public java.net.URL getPropertyURLValue(java.lang.String key,
                                        boolean exists)

Return the value of a property as an URL.

Parameters:

key - the property key

exists - true if the URL must exist

Returns:

the property value

getPropertyURIValue

public java.net.URI getPropertyURIValue(java.lang.String key)

Return the value of a property as an URI.

Parameters:

key - the property key

Returns:

the property value

getPropertyURIValue

public java.net.URI getPropertyURIValue(java.lang.String key,
                                        boolean exists)

Return the value of a property as an URI.

Parameters:

key - the property key

exists - true if the URL must exist

Returns:

the property value

getPropertyURLArrayValue

public java.util.List<java.net.URL> getPropertyURLArrayValue(java.lang.String key)

Return the value of a property as an URL array. This is valid for array of properties of type URL.

Parameters:

key - the property key

Returns:

the property value

getPropertyURLArrayValue

public java.util.List<java.net.URL> getPropertyURLArrayValue(java.lang.String key,
                                                             boolean exists)

Return the value of a property as an URL array. This is valid for array of properties of type URL.

Parameters:

key - the property key

exists - true if the URLs will be put in the list only if they exist

Returns:

the property value

getPropertyFileValue

public java.io.File getPropertyFileValue(java.lang.String key)

Return the value of a property as a File.

Parameters:

key - the property key

Returns:

the property value

getPropertyFileArrayValue

public java.util.List<java.io.File> getPropertyFileArrayValue(java.lang.String key)

Return the value of a property as a File array. This is valid for array of properties of type URL.

Parameters:

key - the property key

Returns:

the property value

getPropertyDurationValue

public java.time.Duration getPropertyDurationValue(java.lang.String key)

Return the value of a property as a Duration.

Parameters:

key - the property key

Returns:

the property value

getPropertyDurationArrayValue

public java.util.List<java.time.Duration> getPropertyDurationArrayValue(java.lang.String key)

Return the value of a property as a Duration array. This is valid for array of properties of type Duration.

Parameters:

key - the property key

Returns:

the property value

getPropertyPositionValue

public ScreenPosition getPropertyPositionValue(java.lang.String key)

Return the value of a property as a ScreenPosition.

Parameters:

key - the property key

Returns:

the property value

getPropertyMapValue

public java.util.Map<java.lang.String,java.lang.String> getPropertyMapValue(java.lang.String key)

Return the value of a property as a Map.

Parameters:

key - the property key

Returns:

the property value

isPreStarted

public boolean isPreStarted()

Return true if the Module is pre-started.

Returns:

true if the Module is pre-started

isStarted

public boolean isStarted()

Return true if the Module is started.

Returns:

true if the Module is started

getModuleClass

protected abstract java.lang.Class<?> getModuleClass()

Return the Module class.

Returns:

the Module class

getModuleInstance

public abstract java.lang.Object getModuleInstance()

Return the Module instance.

Returns:

the Module instance

getClassLoader

public java.lang.ClassLoader getClassLoader()

Return the ClassLoader used for the Module.

Returns:

the ClassLoader

getModuleIDKey

public ModuleIDKey getModuleIDKey()

Return this Module ID key.

Returns:

this Module ID key

setupServices

protected void setupServices()

Setup the Module Services.

create

public abstract void create()
                     throws FrameworkException

Create the Module instance.

Throws:

FrameworkException

preConfigure

public void preConfigure()
                  throws FrameworkException

Pre-configure the Module. It will:

• Invoke the Module preConfigure method (see ModuleDefinition.getPreConfigureEntryPoint())

Throws:

FrameworkException

init

public void init()
          throws FrameworkException

Initialize the Module. It will:

• Invoke the Module init method (see ModuleDefinition.getInitEntryPoint())

Throws:

FrameworkException

setUp

public void setUp()

Setup the Module. It will setUp the protocols associated with the Module.

complete

public void complete(org.da.protoframework.com.netty.Protocol protocol,
                     boolean doStart)

Called when the Protocol setUp has completed.

Specified by:

complete in interface org.da.protoframework.com.netty.ProtocolListener

Parameters:

protocol - the Protocol

doStart - true if the "start" method must be called immediately

hasCyclicTasks

protected boolean hasCyclicTasks()

Return true if there are cyclic tasks.

Returns:

true if there are cyclic task

start

public void start()
           throws FrameworkException

Start the Module. It will:

• Start the cyclic Tasks associated with the module
• Invoke the Module start method (see ModuleDefinition.getStartEntryPoint())

Throws:

FrameworkException

shutdown

public void shutdown()
              throws FrameworkException

Shutdown the module. It will:

• Cancel the cyclic tasks eventually created for the Module
• Shutdown the protocols used by the Module
• Invoke the Module end method (see ModuleDefinition.getEndEntryPoint())

Throws:

FrameworkException

getInitPreConfMethod

protected java.lang.reflect.Method getInitPreConfMethod(java.lang.String methodName)
                                                 throws org.da.protoframework.model.core.EntryPointNotFoundException

Return the Method with a specified name and the Module as argument.

Parameters:

methodName - the Method name

Returns:

the Method

Throws:

EntryPointNotFoundException - if the Method does not exist

getStartEndMethod

protected java.lang.reflect.Method getStartEndMethod(java.lang.String methodName)
                                              throws org.da.protoframework.model.core.EntryPointNotFoundException

Return the Method with a specified name and no argument.

Parameters:

methodName - the Method name

Returns:

the Method

Throws:

EntryPointNotFoundException - if the Method does not exist

getAttachMethod

protected java.lang.reflect.Method getAttachMethod(java.lang.String methodName)
                                            throws org.da.protoframework.model.core.EntryPointNotFoundException

Return the Method with a specified name and the ServiceInstance and a message type character as argument.

Parameters:

methodName - the Method name

Returns:

the Method

Throws:

EntryPointNotFoundException - if the Method does not exist

getMethod

protected java.lang.reflect.Method getMethod(java.lang.String methodName)
                                      throws org.da.protoframework.model.core.EntryPointNotFoundException

Return the Method with a specified name and the ServiceInstance as argument.

Parameters:

methodName - the Method name

Returns:

the Method

Throws:

EntryPointNotFoundException - if the Method does not exist

getTwoArgsMethod

protected java.lang.reflect.Method getTwoArgsMethod(java.lang.String methodName)
                                             throws org.da.protoframework.model.core.EntryPointNotFoundException

Return the Method with a specified name and two ServiceInstance as argument.

Parameters:

methodName - the Method name

Returns:

the Method

Throws:

EntryPointNotFoundException - if the Method does not exist

getReceiveMethod

protected java.lang.reflect.Method getReceiveMethod(ServiceInstance<?,?> service)

Return the Method used for the notification of a Service.

Parameters:

service - the Service

Returns:

the Method

receiveImpl

protected void receiveImpl(ServiceInstance<?,?> service)

Invoke the Method used for the notification of a Service.

Parameters:

service - the Service

getMethodImpl

protected java.lang.reflect.Method getMethodImpl(java.lang.String entryPoint,
                                                 java.lang.Class<?>[] args)
                                          throws java.lang.NoSuchMethodException

Return a method with a specified name and arguments.

Parameters:

entryPoint - the method name

args - the method arguments

Returns:

the Method

Throws:

java.lang.NoSuchMethodException - if the Method was not found

startCustomTasks

protected void startCustomTasks()

Start custom code tasks when starting the Module. Do nothing by default.

lockInvoke

public void lockInvoke()

Lock the invocation of the Services on the Module.