IConnectorPreferences (Etherios Cloud Connector for Java ME)

All Known Implementing Classes:

ConnectorPreferencesManager, PreferencesManager
```
public interface IConnectorPreferences
```
This interface defines all the methods that should be implemented by the different platform connector implementations so that Cloud Connector knows how to work with settings in that platform.
Several parameters of Cloud Connector requires some user configuration. These parameters are usually stored as preferences in the device. Since each device may have its own way to store preferences or properties, this interface defines the required methods that should be implemented by each device for that purpose. This allows the device to define its own strategy to work with preferences.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAuthorizationPassword()` Retrieves the authorization password setting value if the authorization type is configured to `PreferencesConstants.AUTHORIZATION_TYPE_BASIC` ().
`java.lang.String`	`getAuthorizationType()` Retrieves the connection authorization type.
`java.lang.String`	`getContact()` Retrieves the Cloud Connector device contact setting.
`java.lang.String`	`getDescription()` Retrieves the Cloud Connector device description setting.
`java.lang.String`	`getDeviceID()` Retrieves the device's Device ID.
`java.lang.String`	`getDeviceType()` Retrieves the device type.
`java.lang.String`	`getFileSystemRootDir()` Retrieves the file system root (sandbox) directory.
`java.lang.String`	`getFirmwareVersion()` Retrieves the 4 digit firmware version of the system.
`int`	`getKeepAliveTime()` Retrieves the keep alive time setting value in seconds.
`java.lang.String`	`getLocation()` Retrieves the Cloud Connector device location setting.
`int`	`getReconnectTime()` Retrieves the configured reconnect time delay setting in seconds.
`int`	`getServerKeepAliveTime()` Retrieves the server keep alive time setting value in seconds.
`Location`	`getStaticLocation()` Retrieves the static location to use.
`java.lang.String`	`getURLString()` Retrieves the configured Cloud Connector URL preference.
`byte[]`	`getVendorID()` Retrieves the device vendor ID.
`int`	`getWaitTimes()` Retrieves the value of the wait times preference.
`boolean`	`isCompressionEnabled()` Retrieves whether messages compression is enabled or not.
`boolean`	`isDataServiceEnabled()` Retrieves whether the data service is enabled or not.
`boolean`	`isFileSystemEnabled()` Retrieves whether file system should be enabled or not.
`boolean`	`isRCIEnabled()` Retrieves whether the RCI facility is enabled or not.
`boolean`	`isReconnectEnabled()` Retrieves whether reconnect setting is enabled or not.
`boolean`	`isSecureConnectionEnabled()` Retrieves whether secure connection is enabled or not.
`void`	`setAuthorizationPassword(java.lang.String password)` Sets the authorization password setting new value.
`void`	`setAuthorizationType(java.lang.String authorizationType)` Sets the new value for the connection authorization type setting.
`void`	`setCompressionEnabled(boolean enabled)` Sets the new value of the compress messages setting.
`void`	`setContact(java.lang.String contact)` Sets the Cloud Connector device contact setting.
`void`	`setDescription(java.lang.String description)` Sets the Cloud Connector device description setting.
`void`	`setDeviceID(java.lang.String deviceID)` Stores the device ID.
`void`	`setKeepAliveTime(int time)` Sets the new value for the Keep Alive time setting in seconds.
`void`	`setLocation(java.lang.String location)` Sets the Cloud Connector device location setting.
`void`	`setReconnectEnabled(boolean enabled)` Sets the new value of the reconnect setting.
`void`	`setReconnectTime(int time)` Sets the new value for the reconnect time setting in seconds.
`void`	`setSecureConnectionEnabled(boolean value)` Sets the new value for the use secure connection setting.
`void`	`setServerKeepAliveTime(int time)` Sets the new value for the Server Keep Alive time setting in seconds.
`void`	`setStaticLocation(Location location)` Sets the value of the static location.
`void`	`setURLString(java.lang.String url)` Sets the Cloud Connector URL preference.
`void`	`setUseStaticLocation(boolean useStaticLocation)` Sets the value of use static location preference.
`void`	`setVendorID(java.lang.String vendorID)` Sets the Cloud Connector Vendor ID setting.
`void`	`setWaitTimes(int waitTimes)` Sets the new value for the wait times setting.
`boolean`	`useStaticLocation()` Retrieves whether static location will be used or not.

- Method Detail
  - getAuthorizationPassword
```
java.lang.String getAuthorizationPassword()
```
    Retrieves the authorization password setting value if the authorization type is configured to PreferencesConstants.AUTHORIZATION_TYPE_BASIC ().
    
    Returns:
    
    Authorization password setting value.
    
    See Also:
    
    PreferencesConstants.AUTHORIZATION_TYPE_BASIC, setAuthorizationPassword(java.lang.String), getAuthorizationType(), setAuthorizationType(java.lang.String)
  - getAuthorizationType
```
java.lang.String getAuthorizationType()
```
    Retrieves the connection authorization type.
    It should be PreferencesConstants.AUTHORIZATION_TYPE_NONE or PreferencesConstants.AUTHORIZATION_TYPE_BASIC ().
    
    For the PreferencesConstants.AUTHORIZATION_TYPE_BASIC authorization type a password should be provided getAuthorizationPassword().
    
    Returns:
    
    The connection authorization type.
    
    See Also:
    
    PreferencesConstants.AUTHORIZATION_TYPE_NONE, PreferencesConstants.AUTHORIZATION_TYPE_BASIC, setAuthorizationType(java.lang.String), getAuthorizationPassword(), setAuthorizationPassword(java.lang.String)
  - getContact
```
java.lang.String getContact()
```
    Retrieves the Cloud Connector device contact setting.
    
    Returns:
    
    The Cloud Connector device contact setting, default value if not configured PreferencesConstants.DEFAULT_CONTACT ().
    
    See Also:
    
    PreferencesConstants.DEFAULT_CONTACT, setContact(java.lang.String)
  - getDescription
```
java.lang.String getDescription()
```
    Retrieves the Cloud Connector device description setting.
    
    Returns:
    
    The Cloud Connector device description setting, default value if not configured PreferencesConstants.DEFAULT_DESCRIPTION ().
    
    See Also:
    
    PreferencesConstants.DEFAULT_DESCRIPTION, setDescription(java.lang.String)
  - getDeviceID
```
java.lang.String getDeviceID()
```
    Retrieves the device's Device ID.
    This method should return null to use provisioning to get the Device ID.
    
    Returns:
    
    The device's Device ID.
  - getDeviceType
```
java.lang.String getDeviceType()
```
    Retrieves the device type.
    A null or empty string is an invalid value.
    
    The maximum length of this string is PreferencesConstants.DEVICE_TYPE_MAXIMUM_LENGTH ().
    
    Returns:
    
    The device type.
    
    See Also:
    
    PreferencesConstants.DEVICE_TYPE_MAXIMUM_LENGTH
  - getFileSystemRootDir
```
java.lang.String getFileSystemRootDir()
```
    Retrieves the file system root (sandbox) directory.
    
    Returns:
    
    The file system root (sandbox) directory.
    
    See Also:
    
    isFileSystemEnabled()
  - getFirmwareVersion
```
java.lang.String getFirmwareVersion()
```
    Retrieves the 4 digit firmware version of the system.
    This version will be used as Firmware Target 0x00 version if no firmware targets are provided (see IFirmwareUpdateImplementation.getFirmwareTargets()), if no firmware target 0x00 is defined or it is invalid.
    
    In these cases a virtual target 0x00 non-update-able will be generated using the version provided by this method.
    
    Target 0x00 represents the firmware that is running Cloud Connector.
    
    Returns:
    
    4 digit firmware version of the system as String.
  - getKeepAliveTime
```
int getKeepAliveTime()
```
    Retrieves the keep alive time setting value in seconds.
    The value should be:
    - time > PreferenceConstants.KEEP_ALIVE_MINIMUM_VALUE ()
    - time < PreferenceConstants.KEEP_ALIVE_MAXIMUM_VALUE ()
    Returns:
    
    Keep Alive time setting value, default value if not configured PreferencesConstants.DEFAULT_KEEP_ALIVE_TIME ().
    
    See Also:
    
    PreferencesConstants.DEFAULT_KEEP_ALIVE_TIME, setKeepAliveTime(int)
  - getLocation
```
java.lang.String getLocation()
```
    Retrieves the Cloud Connector device location setting.
    
    Returns:
    
    The Cloud Connector device location setting, default value if not configured PreferencesConstants.DEFAULT_LOCATION ().
    
    See Also:
    
    PreferencesConstants.DEFAULT_LOCATION, setLocation(java.lang.String)
  - getReconnectTime
```
int getReconnectTime()
```
    Retrieves the configured reconnect time delay setting in seconds.
    The value should be:
    - time > PreferenceConstants.RECONNECT_TIME_MINIMUM_VALUE ()
    - time < PreferenceConstants.RECONNECT_TIME_MAXIMUM_VALUE ()
    Returns:
    
    Reconnect time delay setting value, default value if not configured PreferencesConstants.DEFAULT_RECONNECT_TIME ()..
    
    See Also:
    
    PreferencesConstants.DEFAULT_RECONNECT_TIME, PreferencesConstants.RECONNECT_TIME_MINIMUM_VALUE, PreferencesConstants.RECONNECT_TIME_MAXIMUM_VALUE, PreferencesConstants.RECONNECT_TIME_MAX_RANDOM, setReconnectTime(int), isReconnectEnabled(), setReconnectEnabled(boolean)
  - getServerKeepAliveTime
```
int getServerKeepAliveTime()
```
    Retrieves the server keep alive time setting value in seconds.
    The value should be:
    - time > PreferenceConstants.KEEP_ALIVE_MINIMUM_VALUE ()
    - time < PreferenceConstants.KEEP_ALIVE_MAXIMUM_VALUE ()
    Returns:
    
    Server Keep Alive time setting value, default value if not configured PreferencesConstants.DEFAULT_SERVER_KEEP_ALIVE_TIME ().
    
    See Also:
    
    PreferencesConstants.DEFAULT_SERVER_KEEP_ALIVE_TIME, setServerKeepAliveTime(int)
  - getStaticLocation
```
Location getStaticLocation()
```
    Retrieves the static location to use.
    
    Returns:
    
    The static location to use.
    
    See Also:
    
    useStaticLocation(), setUseStaticLocation(boolean), setStaticLocation(com.etherios.connector.core.system.Location)
  - getURLString
```
java.lang.String getURLString()
```
    Retrieves the configured Cloud Connector URL preference.
    It should be PreferencesConstants.URL_US (PreferencesConstants.URL_US) or PreferencesConstants.URL_UK (PreferencesConstants.URL_UK).
    
    Returns:
    
    Cloud Connector URL setting value, null if not configured.
    
    See Also:
    
    PreferencesConstants.URL_US, PreferencesConstants.URL_UK, setURLString(java.lang.String)
  - getVendorID
```
byte[] getVendorID()
```
    Retrieves the device vendor ID.
    
    Returns:
    
    The device vendor ID, null if not configured.
  - getWaitTimes
```
int getWaitTimes()
```
    Retrieves the value of the wait times preference. This setting indicates the number of cycles to wait without receiving a keep alive packet before considering connection lost.
    The value should be:
    - times > PreferenceConstants.WAIT_TIMES_MINIMUM_VALUE ()
    - times < PreferenceConstants.WAIT_TIMES_MAXIMUM_VALUE ()
    Returns:
    
    Wait times setting value, default value PreferencesConstants.DEFAULT_WAIT_TIMES () if not configured.
    
    See Also:
    
    PreferencesConstants.DEFAULT_WAIT_TIMES, PreferencesConstants.WAIT_TIMES_MINIMUM_VALUE, PreferencesConstants.WAIT_TIMES_MAXIMUM_VALUE, setWaitTimes(int)
  - isCompressionEnabled
```
boolean isCompressionEnabled()
```
    Retrieves whether messages compression is enabled or not.
    The default value is returned if it is not configured PreferencesConstants.DEFAULT_ENABLE_COMPRESSION ().
    
    Returns:
    
    true if messages compression is enabled, false otherwise.
    
    See Also:
    
    PreferencesConstants.DEFAULT_ENABLE_COMPRESSION, setCompressionEnabled(boolean)
  - isDataServiceEnabled
```
boolean isDataServiceEnabled()
```
    Retrieves whether the data service is enabled or not.
    The default value is returned if it is not configured PreferencesConstants.DEFAULT_ENABLE_DATA_SERVICE ().
    
    Returns:
    
    true if the data service is enabled, false otherwise.
    
    See Also:
    
    PreferencesConstants.DEFAULT_ENABLE_DATA_SERVICE
  - isFileSystemEnabled
```
boolean isFileSystemEnabled()
```
    Retrieves whether file system should be enabled or not.
    The default value is returned if it is not configured PreferencesConstants.DEFAULT_ENABLE_FILE_SYSTEM ().
    
    Returns:
    
    true if file system is enabled, false otherwise.
    
    See Also:
    
    PreferencesConstants.DEFAULT_ENABLE_FILE_SYSTEM, getFileSystemRootDir()
  - isRCIEnabled
```
boolean isRCIEnabled()
```
    Retrieves whether the RCI facility is enabled or not.
    The default value is returned if it is not configured PreferencesConstants.DEFAULT_ENABLE_RCI ().
    
    Returns:
    
    true if RCI facility is enabled, false otherwise.
    
    See Also:
    
    PreferencesConstants.DEFAULT_ENABLE_RCI
  - isReconnectEnabled
```
boolean isReconnectEnabled()
```
    Retrieves whether reconnect setting is enabled or not.
    The default value is returned if it is not configured PreferencesConstants.DEFAULT_ENABLE_RECONNECT ().
    
    Returns:
    
    true if reconnect setting is configured, false otherwise.
    
    See Also:
    
    PreferencesConstants.DEFAULT_ENABLE_RECONNECT, setReconnectEnabled(boolean), getReconnectTime(), setReconnectTime(int)
  - isSecureConnectionEnabled
```
boolean isSecureConnectionEnabled()
```
    Retrieves whether secure connection is enabled or not.
    The default value is returned if it is not configured PreferencesConstants.DEFAULT_ENABLE_SECURE_CONNECTION ().
    
    Returns:
    
    true if secure connection is enabled, false otherwise.
    
    See Also:
    
    PreferencesConstants.DEFAULT_ENABLE_SECURE_CONNECTION, setSecureConnectionEnabled(boolean)
  - setAuthorizationPassword
```
void setAuthorizationPassword(java.lang.String password)
```
    Sets the authorization password setting new value. This is used if the authorization type is configured to PreferencesConstants.AUTHORIZATION_TYPE_BASIC ().
    
    Parameters:
    
    password - New value for the authorization password setting.
    
    See Also:
    
    PreferencesConstants.AUTHORIZATION_TYPE_NONE, PreferencesConstants.AUTHORIZATION_TYPE_BASIC, getAuthorizationPassword(), getAuthorizationType(), setAuthorizationType(java.lang.String)
  - setAuthorizationType
```
void setAuthorizationType(java.lang.String authorizationType)
```
    Sets the new value for the connection authorization type setting.
    It should be PreferencesConstants.AUTHORIZATION_TYPE_NONE or PreferencesConstants.AUTHORIZATION_TYPE_BASIC ().
    
    For the PreferencesConstants.AUTHORIZATION_TYPE_BASIC authorization type a password should be provided getAuthorizationPassword().
    
    Parameters:
    
    authorizationType - Value of connection authorization type.
    
    See Also:
    
    PreferencesConstants.AUTHORIZATION_TYPE_NONE, PreferencesConstants.AUTHORIZATION_TYPE_BASIC, getAuthorizationType(), getAuthorizationPassword(), setAuthorizationPassword(java.lang.String)
  - setCompressionEnabled
```
void setCompressionEnabled(boolean enabled)
```
    Sets the new value of the compress messages setting.
    
    Parameters:
    
    enabled - true to compress messages, false otherwise.
    
    See Also:
    
    isCompressionEnabled()
  - setContact
```
void setContact(java.lang.String contact)
```
    Sets the Cloud Connector device contact setting.
    
    Parameters:
    
    contact - The Cloud Connector device contact setting.
    
    See Also:
    
    getContact()
  - setDescription
```
void setDescription(java.lang.String description)
```
    Sets the Cloud Connector device description setting.
    
    Parameters:
    
    description - The Cloud Connector device description setting.
    
    See Also:
    
    getDescription()
  - setDeviceID
```
void setDeviceID(java.lang.String deviceID)
```
    Stores the device ID. Usually this method is called from device ID provisioning system when device reports a null device ID.
    
    Parameters:
    
    deviceID - Device ID to store.
  - setKeepAliveTime
```
void setKeepAliveTime(int time)
```
    Sets the new value for the Keep Alive time setting in seconds.
    The value should be:
    - time > PreferenceConstants.KEEP_ALIVE_MINIMUM_VALUE ()
    - time < PreferenceConstants.KEEP_ALIVE_MAXIMUM_VALUE ()
    Parameters:
    
    time - New value for the Keep Alive time setting.
    
    See Also:
    
    PreferencesConstants.DEFAULT_KEEP_ALIVE_TIME, PreferencesConstants.KEEP_ALIVE_MINIMUM_VALUE, PreferencesConstants.KEEP_ALIVE_MAXIMUM_VALUE, getKeepAliveTime()
  - setLocation
```
void setLocation(java.lang.String location)
```
    Sets the Cloud Connector device location setting.
    
    Parameters:
    
    location - The Cloud Connector device location setting.
    
    See Also:
    
    getLocation()
  - setReconnectEnabled
```
void setReconnectEnabled(boolean enabled)
```
    Sets the new value of the reconnect setting.
    
    Parameters:
    
    enabled - true to enable reconnect, false otherwise.
    
    See Also:
    
    isReconnectEnabled(), getReconnectTime(), setReconnectTime(int)
  - setReconnectTime
```
void setReconnectTime(int time)
```
    Sets the new value for the reconnect time setting in seconds.
    The value should be:
    - time > PreferenceConstants.RECONNECT_TIME_MINIMUM_VALUE ()
    - time < PreferenceConstants.RECONNECT_TIME_MAXIMUM_VALUE ()
    Parameters:
    
    time - New value for the reconnect time setting.
    
    See Also:
    
    PreferencesConstants.DEFAULT_RECONNECT_TIME, PreferencesConstants.RECONNECT_TIME_MINIMUM_VALUE, PreferencesConstants.RECONNECT_TIME_MAXIMUM_VALUE, PreferencesConstants.RECONNECT_TIME_MAX_RANDOM, getReconnectTime(), isReconnectEnabled(), setReconnectEnabled(boolean)
  - setSecureConnectionEnabled
```
void setSecureConnectionEnabled(boolean value)
```
    Sets the new value for the use secure connection setting.
    
    Parameters:
    
    value - true to enable secure connection, false otherwise.
    
    See Also:
    
    isSecureConnectionEnabled()
  - setServerKeepAliveTime
```
void setServerKeepAliveTime(int time)
```
    Sets the new value for the Server Keep Alive time setting in seconds.
    The value should be:
    - time > PreferenceConstants.KEEP_ALIVE_MINIMUM_VALUE ()
    - time < PreferenceConstants.KEEP_ALIVE_MAXIMUM_VALUE ()
    Parameters:
    
    time - New value for the Server Keep Alive time setting.
    
    See Also:
    
    PreferencesConstants.DEFAULT_SERVER_KEEP_ALIVE_TIME, getServerKeepAliveTime()
  - setStaticLocation
```
void setStaticLocation(Location location)
```
    Sets the value of the static location.
    
    Parameters:
    
    location - The static location value.
    
    See Also:
    
    useStaticLocation(), setUseStaticLocation(boolean), getStaticLocation()
  - setURLString
```
void setURLString(java.lang.String url)
```
    Sets the Cloud Connector URL preference.
    It should be PreferencesConstants.URL_US (PreferencesConstants.URL_US) or PreferencesConstants.URL_UK (PreferencesConstants.URL_UK).
    
    Parameters:
    
    url - The new Cloud Connector URL.
    
    See Also:
    
    PreferencesConstants.URL_US, PreferencesConstants.URL_UK, getURLString()
  - setUseStaticLocation
```
void setUseStaticLocation(boolean useStaticLocation)
```
    Sets the value of use static location preference.
    
    Parameters:
    
    useStaticLocation - true to use static location, false otherwise.
    
    See Also:
    
    useStaticLocation(), getStaticLocation(), setStaticLocation(com.etherios.connector.core.system.Location)
  - setVendorID
```
void setVendorID(java.lang.String vendorID)
```
    Sets the Cloud Connector Vendor ID setting.
    
    Parameters:
    
    vendorID - The Cloud Connector VendorID setting.
  - setWaitTimes
```
void setWaitTimes(int waitTimes)
```
    Sets the new value for the wait times setting. This setting indicates the number of cycles to wait without receiving a keep alive packet before considering connection lost.
    The value should be:
    - times > PreferenceConstants.WAIT_TIMES_MINIMUM_VALUE ()
    - times < PreferenceConstants.WAIT_TIMES_MAXIMUM_VALUE ()
    Parameters:
    
    waitTimes - New value of the wait times setting.
    
    See Also:
    
    PreferencesConstants.WAIT_TIMES_MINIMUM_VALUE, PreferencesConstants.WAIT_TIMES_MAXIMUM_VALUE, getWaitTimes()
  - useStaticLocation
```
boolean useStaticLocation()
```
    Retrieves whether static location will be used or not.
    The default value is returned if it is not configured PreferencesConstants.DEFAULT_USE_STATIC_LOCATION ().
    
    Returns:
    
    true if static location will be used, false otherwise.
    
    See Also:
    
    PreferencesConstants.DEFAULT_USE_STATIC_LOCATION, setUseStaticLocation(boolean), getStaticLocation(), setStaticLocation(com.etherios.connector.core.system.Location)

Interface IConnectorPreferences

Method Summary

Method Detail

getAuthorizationPassword

getAuthorizationType

getContact

getDescription

getDeviceID

getDeviceType

getFileSystemRootDir

getFirmwareVersion

getKeepAliveTime

getLocation

getReconnectTime

getServerKeepAliveTime

getStaticLocation

getURLString

getVendorID

getWaitTimes

isCompressionEnabled

isDataServiceEnabled

isFileSystemEnabled

isRCIEnabled

isReconnectEnabled

isSecureConnectionEnabled

setAuthorizationPassword

setAuthorizationType

setCompressionEnabled

setContact

setDescription

setDeviceID

setKeepAliveTime

setLocation

setReconnectEnabled

setReconnectTime

setSecureConnectionEnabled

setServerKeepAliveTime

setStaticLocation

setURLString

setUseStaticLocation

setVendorID

setWaitTimes

useStaticLocation