com.etherios.connector.core.facilities.rci

Interface IRCIExtension

All Known Implementing Classes:

GeneralRCIManager

public interface IRCIExtension

This interface defines all the methods that should be implemented by the different platform connector implementations so that Cloud Connector knows how to perform the RCI operations in that platform.

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

Method Detail

getDescriptorFile

java.io.InputStream getDescriptorFile()

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

Returns:

Input stream of the descriptor file.

getSettingValue

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.

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

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

Handles a ZigBee target request with the given data.

Parameters:

data - ZigBee request data in XML format.

Returns:

The request answer after processing.

setSettingValue

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.

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.