com.etherios.connector.emulator.rci

Class GeneralRCIManager

java.lang.Object

com.etherios.connector.emulator.rci.GeneralRCIManager

All Implemented Interfaces:

IRCIExtension

public class GeneralRCIManager
extends java.lang.Object
implements IRCIExtension

RCI manager to handle remote configuration requests.

The RCI manager loads the base platform descriptor file embedded in the jar file.

This class allows the extension of the RCI base descriptor by the applications that implements the interface IGeneralRCIExtension. This implementation must be provided to the CloudConnector constructor.

This manager will call the different methods of the IGeneralRCIExtension when getting or setting an RCI value if the parameter "extend_rci" is set to True in the connector_config.txt file.

The location of the custom descriptor in the application is determined by the settings "descriptor_type" and "descriptor_loc":

• "embedded" Cloud Connector will look for the descriptor file, defined in "descriptor_type", inside the jar.
• "external" Cloud Connector will look for the file defined "descriptor_type"in the file system of the device.

See Also:

IGeneralRCIExtension, IRCIExtension

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DESCRIPTOR_TYPE_EMBEDDED Embedded RCI descriptor: "embedded".
static java.lang.String	DESCRIPTOR_TYPE_EXTERNAL External RCI descriptor: "external".
static java.lang.String	PARAM_DESCRIPTOR_LOC 'Descriptor location' setting name: "descriptor_loc".
static java.lang.String	PARAM_DESCRIPTOR_TYPE 'Descriptor type' setting name: "descriptor_type".
static java.lang.String	PARAM_EXTEND_RCI 'Extend RCI' setting name: "extend_rci".

Constructor Summary

Constructors

Constructor and Description
GeneralRCIManager(IPlatformCustomization platformCustomization) Class constructor.
GeneralRCIManager(IPlatformCustomization platformCustomization, IGeneralRCIExtension generalRCIExtension) Class constructor.

Method Summary

Modifier and Type	Method and Description
java.io.InputStream	getDescriptorFile() Retrieves the descriptor file as input stream in order to be used by the RCI facility.
java.lang.String	getParameterValue(java.lang.String parameter) Retrieves the value of the given parameter name.
java.lang.String	getSettingValue(java.lang.String group, java.lang.String setting, int index, java.lang.String name) Retrieves the value of the given setting name included in the given setting group.
java.lang.String	handleZigbeeRequest(java.lang.String data) Handles a ZigBee target request with the given data.
java.lang.String	setSettingValue(java.lang.String group, java.lang.String setting, java.lang.String value, int index, java.lang.String name) Sets the value of the given setting name included in the given setting group.

Methods inherited from class java.lang.Object

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

Field Detail

DESCRIPTOR_TYPE_EMBEDDED

public static final java.lang.String DESCRIPTOR_TYPE_EMBEDDED

Embedded RCI descriptor: "embedded".

See Also:

PARAM_DESCRIPTOR_TYPE, DESCRIPTOR_TYPE_EXTERNAL, Constant Field Values

DESCRIPTOR_TYPE_EXTERNAL

public static final java.lang.String DESCRIPTOR_TYPE_EXTERNAL

External RCI descriptor: "external".

See Also:

PARAM_DESCRIPTOR_TYPE, DESCRIPTOR_TYPE_EMBEDDED, Constant Field Values

PARAM_DESCRIPTOR_LOC

public static final java.lang.String PARAM_DESCRIPTOR_LOC

'Descriptor location' setting name: "descriptor_loc".

This setting specifies the location of the custom descriptor file.

See Also:

PARAM_EXTEND_RCI, PARAM_DESCRIPTOR_TYPE, getParameterValue(java.lang.String), Constant Field Values

PARAM_DESCRIPTOR_TYPE

public static final java.lang.String PARAM_DESCRIPTOR_TYPE

'Descriptor type' setting name: "descriptor_type".

This setting specifies the type of the custom descriptor file: DESCRIPTOR_TYPE_EMBEDDED ("embedded") or DESCRIPTOR_TYPE_EXTERNAL ("external").

See Also:

DESCRIPTOR_TYPE_EMBEDDED, DESCRIPTOR_TYPE_EXTERNAL, PARAM_EXTEND_RCI, PARAM_DESCRIPTOR_LOC, getParameterValue(java.lang.String), Constant Field Values

PARAM_EXTEND_RCI

public static final java.lang.String PARAM_EXTEND_RCI

'Extend RCI' setting name: "extend_rci".

This setting allows the custom extension of the base descriptor.

See Also:

PARAM_DESCRIPTOR_TYPE, PARAM_DESCRIPTOR_LOC, getParameterValue(java.lang.String), Constant Field Values

Constructor Detail

GeneralRCIManager

public GeneralRCIManager(IPlatformCustomization platformCustomization)

Class constructor. Instances a new General RCI Manager object.

Parameters:

platformCustomization - Platform customization.

GeneralRCIManager

public GeneralRCIManager(IPlatformCustomization platformCustomization,
                         IGeneralRCIExtension generalRCIExtension)

Class constructor. Instances a new General RCI Manager object with the given General RCI extension.

Parameters:

platformCustomization - Platform customization.

generalRCIExtension - RCI extension used to extend RCI functionality.

Method Detail

getDescriptorFile

public java.io.InputStream getDescriptorFile()

Description copied from interface: IRCIExtension

Retrieves the descriptor file as input stream in order to be used by the RCI facility.

Specified by:

getDescriptorFile in interface IRCIExtension

Returns:

Input stream of the descriptor file.

getParameterValue

public java.lang.String getParameterValue(java.lang.String parameter)

Retrieves the value of the given parameter name.

Parameters:

parameter - the parameter name to get its value.

Returns:

a string representing the value of the given parameter name.

getSettingValue

public java.lang.String getSettingValue(java.lang.String group,
                                        java.lang.String setting,
                                        int index,
                                        java.lang.String name)

Description copied from interface: IRCIExtension

Retrieves the value of the given setting name included in the given setting group.

Specified by:

getSettingValue in interface IRCIExtension

Parameters:

group - Name of the group where the setting is included.

setting - Name of the setting to retrieve its value.

index - In case of multiple instances of the settings group, the group index for arrays.

name - In case of multiple instances of the settings group, the group name for dictionaries.

Returns:

The setting value.

handleZigbeeRequest

public java.lang.String handleZigbeeRequest(java.lang.String data)

Description copied from interface: IRCIExtension

Handles a ZigBee target request with the given data.

Specified by:

handleZigbeeRequest in interface IRCIExtension

Parameters:

data - ZigBee request data in XML format.

Returns:

The request answer after processing.

setSettingValue

public java.lang.String setSettingValue(java.lang.String group,
                                        java.lang.String setting,
                                        java.lang.String value,
                                        int index,
                                        java.lang.String name)

Description copied from interface: IRCIExtension

Sets the value of the given setting name included in the given setting group.

Specified by:

setSettingValue in interface IRCIExtension

Parameters:

group - Name of the group where the setting is included.

setting - Name of the setting to set its value.

value - The new setting value.

index - In case of multiple instances of the settings group, the group index for arrays.

name - In case of multiple instances of the settings group, the group name for dictionaries.

Returns:

Set setting answer. Empty answer means no error.