org.da.protoframework.model.def

Class ModuleDefinition

java.lang.Object

org.da.protoframework.model.def.ModuleDefinition

All Implemented Interfaces:

java.lang.Cloneable, org.da.protoframework.model.def.DescriptedElement, ElementDefinition

Direct Known Subclasses:

CustomModuleDefinition

public abstract class ModuleDefinition
extends java.lang.Object
implements ElementDefinition, java.lang.Cloneable

The definition for a Module.

Constructor Summary

Constructors

Constructor and Description
ModuleDefinition(ApplicationDefinition appli, java.lang.String name, long id) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addArrayProperty(java.net.URL dir, java.lang.String key, java.lang.Class<?> type, boolean isMandatory) Add an array property type.
void	addArrayProperty(java.net.URL dir, java.lang.String key, java.lang.Class<?> type, boolean isMandatory, boolean allowConfigVariables) Add an array property type.
void	addArrayProperty(java.net.URL dir, java.lang.String key, java.lang.Class<?> type, short unit, boolean isMandatory) Add an array property type.
void	addArrayProperty(java.net.URL dir, java.lang.String key, java.lang.Class<?> type, short unit, boolean isMandatory, boolean allowConfigVariables) Add an array property type.
void	addAutoProperty(java.lang.String key, org.da.protoframework.model.def.Value<?> autoValue) Add an auto property.
void	addCyclicMethod(org.da.protoframework.model.def.CyclicMethodDefinition method) Add a cyclic method declaration.
void	addProperty(org.da.protoframework.model.def.SimpleProperty property) Add an existing property to the module.
void	addProperty(org.da.protoframework.model.def.SimpleProperty property, boolean isDefault) Add an existing property to the module.
short	addProperty(java.net.URL dir, java.lang.String key, java.lang.Class<?> type, java.lang.String defaultValue, boolean isMandatory, boolean inArray) Add a property type.
short	addProperty(java.net.URL dir, java.lang.String key, java.lang.Class<?> type, java.lang.String defaultValue, boolean isMandatory, boolean inArray, boolean allowConfigVariables) Add a property type.
short	addProperty(java.net.URL dir, java.lang.String key, java.lang.Class<?> type, java.lang.String defaultValue, short unit, boolean isMandatory, boolean inArray) Add a property type.
short	addProperty(java.net.URL dir, java.lang.String key, java.lang.Class<?> type, java.lang.String defaultValue, short unit, boolean isMandatory, boolean inArray, boolean allowConfigVariables) Add a property type.
void	addPropertyParent(org.da.protoframework.model.def.PropertyParent parent) Add a PropertyParent.
void	addProviderInterface(InterfaceDefinition serviceInt) Add a provider interface for a Service to the Module.
void	addSubscriberInterface(InterfaceDefinition serviceInt) Add a subscriber interface for a Service to the Module.
ModuleDefinition	clone()
int	countProperties() Count the number of properties.
ModuleIDKey	createModuleIDKey() Create an unique key for the module.
ModuleKey	createModuleKey() Create an unique key for the module.
ApplicationDefinition	getApplicationDefinition() Return the Application Definition.
java.lang.String	getAttachEntryPoint() Return the default attach / detach entryPoint path for the module.
java.util.List<org.da.protoframework.model.def.CyclicMethodDefinition>	getCyclicMethods() Return a cyclic method declarations.
org.da.protoframework.model.def.ChannelDefinition	getDefaultChannelDefinition() Return the default channel definition for the module.
java.lang.String	getDescription() Return the service description (may be null).
java.net.URL	getDirectory() Return the module directory.
java.lang.String	getEndEntryPoint() Return the end entryPoint path for the module.
java.lang.String	getFinishInvokeEntryPoint() Return the default receive finishInvoke path for the module.
long	getID() Return the module ID.
java.lang.String	getInitEntryPoint() Return the init entryPoint of the module.
java.net.URL	getInstanceDirectory() Return the module instance directory.
java.lang.String	getLibraryName() Return the module library name (may be null).
java.lang.String	getLibraryVersion() Return the application library version.
ModuleIDKey	getModuleIDKey() Return this Module ID key.
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 property.
java.lang.String	getNotNullPropertyStringValue(java.lang.String key) Return the value of a property as a String.
java.lang.String	getPath() Return the module main class path.
java.lang.String	getPreConfigureEntryPoint() Return the init entryPoint of the module.
java.util.Map<java.lang.String,org.da.protoframework.model.def.SimpleProperty>	getProperties() Return the properties.
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<org.da.protoframework.model.def.PropertyGroup>	getPropertyGroups() Return the list of PropertyParents.
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.
java.util.List<org.da.protoframework.model.def.PropertyParent>	getPropertyParents() Return the list of PropertyParents.
ScreenPosition	getPropertyPositionValue(java.lang.String key) Return the value of a property as a position.
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 module property.
java.lang.Object	getPropertyValue(java.lang.String key, short unit) Return the value of a module property.
InterfaceDefinition	getProviderInterfaceDefinition(NamespaceKey key) Return the provider interface definition for a Service name.
java.util.Map<NamespaceKey,InterfaceDefinition>	getProviderInterfaces() Return the provider Service interfaces for the Module.
java.lang.String	getReceiveEntryPoint() Return the default receive entryPoint path for the module.
java.lang.String	getSendEntryPoint() Return the default send entryPoint path for the module.
org.da.protoframework.model.def.SimpleProperty	getSimpleProperty(java.lang.String key) Return a property.
java.lang.String	getStartEntryPoint() Return the start entryPoint of the module.
org.da.protoframework.model.def.Value.Duration	getStartEntryPointDelay() Return the start entryPoint delay.
int	getStartEntryPointDelayMS() Return the start entryPoint delay in ms.
InterfaceDefinition	getSubscriberInterfaceDefinition(NamespaceKey key) Return the subscriber interface definition for a Service.
java.util.Map<NamespaceKey,InterfaceDefinition>	getSubscriberInterfaces() Return the subscriber Service interfaces for the Module.
java.lang.String	getTriggerEntryPoint() Return the default trigger entryPoint path for the module.
int	getUpdateCap() Return the update cap value in ms.
boolean	hasAllUpdateCap() Return true if the Module has an update cap for all output services.
boolean	hasDefaultName() Return true if the name of the module is the default name for a library.
boolean	hasDefinedProperty(java.lang.String key) Return true if there is a property for a specified key.
boolean	hasImplementation() Return true if the Module has an implementation.
boolean	hasInterface(NamespaceKey key) Return true if there is an interface for a Service to the Module.
boolean	hasLibraryVersion() Return true if the application has a library version.
boolean	hasMandatoryProperties() Return true if the module has at least one mandatory property.
boolean	hasNamedProperty(java.lang.String key) Return true if there is a named property with a specified key.
boolean	hasProperties() Return true if the module has properties.
boolean	hasProviderInterface(NamespaceKey key) Return true if there is a provider interface for a Service to the Module.
boolean	hasPublishUpdateCap() Return true if the Module has an update cap for publish output services.
boolean	hasServiceInterfaces() Return true if there is at least one Service interface for the module.
boolean	hasSimpleProperty(java.lang.String key) Return true if there is a simple property with a specified key.
boolean	hasSubscriberInterface(NamespaceKey key) Return true if there is a subscriber interface for a Service to 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	isKeepingInterfaces() Return true if the interfaces of the module should be kept by default when instanciating a library.
boolean	isMaster() Return true if the module is a master module.
void	keepInterfaces(boolean isKeepingInterfaces) Set if the interfaces of the module should be kept by default when instanciating a library.
void	merge(ModuleDefinition module) Merge the definition of another module with this one.
void	removeProviderInterface(NamespaceKey key) Removes a provider interface.
void	removeSubscriberInterface(NamespaceKey key) Removes a subscriber interface.
void	setApplication(ApplicationDefinition appli) Set the Module associated application.
void	setAttachEntryPoint(java.lang.String entryPoint) Set the default receive attach / detach path for the module.
void	setDefaultChannelDefinition(org.da.protoframework.model.def.ChannelDefinition channelDef) Set the default channel definition for the module.
void	setDefaultName(boolean isDefaultName) Set true if the name of the module is the default name for a library.
void	setDescription(java.lang.String desc) Set the service description.
void	setDirectory(java.net.URL dir) Set the module directory.
void	setEnabled(boolean isEnabled) Set if the module is enabled.
void	setEndEntryPoint(java.lang.String entryPoint) Set the end entryPoint path for the module.
void	setFinishInvokeEntryPoint(java.lang.String entryPoint) Set the default finishInvoke path for the module.
void	setID(long id) Set the Module ID.
void	setInitEntryPoint(java.lang.String entryPoint) Set the init entryPoint path of the module. if will be called for the Module.init().
void	setLibraryName(java.lang.String libraryName) Set the module library name.
void	setLibraryVersion(java.lang.String version) Set the application library version.
void	setMaster(boolean isMaster) Set if the module is a master module.
void	setName(java.lang.String name) Set the module name.
void	setPath(java.lang.String path) Set the module main class path.
void	setPreconfigureEntryPoint(java.lang.String entryPoint) Set the init entryPoint path of the module. if will be called for the Module.preConfigure().
short	setPropertyValue(java.net.URL dir, java.lang.String key, java.lang.String value) Set the value of a module property.
short	setPropertyValue(java.net.URL dir, java.lang.String key, java.lang.String value, short unit) Set the value of a module property.
void	setReceiveEntryPoint(java.lang.String entryPoint) Set the default receive entryPoint path for the module.
void	setSendEntryPoint(java.lang.String entryPoint) Set the default send entryPoint path for the module.
void	setStartEntryPoint(java.lang.String entryPoint, org.da.protoframework.model.def.Value.Duration delayMS) Set the start entryPoint path of the module. if will be called for the Module.start().
void	setTriggerEntryPoint(java.lang.String entryPoint) Set the default trigger entryPoint path for the module.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.da.protoframework.model.def.ElementDefinition

hasID

Methods inherited from interface org.da.protoframework.model.def.DescriptedElement

hasDescription

Constructor Detail

ModuleDefinition

public ModuleDefinition(ApplicationDefinition appli,
                        java.lang.String name,
                        long id)

Constructor.

Parameters:

appli - the application definition

name - the module name

id - the module ID

Method Detail

setName

public void setName(java.lang.String name)

Set the module name.

Parameters:

name - the name

setDescription

public void setDescription(java.lang.String desc)

Set the service description.

Specified by:

setDescription in interface org.da.protoframework.model.def.DescriptedElement

Parameters:

desc - the service description

getDescription

public java.lang.String getDescription()

Return the service description (may be null).

Specified by:

getDescription in interface org.da.protoframework.model.def.DescriptedElement

Returns:

the service description

setLibraryName

public void setLibraryName(java.lang.String libraryName)

Set the module library name.

Parameters:

libraryName - the library name

getLibraryName

public java.lang.String getLibraryName()

Return the module library name (may be null).

Returns:

the module library name

setDefaultName

public void setDefaultName(boolean isDefaultName)

Set true if the name of the module is the default name for a library.

Parameters:

isDefaultName - true if the name of the module is the default name for a library

hasDefaultName

public boolean hasDefaultName()

Return true if the name of the module is the default name for a library.

Returns:

true true if the name of the module is the default name for a library

setApplication

public void setApplication(ApplicationDefinition appli)

Set the Module associated application.

Parameters:

appli - the application definition

setLibraryVersion

public void setLibraryVersion(java.lang.String version)

Set the application library version.

Parameters:

version - the application library version

hasLibraryVersion

public boolean hasLibraryVersion()

Return true if the application has a library version.

Returns:

true if the application has a library version

getLibraryVersion

public java.lang.String getLibraryVersion()

Return the application library version.

Returns:

the application library version

keepInterfaces

public void keepInterfaces(boolean isKeepingInterfaces)

Set if the interfaces of the module should be kept by default when instanciating a library.

Parameters:

isKeepingInterfaces - true if the interfaces of the module should be kept by default

isKeepingInterfaces

public boolean isKeepingInterfaces()

Return true if the interfaces of the module should be kept by default when instanciating a library.

Returns:

true if the interfaces of the module should be kept by default

setID

public void setID(long id)

Set the Module ID.

Specified by:

setID in interface ElementDefinition

Parameters:

id - the Module ID

clone

public ModuleDefinition clone()

Overrides:

clone in class java.lang.Object

setMaster

public void setMaster(boolean isMaster)

Set if the module is a master module. A master module is allowed to attach or detach other modules.

Parameters:

isMaster - true if the module is a master module

isMaster

public boolean isMaster()

Return true if the module is a master module. A master module is allowed to attach or detach other modules.

Returns:

true if the module is a master module

setEnabled

public void setEnabled(boolean isEnabled)

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

Parameters:

isEnabled - true if the module is a enabled

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

setDirectory

public void setDirectory(java.net.URL dir)

Set the module directory.

Parameters:

dir - the module directory

getDirectory

public java.net.URL getDirectory()

Return the module directory.

Returns:

the module directory

getInstanceDirectory

public java.net.URL getInstanceDirectory()

Return the module instance directory.

Returns:

the module instance directory

createModuleKey

public final ModuleKey createModuleKey()

Create an unique key for the module.

Returns:

the key

createModuleIDKey

public final ModuleIDKey createModuleIDKey()

Create an unique key for the module.

Returns:

the key

getModuleKey

public ModuleKey getModuleKey()

Return this Module key.

Returns:

this Module key

getModuleIDKey

public ModuleIDKey getModuleIDKey()

Return this Module ID key.

Returns:

this Module ID key

setDefaultChannelDefinition

public void setDefaultChannelDefinition(org.da.protoframework.model.def.ChannelDefinition channelDef)

Set the default channel definition for the module.

Parameters:

channelDef - the default channel definition

getDefaultChannelDefinition

public org.da.protoframework.model.def.ChannelDefinition getDefaultChannelDefinition()

Return the default channel definition for the module.

Returns:

the default channel definition

getApplicationDefinition

public ApplicationDefinition getApplicationDefinition()

Return the Application Definition.

Returns:

the Application Definition

getID

public long getID()

Return the module ID.

Specified by:

getID in interface ElementDefinition

Returns:

the module ID

getName

public java.lang.String getName()

Return the module name.

Specified by:

getName in interface ElementDefinition

Returns:

the module name

getPropertyParents

public java.util.List<org.da.protoframework.model.def.PropertyParent> getPropertyParents()

Return the list of PropertyParents.

Returns:

the list of PropertyParents

getPropertyGroups

public java.util.List<org.da.protoframework.model.def.PropertyGroup> getPropertyGroups()

Return the list of PropertyParents.

Returns:

the list of PropertyParents

addPropertyParent

public void addPropertyParent(org.da.protoframework.model.def.PropertyParent parent)

Add a PropertyParent.

Parameters:

parent - the PropertyParent

addArrayProperty

public void addArrayProperty(java.net.URL dir,
                             java.lang.String key,
                             java.lang.Class<?> type,
                             short unit,
                             boolean isMandatory)

Add an array property type.

Parameters:

dir - the base directory

key - the property key

type - the property type

unit - the property unit

isMandatory - true if the property is mandatory

addArrayProperty

public void addArrayProperty(java.net.URL dir,
                             java.lang.String key,
                             java.lang.Class<?> type,
                             short unit,
                             boolean isMandatory,
                             boolean allowConfigVariables)

Add an array property type.

Parameters:

dir - the base directory

key - the property key

type - the property type

unit - the property unit

isMandatory - true if the property is mandatory

allowConfigVariables - true if configuration variables patterns are allowed

addArrayProperty

public void addArrayProperty(java.net.URL dir,
                             java.lang.String key,
                             java.lang.Class<?> type,
                             boolean isMandatory)

Add an array property type.

Parameters:

dir - the base directory

key - the property key

type - the property type

isMandatory - true if the property is mandatory

addArrayProperty

public void addArrayProperty(java.net.URL dir,
                             java.lang.String key,
                             java.lang.Class<?> type,
                             boolean isMandatory,
                             boolean allowConfigVariables)

Add an array property type.

Parameters:

dir - the base directory

key - the property key

type - the property type

isMandatory - true if the property is mandatory

allowConfigVariables - true if configuration variable patterns are allowed

addProperty

public void addProperty(org.da.protoframework.model.def.SimpleProperty property)

Add an existing property to the module.

Parameters:

property - the property

addProperty

public void addProperty(org.da.protoframework.model.def.SimpleProperty property,
                        boolean isDefault)

Add an existing property to the module. Defer to addProperty(org.da.protoframework.model.def.SimpleProperty) by default.

Parameters:

property - the property

isDefault - true for a default property

addProperty

public short addProperty(java.net.URL dir,
                         java.lang.String key,
                         java.lang.Class<?> type,
                         java.lang.String defaultValue,
                         short unit,
                         boolean isMandatory,
                         boolean inArray,
                         boolean allowConfigVariables)

Add a property type.

Parameters:

dir - the base directory

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 an array

allowConfigVariables - true if configuration variables patterns will be allowed in the property value

Returns:

true if the property type could be set

addProperty

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

Add a property type.

Parameters:

dir - the base directory

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 an array

Returns:

true if the property type could be set

addProperty

public short addProperty(java.net.URL dir,
                         java.lang.String key,
                         java.lang.Class<?> type,
                         java.lang.String defaultValue,
                         boolean isMandatory,
                         boolean inArray)

Add a property type.

Parameters:

dir - the base directory

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

addProperty

public short addProperty(java.net.URL dir,
                         java.lang.String key,
                         java.lang.Class<?> type,
                         java.lang.String defaultValue,
                         boolean isMandatory,
                         boolean inArray,
                         boolean allowConfigVariables)

Add a property type.

Parameters:

dir - the base directory

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

allowConfigVariables - true if configuration variable patterns are allowed

Returns:

true if the property type could be set

addAutoProperty

public void addAutoProperty(java.lang.String key,
                            org.da.protoframework.model.def.Value<?> autoValue)

Add an auto property.

Parameters:

key - the property key

autoValue - the auto-proerty

getProperties

public java.util.Map<java.lang.String,org.da.protoframework.model.def.SimpleProperty> getProperties()

Return the properties.

Returns:

the properties

hasProperties

public boolean hasProperties()

Return true if the module has properties.

Returns:

true if the module has properties

countProperties

public int countProperties()

Count the number of properties.

Returns:

the number of properties

hasSimpleProperty

public boolean hasSimpleProperty(java.lang.String key)

Return true if there is a simple property with a specified key.

Parameters:

key - the PropertyElement key

Returns:

true if there is a property with the specified key

hasMandatoryProperties

public boolean hasMandatoryProperties()

Return true if the module has at least one mandatory property.

Returns:

true if the module has at least one mandatory property

hasNamedProperty

public boolean hasNamedProperty(java.lang.String key)

Return true if there is a named property with a specified key.

Parameters:

key - the PropertyElement key

Returns:

true if there is a property with the specified key

getSimpleProperty

public org.da.protoframework.model.def.SimpleProperty getSimpleProperty(java.lang.String key)

Return a property.

Parameters:

key - the property key

Returns:

the property type

getNamedProperty

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

Return a property.

Parameters:

key - the property key

Returns:

the property type

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. Defer to getPropertyURLValue(java.lang.String, boolean) with the exist parameter set to false.

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. It will return null if one of these conditions is true:

• The property does not exist
• The property is not an URL
• The exist arugment is true, and the URL does not exist

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,
                                        boolean exists)

Return the value of a property as an URI. It will return null if one of these conditions is true:

• The property does not exist
• The property is not an URL
• The exist arugment is true, and the URL does not exist

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. Defer to getPropertyURIValue(java.lang.String, boolean) with the exists arugment set to true.

Parameters:

key - the property key

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 position.

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

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

setPropertyValue

public short setPropertyValue(java.net.URL dir,
                              java.lang.String key,
                              java.lang.String value)

Set the value of a module property.

Parameters:

dir - the base directory

key - the property key

value - the property value as a String

Returns:

true if the value could be set

setPropertyValue

public short setPropertyValue(java.net.URL dir,
                              java.lang.String key,
                              java.lang.String value,
                              short unit)

Set the value of a module property.

Parameters:

dir - the base directory

key - the property key

value - the property value as a String

unit - the unit

Returns:

true if the value could be set

getPropertyValue

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

Return the value of a module property.

Parameters:

key - the property key

Returns:

the property value

getPropertyValue

public java.lang.Object getPropertyValue(java.lang.String key,
                                         short unit)

Return the value of a module property.

Parameters:

key - the property key

unit - the unit

Returns:

the property value

setPath

public void setPath(java.lang.String path)

Set the module main class path.

Parameters:

path - the module main class path

getPath

public java.lang.String getPath()

Return the module main class path.

Returns:

the module main class path

setPreconfigureEntryPoint

public void setPreconfigureEntryPoint(java.lang.String entryPoint)

Set the init entryPoint path of the module. if will be called for the Module.preConfigure().

Parameters:

entryPoint - the entryPoint

getPreConfigureEntryPoint

public java.lang.String getPreConfigureEntryPoint()

Return the init entryPoint of the module.

Returns:

the entryPoint

setInitEntryPoint

public void setInitEntryPoint(java.lang.String entryPoint)

Set the init entryPoint path of the module. if will be called for the Module.init().

Parameters:

entryPoint - the entryPoint

getInitEntryPoint

public java.lang.String getInitEntryPoint()

Return the init entryPoint of the module.

Returns:

the entryPoint

setStartEntryPoint

public void setStartEntryPoint(java.lang.String entryPoint,
                               org.da.protoframework.model.def.Value.Duration delayMS)

Set the start entryPoint path of the module. if will be called for the Module.start().

Parameters:

entryPoint - the entryPoint

delayMS - the delay in ms after the start of the Application when the method should be called

getStartEntryPoint

public java.lang.String getStartEntryPoint()

Return the start entryPoint of the module.

Returns:

the entryPoint

getStartEntryPointDelayMS

public int getStartEntryPointDelayMS()

Return the start entryPoint delay in ms.

Returns:

the delay in ms

getStartEntryPointDelay

public org.da.protoframework.model.def.Value.Duration getStartEntryPointDelay()

Return the start entryPoint delay.

Returns:

the delay

setAttachEntryPoint

public void setAttachEntryPoint(java.lang.String entryPoint)

Set the default receive attach / detach path for the module.

Parameters:

entryPoint - the default attach / detach entryPoint path

getAttachEntryPoint

public java.lang.String getAttachEntryPoint()

Return the default attach / detach entryPoint path for the module.

Returns:

the default attach / detach entryPoint path

setFinishInvokeEntryPoint

public void setFinishInvokeEntryPoint(java.lang.String entryPoint)

Set the default finishInvoke path for the module.

Parameters:

entryPoint - the default finishInvoke entryPoint path

getFinishInvokeEntryPoint

public java.lang.String getFinishInvokeEntryPoint()

Return the default receive finishInvoke path for the module.

Returns:

the default receive finishInvoke path

setReceiveEntryPoint

public void setReceiveEntryPoint(java.lang.String entryPoint)

Set the default receive entryPoint path for the module. It will be called by default for ServiceInstance.notified(char).

Parameters:

entryPoint - the default receive entryPoint path

getReceiveEntryPoint

public java.lang.String getReceiveEntryPoint()

Return the default receive entryPoint path for the module.

Returns:

the default receive entryPoint path

setSendEntryPoint

public void setSendEntryPoint(java.lang.String entryPoint)

Set the default send entryPoint path for the module. It will be called by ServiceInstance.invoke().

Parameters:

entryPoint - the default send entryPoint path

getSendEntryPoint

public java.lang.String getSendEntryPoint()

Return the default send entryPoint path for the module.

Returns:

the default send entryPoint path

setTriggerEntryPoint

public void setTriggerEntryPoint(java.lang.String entryPoint)

Set the default trigger entryPoint path for the module.

Parameters:

entryPoint - the default trigger entryPoint path

getTriggerEntryPoint

public java.lang.String getTriggerEntryPoint()

Return the default trigger entryPoint path for the module.

Returns:

the default trigger entryPoint path

setEndEntryPoint

public void setEndEntryPoint(java.lang.String entryPoint)

Set the end entryPoint path for the module. It will be called by Module.shutdown().

Parameters:

entryPoint - the end entryPoint path

getEndEntryPoint

public java.lang.String getEndEntryPoint()

Return the end entryPoint path for the module.

Returns:

the end entryPoint path

addProviderInterface

public void addProviderInterface(InterfaceDefinition serviceInt)

Add a provider interface for a Service to the Module.

Parameters:

serviceInt - the provider interface

removeProviderInterface

public void removeProviderInterface(NamespaceKey key)

Removes a provider interface.

Parameters:

key - the interface key

getProviderInterfaces

public java.util.Map<NamespaceKey,InterfaceDefinition> getProviderInterfaces()

Return the provider Service interfaces for the Module.

Returns:

the provider Service interfaces

addCyclicMethod

public void addCyclicMethod(org.da.protoframework.model.def.CyclicMethodDefinition method)

Add a cyclic method declaration.

Parameters:

method - the cyclic method declaration

getCyclicMethods

public java.util.List<org.da.protoframework.model.def.CyclicMethodDefinition> getCyclicMethods()

Return a cyclic method declarations.

Returns:

the cyclic method declarations

hasServiceInterfaces

public boolean hasServiceInterfaces()

Return true if there is at least one Service interface for the module.

Returns:

true if there is at least one Service interface for the modul

addSubscriberInterface

public void addSubscriberInterface(InterfaceDefinition serviceInt)

Add a subscriber interface for a Service to the Module.

Parameters:

serviceInt - the subscriber interface

removeSubscriberInterface

public void removeSubscriberInterface(NamespaceKey key)

Removes a subscriber interface.

Parameters:

key - the interface key

getSubscriberInterfaces

public java.util.Map<NamespaceKey,InterfaceDefinition> getSubscriberInterfaces()

Return the subscriber Service interfaces for the Module.

Returns:

the subscriber Service interfaces

merge

public void merge(ModuleDefinition module)

Merge the definition of another module with this one.

Parameters:

module - the other module

hasImplementation

public boolean hasImplementation()

Return true if the Module has an implementation.

Returns:

true if the Module has an implementation

hasProviderInterface

public boolean hasProviderInterface(NamespaceKey key)

Return true if there is a provider interface for a Service to the Module.

Parameters:

key - the Service key

Returns:

true if there is a provider interface for the Service

getProviderInterfaceDefinition

public InterfaceDefinition getProviderInterfaceDefinition(NamespaceKey key)

Return the provider interface definition for a Service name.

Parameters:

key - the Service key

Returns:

the provider interface definition

hasSubscriberInterface

public boolean hasSubscriberInterface(NamespaceKey key)

Return true if there is a subscriber interface for a Service to the Module.

Parameters:

key - the Service key

Returns:

true if there is a subscriber interface for the Service

hasInterface

public boolean hasInterface(NamespaceKey key)

Return true if there is an interface for a Service to the Module.

Parameters:

key - the Service key

Returns:

true if there is an interface for the Service

getSubscriberInterfaceDefinition

public InterfaceDefinition getSubscriberInterfaceDefinition(NamespaceKey key)

Return the subscriber interface definition for a Service.

Parameters:

key - the Service key

Returns:

the subscriber interface definition

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object