ConnectorLogger (Etherios Cloud Connector for Java ME)

java.lang.Object
- com.etherios.connector.core.log.ConnectorLogger

Direct Known Subclasses:

DefaultConnectorLogger
```
public abstract class ConnectorLogger
extends java.lang.Object
```
This class defines the different methods that should be implemented in order to become a Connector Logger.
As each device may use different logging procedures (files, text to screen, etc.) the logging methods have been defined to be abstract so each device implements their preferred logging strategy (or none).

As part of the implementation it is required to define which messages will be logged and which not.

Constructor Summary

Constructors
Constructor and Description

ConnectorLogger()
Class constructor.

Constructors
Constructor and Description
`ConnectorLogger()` Class constructor.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`static ConnectorLogger`	`getInstance()` Retrieves the active instance of the Connector Logger.
`abstract boolean`	`logConnectionEvents()` Retrieves whether connection events should be logged or not.
`abstract boolean`	`logDataPointEvents()` Retrieves whether data point events should be logged or not.
`abstract boolean`	`logDataPushEvents()` Retrieves whether data push events should be logged or not.
`abstract boolean`	`logDebugMessages()` Retrieves whether to log debug level messages or not.
`abstract boolean`	`logDeviceRequestEvents()` Retrieves whether device request events should be logged or not.
`abstract boolean`	`logErrorMessages()` Retrieves whether to log error level messages or not.
`void`	`logEvent(Event event)` Logs the given event depending on the severity and event type.
`abstract void`	`logException(java.lang.Exception e)` Logs the given exception.
`abstract boolean`	`logExceptions()` Retrieves whether to log exceptions or not.
`abstract boolean`	`logFileSystemEvents()` Retrieves whether file system events should be logged or not.
`abstract boolean`	`logFirmwareEvents()` Retrieves whether firmware events should be logged or not.
`abstract boolean`	`logInformationMessages()` Retrieves whether to log information level messages or not.
`abstract boolean`	`logPackets()` Retrieves whether to log EDP packets or not.
`abstract boolean`	`logRCIEvents()` Retrieves whether RCI events should be logged or not.
`void`	`logSystemDebug(java.lang.String message)` Logs the given system debug message if log system events and log debug messages are enabled.
`void`	`logSystemError(java.lang.String message)` Logs the given system error message if log system events and log error messages are enabled.
`abstract boolean`	`logSystemEvents()` Retrieves whether system events should be logged or not.
`void`	`logSystemInfo(java.lang.String message)` Logs the given system information message if log system events and log information messages are enabled.

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

- Constructor Detail
  - ConnectorLogger
```
public ConnectorLogger()
```
    Class constructor. Instances a new object of type Orion Connector Logger.
- Method Detail
  - getInstance
```
public static ConnectorLogger getInstance()
```
    Retrieves the active instance of the Connector Logger.
    
    Returns:
    
    Active instance of the Connector Logger.
  - logConnectionEvents
```
public abstract boolean logConnectionEvents()
```
    Retrieves whether connection events should be logged or not.
    
    Returns:
    
    true if connection events should be logged, false otherwise.
  - logDataPointEvents
```
public abstract boolean logDataPointEvents()
```
    Retrieves whether data point events should be logged or not.
    
    Returns:
    
    true if data point events should be logged, false otherwise.
  - logDataPushEvents
```
public abstract boolean logDataPushEvents()
```
    Retrieves whether data push events should be logged or not.
    
    Returns:
    
    true if data push events should be logged, false otherwise.
  - logDebugMessages
```
public abstract boolean logDebugMessages()
```
    Retrieves whether to log debug level messages or not.
    
    Returns:
    
    true to log debug level messages, false otherwise.
  - logDeviceRequestEvents
```
public abstract boolean logDeviceRequestEvents()
```
    Retrieves whether device request events should be logged or not.
    
    Returns:
    
    true if device request events should be logged, false otherwise.
  - logErrorMessages
```
public abstract boolean logErrorMessages()
```
    Retrieves whether to log error level messages or not.
    
    Returns:
    
    true to log error level messages, false otherwise.
  - logEvent
```
public void logEvent(Event event)
```
    Logs the given event depending on the severity and event type.
    
    Parameters:
    
    event - Event to log.
    
    See Also:
    
    logConnectionEvents(), logDebugMessages(), logInformationMessages(), logErrorMessages()
  - logException
```
public abstract void logException(java.lang.Exception e)
```
    Logs the given exception.
    
    Parameters:
    
    e - Exception to log.
  - logExceptions
```
public abstract boolean logExceptions()
```
    Retrieves whether to log exceptions or not.
    
    Returns:
    
    true to log exceptions, false otherwise.
  - logFileSystemEvents
```
public abstract boolean logFileSystemEvents()
```
    Retrieves whether file system events should be logged or not.
    
    Returns:
    
    true if file system events should be logged, false otherwise.
  - logFirmwareEvents
```
public abstract boolean logFirmwareEvents()
```
    Retrieves whether firmware events should be logged or not.
    
    Returns:
    
    true if firmware events should be logged, false otherwise.
  - logInformationMessages
```
public abstract boolean logInformationMessages()
```
    Retrieves whether to log information level messages or not.
    
    Returns:
    
    true to log information level messages, false otherwise.
  - logPackets
```
public abstract boolean logPackets()
```
    Retrieves whether to log EDP packets or not.
    
    Returns:
    
    true to log EDP packets, false otherwise.
  - logRCIEvents
```
public abstract boolean logRCIEvents()
```
    Retrieves whether RCI events should be logged or not.
    
    Returns:
    
    true if RCI events should be logged, false otherwise.
  - logSystemDebug
```
public void logSystemDebug(java.lang.String message)
```
    Logs the given system debug message if log system events and log debug messages are enabled.
    
    Parameters:
    
    message - Debug message.
    
    See Also:
    
    logSystemEvents(), logDebugMessages()
  - logSystemError
```
public void logSystemError(java.lang.String message)
```
    Logs the given system error message if log system events and log error messages are enabled.
    
    Parameters:
    
    message - Error message.
    
    See Also:
    
    logSystemEvents(), logErrorMessages()
  - logSystemEvents
```
public abstract boolean logSystemEvents()
```
    Retrieves whether system events should be logged or not.
    
    Returns:
    
    true if system events should be logged, false otherwise.
  - logSystemInfo
```
public void logSystemInfo(java.lang.String message)
```
    Logs the given system information message if log system events and log information messages are enabled.
    
    Parameters:
    
    message - Information message.
    
    See Also:
    
    logSystemEvents(), logInformationMessages()

Class ConnectorLogger

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ConnectorLogger

Method Detail

getInstance

logConnectionEvents

logDataPointEvents

logDataPushEvents

logDebugMessages

logDeviceRequestEvents

logErrorMessages

logEvent

logException

logExceptions

logFileSystemEvents

logFirmwareEvents

logInformationMessages

logPackets

logRCIEvents

logSystemDebug

logSystemError

logSystemEvents

logSystemInfo