PreferencesManager (Etherios Cloud Connector for Java ME)

java.lang.Object
- com.etherios.connector.preferences.PreferencesManager

All Implemented Interfaces:

IConnectorPreferences
```
public class PreferencesManager
extends java.lang.Object
implements IConnectorPreferences
```
Implementation of the interface IConnectorPreferences to get all the configuration settings that Cloud Connector requires.
This class uses an instance of ConfigurationManager class to try to get the parameters from the record store, if they are not found it tries to read them from the configuration file (connector_config.txt). It also stores the given values in the record store as preferences in the device.

If any other method or strategy is going to be provided to get/set the values, this class might be extended to override the methods getParameterValue(java.lang.String) and setParameterValue(java.lang.String, java.lang.String).

See Also:

IConnectorPreferences, PreferencesConstants, ConfigurationManager

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`DEFAULT_DEVICE_ID_TYPE` Default value for 'Device ID type' setting: "provisioning".
`static java.lang.String`	`DEFAULT_STORAGE_DIR` Default storage directory path: "/fs".
`static java.lang.String`	`DEVICE_ID_TYPE_IMEI` 'Device ID' is calculated based on the device IMEI.
`static java.lang.String`	`DEVICE_ID_TYPE_MAC` 'Device ID' is calculated based on the device MAC Address.
`static java.lang.String`	`DEVICE_ID_TYPE_PROVISIONING` 'Device ID' is calculated by provisioning, Device Cloud will provide a valid ID.
`static java.lang.String`	`DEVICE_ID_TYPE_STATIC` 'Device ID' is a static value already configured.
`static java.lang.String`	`PARAM_DEVICE_ID_TYPE` 'Device ID type' setting name: "device_id_type".

Constructor Summary

Constructors
Constructor and Description
`PreferencesManager(IPlatformCustomization platformCustomization)` Class constructor.
`PreferencesManager(IPlatformCustomization platformCustomization, java.lang.String configFile)` Class constructor.

Method Summary

All Methods Instance Methods Concrete 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.
`java.lang.String`	`getParameterValue(java.lang.String parameter)` Retrieves the value of the given parameter name.
`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 authorizationPassword)` 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 compressionEnabled)` 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 keepAliveTime)` 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`	`setParameterValue(java.lang.String parameter, java.lang.String value)` Sets the given parameter value.
`void`	`setReconnectEnabled(boolean reconnectEnabled)` Sets the new value of the reconnect setting.
`void`	`setReconnectTime(int reconnectTime)` Sets the new value for the reconnect time setting in seconds.
`void`	`setSecureConnectionEnabled(boolean secureConnectionEnabled)` Sets the new value for the use secure connection setting.
`void`	`setServerKeepAliveTime(int keepAliveTime)` 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.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_DEVICE_ID_TYPE
```
public static final java.lang.String DEFAULT_DEVICE_ID_TYPE
```
    Default value for 'Device ID type' setting: "provisioning".
    
    See Also:
    
    PARAM_DEVICE_ID_TYPE, DEVICE_ID_TYPE_MAC, DEVICE_ID_TYPE_IMEI, DEVICE_ID_TYPE_PROVISIONING, DEVICE_ID_TYPE_STATIC, Constant Field Values
  - DEFAULT_STORAGE_DIR
```
public static final java.lang.String DEFAULT_STORAGE_DIR
```
    Default storage directory path: "/fs".
    
    See Also:
    
    PreferencesConstants.PARAM_STORAGE_DIR, PreferencesConstants.PARAM_ENABLE_FILE_SYSTEM, Constant Field Values
  - DEVICE_ID_TYPE_IMEI
```
public static final java.lang.String DEVICE_ID_TYPE_IMEI
```
    'Device ID' is calculated based on the device IMEI.
    The value of this constant is "imei".
    
    See Also:
    
    PARAM_DEVICE_ID_TYPE, DEVICE_ID_TYPE_MAC, DEVICE_ID_TYPE_PROVISIONING, DEVICE_ID_TYPE_STATIC, PreferencesConstants.PARAM_DEVICE_ID, Constant Field Values
  - DEVICE_ID_TYPE_MAC
```
public static final java.lang.String DEVICE_ID_TYPE_MAC
```
    'Device ID' is calculated based on the device MAC Address.
    The value of this constant is "mac".
    
    See Also:
    
    PARAM_DEVICE_ID_TYPE, DEVICE_ID_TYPE_IMEI, DEVICE_ID_TYPE_PROVISIONING, DEVICE_ID_TYPE_STATIC, PreferencesConstants.PARAM_DEVICE_ID, Constant Field Values
  - DEVICE_ID_TYPE_PROVISIONING
```
public static final java.lang.String DEVICE_ID_TYPE_PROVISIONING
```
    'Device ID' is calculated by provisioning, Device Cloud will provide a valid ID.
    The value of this constant is "provisioning".
    
    See Also:
    
    PARAM_DEVICE_ID_TYPE, DEVICE_ID_TYPE_MAC, DEVICE_ID_TYPE_IMEI, DEVICE_ID_TYPE_STATIC, PreferencesConstants.PARAM_DEVICE_ID, Constant Field Values
  - DEVICE_ID_TYPE_STATIC
```
public static final java.lang.String DEVICE_ID_TYPE_STATIC
```
    'Device ID' is a static value already configured.
    The value of this constant is "static".
    
    See Also:
    
    PARAM_DEVICE_ID_TYPE, DEVICE_ID_TYPE_MAC, DEVICE_ID_TYPE_IMEI, DEVICE_ID_TYPE_PROVISIONING, PreferencesConstants.PARAM_DEVICE_ID, Constant Field Values
  - PARAM_DEVICE_ID_TYPE
```
public static final java.lang.String PARAM_DEVICE_ID_TYPE
```
    'Device ID type' setting name: "device_id_type".
    
    See Also:
    
    DEVICE_ID_TYPE_MAC, DEVICE_ID_TYPE_IMEI, DEVICE_ID_TYPE_PROVISIONING, DEVICE_ID_TYPE_STATIC, DEFAULT_DEVICE_ID_TYPE, Constant Field Values
- Constructor Detail
  - PreferencesManager
```
public PreferencesManager(IPlatformCustomization platformCustomization)
```
    Class constructor. Instances a new Preferences Manager object with the given Platform customization.
    
    Parameters:
    
    platformCustomization - Platform customization to read and set some preference values.
  - PreferencesManager
```
public PreferencesManager(IPlatformCustomization platformCustomization,
                          java.lang.String configFile)
```
    Class constructor. Instances a new Preferences Manager object with the given Platform customization and the given Cloud Connector configuration file.
    
    Parameters:
    
    platformCustomization - Platform customization to read and set some preference values.
    
    configFile - Path of the Cloud Connector configuration file.
- Method Detail
  - getAuthorizationPassword
```
public java.lang.String getAuthorizationPassword()
```
    Description copied from interface: IConnectorPreferences
    
    Retrieves the authorization password setting value if the authorization type is configured to PreferencesConstants.AUTHORIZATION_TYPE_BASIC ().
    
    Specified by:
    
    getAuthorizationPassword in interface IConnectorPreferences
    
    Returns:
    
    Authorization password setting value.
    
    See Also:
    
    PreferencesConstants.AUTHORIZATION_TYPE_BASIC, IConnectorPreferences.setAuthorizationPassword(java.lang.String), IConnectorPreferences.getAuthorizationType(), IConnectorPreferences.setAuthorizationType(java.lang.String)
  - getAuthorizationType
```
public java.lang.String getAuthorizationType()
```
    Description copied from interface: IConnectorPreferences
    
    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 IConnectorPreferences.getAuthorizationPassword().
    
    Specified by:
    
    getAuthorizationType in interface IConnectorPreferences
    
    Returns:
    
    The connection authorization type.
    
    See Also:
    
    PreferencesConstants.AUTHORIZATION_TYPE_NONE, PreferencesConstants.AUTHORIZATION_TYPE_BASIC, IConnectorPreferences.setAuthorizationType(java.lang.String), IConnectorPreferences.getAuthorizationPassword(), IConnectorPreferences.setAuthorizationPassword(java.lang.String)
  - getContact
```
public java.lang.String getContact()
```
    Description copied from interface: IConnectorPreferences
    
    Retrieves the Cloud Connector device contact setting.
    
    Specified by:
    
    getContact in interface IConnectorPreferences
    
    Returns:
    
    The Cloud Connector device contact setting, default value if not configured PreferencesConstants.DEFAULT_CONTACT ().
    
    See Also:
    
    PreferencesConstants.DEFAULT_CONTACT, IConnectorPreferences.setContact(java.lang.String)
  - getDescription
```
public java.lang.String getDescription()
```
    Description copied from interface: IConnectorPreferences
    
    Retrieves the Cloud Connector device description setting.
    
    Specified by:
    
    getDescription in interface IConnectorPreferences
    
    Returns:
    
    The Cloud Connector device description setting, default value if not configured PreferencesConstants.DEFAULT_DESCRIPTION ().
    
    See Also:
    
    PreferencesConstants.DEFAULT_DESCRIPTION, IConnectorPreferences.setDescription(java.lang.String)
  - getDeviceID
```
public java.lang.String getDeviceID()
```
    Description copied from interface: IConnectorPreferences
    
    Retrieves the device's Device ID.
    This method should return null to use provisioning to get the Device ID.
    
    Specified by:
    
    getDeviceID in interface IConnectorPreferences
    
    Returns:
    
    The device's Device ID.
  - getDeviceType
```
public java.lang.String getDeviceType()
```
    Description copied from interface: IConnectorPreferences
    
    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 ().
    
    Specified by:
    
    getDeviceType in interface IConnectorPreferences
    
    Returns:
    
    The device type.
    
    See Also:
    
    PreferencesConstants.DEVICE_TYPE_MAXIMUM_LENGTH
  - getFileSystemRootDir
```
public java.lang.String getFileSystemRootDir()
```
    Description copied from interface: IConnectorPreferences
    
    Retrieves the file system root (sandbox) directory.
    
    Specified by:
    
    getFileSystemRootDir in interface IConnectorPreferences
    
    Returns:
    
    The file system root (sandbox) directory.
    
    See Also:
    
    IConnectorPreferences.isFileSystemEnabled()
  - getFirmwareVersion
```
public java.lang.String getFirmwareVersion()
```
    Description copied from interface: IConnectorPreferences
    
    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.
    
    Specified by:
    
    getFirmwareVersion in interface IConnectorPreferences
    
    Returns:
    
    4 digit firmware version of the system as String.
  - getKeepAliveTime
```
public int getKeepAliveTime()
```
    Description copied from interface: IConnectorPreferences
    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 ()
    Specified by:
    
    getKeepAliveTime in interface IConnectorPreferences
    
    Returns:
    
    Keep Alive time setting value, default value if not configured PreferencesConstants.DEFAULT_KEEP_ALIVE_TIME ().
    
    See Also:
    
    PreferencesConstants.DEFAULT_KEEP_ALIVE_TIME, IConnectorPreferences.setKeepAliveTime(int)
  - getLocation
```
public java.lang.String getLocation()
```
    Description copied from interface: IConnectorPreferences
    
    Retrieves the Cloud Connector device location setting.
    
    Specified by:
    
    getLocation in interface IConnectorPreferences
    
    Returns:
    
    The Cloud Connector device location setting, default value if not configured PreferencesConstants.DEFAULT_LOCATION ().
    
    See Also:
    
    PreferencesConstants.DEFAULT_LOCATION, IConnectorPreferences.setLocation(java.lang.String)
  - 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 or null if the configuration file does not exists, if it cannot be read or if the parameter is not defined.
  - getReconnectTime
```
public int getReconnectTime()
```
    Description copied from interface: IConnectorPreferences
    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 ()
    Specified by:
    
    getReconnectTime in interface IConnectorPreferences
    
    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, IConnectorPreferences.setReconnectTime(int), IConnectorPreferences.isReconnectEnabled(), IConnectorPreferences.setReconnectEnabled(boolean)
  - getServerKeepAliveTime
```
public int getServerKeepAliveTime()
```
    Description copied from interface: IConnectorPreferences
    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 ()
    Specified by:
    
    getServerKeepAliveTime in interface IConnectorPreferences
    
    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, IConnectorPreferences.setServerKeepAliveTime(int)
  - getStaticLocation
```
public Location getStaticLocation()
```
    Description copied from interface: IConnectorPreferences
    
    Retrieves the static location to use.
    
    Specified by:
    
    getStaticLocation in interface IConnectorPreferences
    
    Returns:
    
    The static location to use.
    
    See Also:
    
    IConnectorPreferences.useStaticLocation(), IConnectorPreferences.setUseStaticLocation(boolean), IConnectorPreferences.setStaticLocation(com.etherios.connector.core.system.Location)
  - getURLString
```
public java.lang.String getURLString()
```
    Description copied from interface: IConnectorPreferences
    
    Retrieves the configured Cloud Connector URL preference.
    It should be PreferencesConstants.URL_US (PreferencesConstants.URL_US) or PreferencesConstants.URL_UK (PreferencesConstants.URL_UK).
    
    Specified by:
    
    getURLString in interface IConnectorPreferences
    
    Returns:
    
    Cloud Connector URL setting value, null if not configured.
    
    See Also:
    
    PreferencesConstants.URL_US, PreferencesConstants.URL_UK, IConnectorPreferences.setURLString(java.lang.String)
  - getVendorID
```
public byte[] getVendorID()
```
    Description copied from interface: IConnectorPreferences
    
    Retrieves the device vendor ID.
    
    Specified by:
    
    getVendorID in interface IConnectorPreferences
    
    Returns:
    
    The device vendor ID, null if not configured.
  - getWaitTimes
```
public int getWaitTimes()
```
    Description copied from interface: IConnectorPreferences
    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 ()
    Specified by:
    
    getWaitTimes in interface IConnectorPreferences
    
    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, IConnectorPreferences.setWaitTimes(int)
  - isCompressionEnabled
```
public boolean isCompressionEnabled()
```
    Description copied from interface: IConnectorPreferences
    
    Retrieves whether messages compression is enabled or not.
    The default value is returned if it is not configured PreferencesConstants.DEFAULT_ENABLE_COMPRESSION ().
    
    Specified by:
    
    isCompressionEnabled in interface IConnectorPreferences
    
    Returns:
    
    true if messages compression is enabled, false otherwise.
    
    See Also:
    
    PreferencesConstants.DEFAULT_ENABLE_COMPRESSION, IConnectorPreferences.setCompressionEnabled(boolean)
  - isDataServiceEnabled
```
public boolean isDataServiceEnabled()
```
    Description copied from interface: IConnectorPreferences
    
    Retrieves whether the data service is enabled or not.
    The default value is returned if it is not configured PreferencesConstants.DEFAULT_ENABLE_DATA_SERVICE ().
    
    Specified by:
    
    isDataServiceEnabled in interface IConnectorPreferences
    
    Returns:
    
    true if the data service is enabled, false otherwise.
    
    See Also:
    
    PreferencesConstants.DEFAULT_ENABLE_DATA_SERVICE
  - isFileSystemEnabled
```
public boolean isFileSystemEnabled()
```
    Description copied from interface: IConnectorPreferences
    
    Retrieves whether file system should be enabled or not.
    The default value is returned if it is not configured PreferencesConstants.DEFAULT_ENABLE_FILE_SYSTEM ().
    
    Specified by:
    
    isFileSystemEnabled in interface IConnectorPreferences
    
    Returns:
    
    true if file system is enabled, false otherwise.
    
    See Also:
    
    PreferencesConstants.DEFAULT_ENABLE_FILE_SYSTEM, IConnectorPreferences.getFileSystemRootDir()
  - isRCIEnabled
```
public boolean isRCIEnabled()
```
    Description copied from interface: IConnectorPreferences
    
    Retrieves whether the RCI facility is enabled or not.
    The default value is returned if it is not configured PreferencesConstants.DEFAULT_ENABLE_RCI ().
    
    Specified by:
    
    isRCIEnabled in interface IConnectorPreferences
    
    Returns:
    
    true if RCI facility is enabled, false otherwise.
    
    See Also:
    
    PreferencesConstants.DEFAULT_ENABLE_RCI
  - isReconnectEnabled
```
public boolean isReconnectEnabled()
```
    Description copied from interface: IConnectorPreferences
    
    Retrieves whether reconnect setting is enabled or not.
    The default value is returned if it is not configured PreferencesConstants.DEFAULT_ENABLE_RECONNECT ().
    
    Specified by:
    
    isReconnectEnabled in interface IConnectorPreferences
    
    Returns:
    
    true if reconnect setting is configured, false otherwise.
    
    See Also:
    
    PreferencesConstants.DEFAULT_ENABLE_RECONNECT, IConnectorPreferences.setReconnectEnabled(boolean), IConnectorPreferences.getReconnectTime(), IConnectorPreferences.setReconnectTime(int)
  - isSecureConnectionEnabled
```
public boolean isSecureConnectionEnabled()
```
    Description copied from interface: IConnectorPreferences
    
    Retrieves whether secure connection is enabled or not.
    The default value is returned if it is not configured PreferencesConstants.DEFAULT_ENABLE_SECURE_CONNECTION ().
    
    Specified by:
    
    isSecureConnectionEnabled in interface IConnectorPreferences
    
    Returns:
    
    true if secure connection is enabled, false otherwise.
    
    See Also:
    
    PreferencesConstants.DEFAULT_ENABLE_SECURE_CONNECTION, IConnectorPreferences.setSecureConnectionEnabled(boolean)
  - setAuthorizationPassword
```
public void setAuthorizationPassword(java.lang.String authorizationPassword)
```
    Description copied from interface: IConnectorPreferences
    
    Sets the authorization password setting new value. This is used if the authorization type is configured to PreferencesConstants.AUTHORIZATION_TYPE_BASIC ().
    
    Specified by:
    
    setAuthorizationPassword in interface IConnectorPreferences
    
    Parameters:
    
    authorizationPassword - New value for the authorization password setting.
    
    See Also:
    
    PreferencesConstants.AUTHORIZATION_TYPE_NONE, PreferencesConstants.AUTHORIZATION_TYPE_BASIC, IConnectorPreferences.getAuthorizationPassword(), IConnectorPreferences.getAuthorizationType(), IConnectorPreferences.setAuthorizationType(java.lang.String)
  - setAuthorizationType
```
public void setAuthorizationType(java.lang.String authorizationType)
```
    Description copied from interface: IConnectorPreferences
    
    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 IConnectorPreferences.getAuthorizationPassword().
    
    Specified by:
    
    setAuthorizationType in interface IConnectorPreferences
    
    Parameters:
    
    authorizationType - Value of connection authorization type.
    
    See Also:
    
    PreferencesConstants.AUTHORIZATION_TYPE_NONE, PreferencesConstants.AUTHORIZATION_TYPE_BASIC, IConnectorPreferences.getAuthorizationType(), IConnectorPreferences.getAuthorizationPassword(), IConnectorPreferences.setAuthorizationPassword(java.lang.String)
  - setCompressionEnabled
```
public void setCompressionEnabled(boolean compressionEnabled)
```
    Description copied from interface: IConnectorPreferences
    
    Sets the new value of the compress messages setting.
    
    Specified by:
    
    setCompressionEnabled in interface IConnectorPreferences
    
    Parameters:
    
    compressionEnabled - true to compress messages, false otherwise.
    
    See Also:
    
    IConnectorPreferences.isCompressionEnabled()
  - setContact
```
public void setContact(java.lang.String contact)
```
    Description copied from interface: IConnectorPreferences
    
    Sets the Cloud Connector device contact setting.
    
    Specified by:
    
    setContact in interface IConnectorPreferences
    
    Parameters:
    
    contact - The Cloud Connector device contact setting.
    
    See Also:
    
    IConnectorPreferences.getContact()
  - setDescription
```
public void setDescription(java.lang.String description)
```
    Description copied from interface: IConnectorPreferences
    
    Sets the Cloud Connector device description setting.
    
    Specified by:
    
    setDescription in interface IConnectorPreferences
    
    Parameters:
    
    description - The Cloud Connector device description setting.
    
    See Also:
    
    IConnectorPreferences.getDescription()
  - setDeviceID
```
public void setDeviceID(java.lang.String deviceID)
```
    Description copied from interface: IConnectorPreferences
    
    Stores the device ID. Usually this method is called from device ID provisioning system when device reports a null device ID.
    
    Specified by:
    
    setDeviceID in interface IConnectorPreferences
    
    Parameters:
    
    deviceID - Device ID to store.
  - setKeepAliveTime
```
public void setKeepAliveTime(int keepAliveTime)
```
    Description copied from interface: IConnectorPreferences
    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 ()
    Specified by:
    
    setKeepAliveTime in interface IConnectorPreferences
    
    Parameters:
    
    keepAliveTime - 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, IConnectorPreferences.getKeepAliveTime()
  - setLocation
```
public void setLocation(java.lang.String location)
```
    Description copied from interface: IConnectorPreferences
    
    Sets the Cloud Connector device location setting.
    
    Specified by:
    
    setLocation in interface IConnectorPreferences
    
    Parameters:
    
    location - The Cloud Connector device location setting.
    
    See Also:
    
    IConnectorPreferences.getLocation()
  - setParameterValue
```
public void setParameterValue(java.lang.String parameter,
                              java.lang.String value)
```
    Sets the given parameter value.
    
    Parameters:
    
    parameter - The parameter name to be configured.
    
    value - A string that represents the value of the given parameter.
  - setReconnectEnabled
```
public void setReconnectEnabled(boolean reconnectEnabled)
```
    Description copied from interface: IConnectorPreferences
    
    Sets the new value of the reconnect setting.
    
    Specified by:
    
    setReconnectEnabled in interface IConnectorPreferences
    
    Parameters:
    
    reconnectEnabled - true to enable reconnect, false otherwise.
    
    See Also:
    
    IConnectorPreferences.isReconnectEnabled(), IConnectorPreferences.getReconnectTime(), IConnectorPreferences.setReconnectTime(int)
  - setReconnectTime
```
public void setReconnectTime(int reconnectTime)
```
    Description copied from interface: IConnectorPreferences
    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 ()
    Specified by:
    
    setReconnectTime in interface IConnectorPreferences
    
    Parameters:
    
    reconnectTime - 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, IConnectorPreferences.getReconnectTime(), IConnectorPreferences.isReconnectEnabled(), IConnectorPreferences.setReconnectEnabled(boolean)
  - setSecureConnectionEnabled
```
public void setSecureConnectionEnabled(boolean secureConnectionEnabled)
```
    Description copied from interface: IConnectorPreferences
    
    Sets the new value for the use secure connection setting.
    
    Specified by:
    
    setSecureConnectionEnabled in interface IConnectorPreferences
    
    Parameters:
    
    secureConnectionEnabled - true to enable secure connection, false otherwise.
    
    See Also:
    
    IConnectorPreferences.isSecureConnectionEnabled()
  - setServerKeepAliveTime
```
public void setServerKeepAliveTime(int keepAliveTime)
```
    Description copied from interface: IConnectorPreferences
    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 ()
    Specified by:
    
    setServerKeepAliveTime in interface IConnectorPreferences
    
    Parameters:
    
    keepAliveTime - New value for the Server Keep Alive time setting.
    
    See Also:
    
    PreferencesConstants.DEFAULT_SERVER_KEEP_ALIVE_TIME, IConnectorPreferences.getServerKeepAliveTime()
  - setStaticLocation
```
public void setStaticLocation(Location location)
```
    Description copied from interface: IConnectorPreferences
    
    Sets the value of the static location.
    
    Specified by:
    
    setStaticLocation in interface IConnectorPreferences
    
    Parameters:
    
    location - The static location value.
    
    See Also:
    
    IConnectorPreferences.useStaticLocation(), IConnectorPreferences.setUseStaticLocation(boolean), IConnectorPreferences.getStaticLocation()
  - setURLString
```
public void setURLString(java.lang.String url)
```
    Description copied from interface: IConnectorPreferences
    
    Sets the Cloud Connector URL preference.
    It should be PreferencesConstants.URL_US (PreferencesConstants.URL_US) or PreferencesConstants.URL_UK (PreferencesConstants.URL_UK).
    
    Specified by:
    
    setURLString in interface IConnectorPreferences
    
    Parameters:
    
    url - The new Cloud Connector URL.
    
    See Also:
    
    PreferencesConstants.URL_US, PreferencesConstants.URL_UK, IConnectorPreferences.getURLString()
  - setUseStaticLocation
```
public void setUseStaticLocation(boolean useStaticLocation)
```
    Description copied from interface: IConnectorPreferences
    
    Sets the value of use static location preference.
    
    Specified by:
    
    setUseStaticLocation in interface IConnectorPreferences
    
    Parameters:
    
    useStaticLocation - true to use static location, false otherwise.
    
    See Also:
    
    IConnectorPreferences.useStaticLocation(), IConnectorPreferences.getStaticLocation(), IConnectorPreferences.setStaticLocation(com.etherios.connector.core.system.Location)
  - setVendorID
```
public void setVendorID(java.lang.String vendorID)
```
    Description copied from interface: IConnectorPreferences
    
    Sets the Cloud Connector Vendor ID setting.
    
    Specified by:
    
    setVendorID in interface IConnectorPreferences
    
    Parameters:
    
    vendorID - The Cloud Connector VendorID setting.
  - setWaitTimes
```
public void setWaitTimes(int waitTimes)
```
    Description copied from interface: IConnectorPreferences
    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 ()
    Specified by:
    
    setWaitTimes in interface IConnectorPreferences
    
    Parameters:
    
    waitTimes - New value of the wait times setting.
    
    See Also:
    
    PreferencesConstants.WAIT_TIMES_MINIMUM_VALUE, PreferencesConstants.WAIT_TIMES_MAXIMUM_VALUE, IConnectorPreferences.getWaitTimes()
  - useStaticLocation
```
public boolean useStaticLocation()
```
    Description copied from interface: IConnectorPreferences
    
    Retrieves whether static location will be used or not.
    The default value is returned if it is not configured PreferencesConstants.DEFAULT_USE_STATIC_LOCATION ().
    
    Specified by:
    
    useStaticLocation in interface IConnectorPreferences
    
    Returns:
    
    true if static location will be used, false otherwise.
    
    See Also:
    
    PreferencesConstants.DEFAULT_USE_STATIC_LOCATION, IConnectorPreferences.setUseStaticLocation(boolean), IConnectorPreferences.getStaticLocation(), IConnectorPreferences.setStaticLocation(com.etherios.connector.core.system.Location)

Class PreferencesManager

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_DEVICE_ID_TYPE

DEFAULT_STORAGE_DIR

DEVICE_ID_TYPE_IMEI

DEVICE_ID_TYPE_MAC

DEVICE_ID_TYPE_PROVISIONING

DEVICE_ID_TYPE_STATIC

PARAM_DEVICE_ID_TYPE

Constructor Detail

PreferencesManager

PreferencesManager

Method Detail

getAuthorizationPassword

getAuthorizationType

getContact

getDescription

getDeviceID

getDeviceType

getFileSystemRootDir

getFirmwareVersion

getKeepAliveTime

getLocation

getParameterValue

getReconnectTime

getServerKeepAliveTime

getStaticLocation

getURLString

getVendorID

getWaitTimes

isCompressionEnabled

isDataServiceEnabled

isFileSystemEnabled

isRCIEnabled

isReconnectEnabled

isSecureConnectionEnabled

setAuthorizationPassword

setAuthorizationType

setCompressionEnabled

setContact

setDescription

setDeviceID

setKeepAliveTime

setLocation

setParameterValue

setReconnectEnabled

setReconnectTime

setSecureConnectionEnabled

setServerKeepAliveTime

setStaticLocation

setURLString

setUseStaticLocation

setVendorID

setWaitTimes

useStaticLocation