com.etherios.connector.log

Class DefaultConnectorLogger

java.lang.Object

com.etherios.connector.core.log.ConnectorLogger

com.etherios.connector.log.DefaultConnectorLogger

public class DefaultConnectorLogger
extends ConnectorLogger

This class takes care of logging all Cloud Connector events and messages in the device.

It adds some extra configuration to allow the configuration of the log output through the standard output (console), to be written in a file (file) or both at the same time (both).

This parameter and the rest of the configuration for the logger are read from the record store or from the Cloud Connector configuration file (connector_config.txt) using the methods in the class PreferencesManager.

Some of the logger parameters are defined in the PreferencesConstants class.

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:

ConnectorLogger, PreferencesConstants, PreferencesManager

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	LOG_BOTH Log messages will be sent to the standard output and to a log file as described for LOG_FILE.
static java.lang.String	LOG_CONSOLE Log messages will be sent to the standard output.
static java.lang.String	LOG_FILE Log messages will be sent to a file located in the 'storage_dir' property.
static java.lang.String	LOG_TAG 'Log tag' setting name: "log_tag".
static java.lang.String	PARAM_LOG_OUTPUT 'Log output' setting name: "log_output".

Constructor Summary

Constructors

Constructor and Description
DefaultConnectorLogger(PreferencesManager preferencesManager) Class constructor.
DefaultConnectorLogger(PreferencesManager preferencesManager, java.lang.String configFile) Class constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getLogFilePath() Returns the log file path.
java.lang.String	getParameterValue(java.lang.String parameter) Retrieves the value of the given parameter name.
boolean	isLoggingToConsole() Returns true if logging to console, false otherwise.
boolean	isLoggingToFile() Returns true if logging to file, false otherwise.
boolean	logConnectionEvents() Retrieves whether connection events should be logged or not.
boolean	logDataPointEvents() Retrieves whether data point events should be logged or not.
boolean	logDataPushEvents() Retrieves whether data push events should be logged or not.
boolean	logDebugMessages() Retrieves whether to log debug level messages or not.
boolean	logDeviceRequestEvents() Retrieves whether device request events should be logged or not.
boolean	logErrorMessages() Retrieves whether to log error level messages or not.
void	logException(java.lang.Exception e) Logs the given exception.
boolean	logExceptions() Retrieves whether to log exceptions or not.
boolean	logFileSystemEvents() Retrieves whether file system events should be logged or not.
boolean	logFirmwareEvents() Retrieves whether firmware events should be logged or not.
boolean	logInformationMessages() Retrieves whether to log information level messages or not.
boolean	logPackets() Retrieves whether to log EDP packets or not.
boolean	logRCIEvents() Retrieves whether RCI events should be logged or not.
boolean	logSystemEvents() Retrieves whether system events should be logged or not.
void	setParameterValue(java.lang.String parameter, java.lang.String value) Sets the given parameter value.
void	stopLogging() Stops logging.

Methods inherited from class com.etherios.connector.core.log.ConnectorLogger

getInstance, logEvent, logSystemDebug, logSystemError, logSystemInfo

Methods inherited from class java.lang.Object

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

Field Detail

LOG_BOTH

public static final java.lang.String LOG_BOTH

Log messages will be sent to the standard output and to a log file as described for LOG_FILE.

The value of this constant is "both".

See Also:

PARAM_LOG_OUTPUT, LOG_CONSOLE, LOG_FILE, Constant Field Values

LOG_CONSOLE

public static final java.lang.String LOG_CONSOLE

Log messages will be sent to the standard output.

The value of this constant is "console".

See Also:

PARAM_LOG_OUTPUT, LOG_FILE, LOG_BOTH, Constant Field Values

LOG_FILE

public static final java.lang.String LOG_FILE

Log messages will be sent to a file located in the 'storage_dir' property. The name format will be 'connector_log_yyyyMMdd_HHmmss.txt'.

The value of this constant is "file".

See Also:

PARAM_LOG_OUTPUT, LOG_CONSOLE, LOG_BOTH, Constant Field Values

LOG_TAG

public static final java.lang.String LOG_TAG

'Log tag' setting name: "log_tag".

Identifies the instance of the Cloud Connector in the log messages.

This setting is useful if the application is going to run multiple instances of the Cloud Connector concurrently.

See Also:

Constant Field Values

PARAM_LOG_OUTPUT

public static final java.lang.String PARAM_LOG_OUTPUT

'Log output' setting name: "log_output".

See Also:

LOG_CONSOLE, LOG_FILE, LOG_BOTH, Constant Field Values

Constructor Detail

DefaultConnectorLogger

public DefaultConnectorLogger(PreferencesManager preferencesManager)

Class constructor. Instances a new object of type Default Connector Logger.

Parameters:

preferencesManager - the preferences manager to get and set the value of the logger settings, if null the default configuration for the logger will be used.

DefaultConnectorLogger

public DefaultConnectorLogger(PreferencesManager preferencesManager,
                              java.lang.String configFile)

Class constructor. Instances a new object of type Default Connector Logger with the given Cloud Connector configuration file.

Parameters:

preferencesManager - the preferences manager to get and set the value of the logger settings, if null the default configuration for the logger will be used.

configFile - Path of the Cloud Connector configuration file.

Method Detail

getLogFilePath

public java.lang.String getLogFilePath()

Returns the log file path.

Returns:

the log file path or null if not logging to a 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 or null if not found.

isLoggingToConsole

public boolean isLoggingToConsole()

Returns true if logging to console, false otherwise.

Returns:

true if logging to console, false otherwise.

isLoggingToFile

public boolean isLoggingToFile()

Returns true if logging to file, false otherwise.

Returns:

true if logging to file, false otherwise.

logConnectionEvents

public boolean logConnectionEvents()

Description copied from class: ConnectorLogger

Retrieves whether connection events should be logged or not.

Specified by:

logConnectionEvents in class ConnectorLogger

Returns:

true if connection events should be logged, false otherwise.

logDataPointEvents

public boolean logDataPointEvents()

Description copied from class: ConnectorLogger

Retrieves whether data point events should be logged or not.

Specified by:

logDataPointEvents in class ConnectorLogger

Returns:

true if data point events should be logged, false otherwise.

logDataPushEvents

public boolean logDataPushEvents()

Description copied from class: ConnectorLogger

Retrieves whether data push events should be logged or not.

Specified by:

logDataPushEvents in class ConnectorLogger

Returns:

true if data push events should be logged, false otherwise.

logDebugMessages

public boolean logDebugMessages()

Description copied from class: ConnectorLogger

Retrieves whether to log debug level messages or not.

Specified by:

logDebugMessages in class ConnectorLogger

Returns:

true to log debug level messages, false otherwise.

logDeviceRequestEvents

public boolean logDeviceRequestEvents()

Description copied from class: ConnectorLogger

Retrieves whether device request events should be logged or not.

Specified by:

logDeviceRequestEvents in class ConnectorLogger

Returns:

true if device request events should be logged, false otherwise.

logErrorMessages

public boolean logErrorMessages()

Description copied from class: ConnectorLogger

Retrieves whether to log error level messages or not.

Specified by:

logErrorMessages in class ConnectorLogger

Returns:

true to log error level messages, false otherwise.

logException

public void logException(java.lang.Exception e)

Description copied from class: ConnectorLogger

Logs the given exception.

Specified by:

logException in class ConnectorLogger

Parameters:

e - Exception to log.

logExceptions

public boolean logExceptions()

Description copied from class: ConnectorLogger

Retrieves whether to log exceptions or not.

Specified by:

logExceptions in class ConnectorLogger

Returns:

true to log exceptions, false otherwise.

logFileSystemEvents

public boolean logFileSystemEvents()

Description copied from class: ConnectorLogger

Retrieves whether file system events should be logged or not.

Specified by:

logFileSystemEvents in class ConnectorLogger

Returns:

true if file system events should be logged, false otherwise.

logFirmwareEvents

public boolean logFirmwareEvents()

Description copied from class: ConnectorLogger

Retrieves whether firmware events should be logged or not.

Specified by:

logFirmwareEvents in class ConnectorLogger

Returns:

true if firmware events should be logged, false otherwise.

logInformationMessages

public boolean logInformationMessages()

Description copied from class: ConnectorLogger

Retrieves whether to log information level messages or not.

Specified by:

logInformationMessages in class ConnectorLogger

Returns:

true to log information level messages, false otherwise.

logPackets

public boolean logPackets()

Description copied from class: ConnectorLogger

Retrieves whether to log EDP packets or not.

Specified by:

logPackets in class ConnectorLogger

Returns:

true to log EDP packets, false otherwise.

logRCIEvents

public boolean logRCIEvents()

Description copied from class: ConnectorLogger

Retrieves whether RCI events should be logged or not.

Specified by:

logRCIEvents in class ConnectorLogger

Returns:

true if RCI events should be logged, false otherwise.

logSystemEvents

public boolean logSystemEvents()

Description copied from class: ConnectorLogger

Retrieves whether system events should be logged or not.

Specified by:

logSystemEvents in class ConnectorLogger

Returns:

true if system events should be logged, false otherwise.

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.

stopLogging

public void stopLogging()

Stops logging.

This method closes the log file streams and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect.