com.prosyst.mprm.admin.log

Interface LogReader

All Superinterfaces:

LogReaderService

public interface LogReader
extends LogReaderService

Provides methods for retrieving log entries from the mPRM log and for registering log listeners that shall receive newly added logs. All methods that retrieve log entries return an Enumeration of LogEntry objects in the log. Each element of the enumeration is a LogEntry object, ordered with the most recent entry first. The returned log entries are filtered by several possible criterias specified the as arguments of the retrieve methods.

Method Summary

Modifier and Type	Method and Description
void	addLogListener(int level, LogListener listner) Adds a log listener for log entries with a given severity level.
java.util.Enumeration	getDeviceLog(java.lang.String groupPath, boolean wholeSubTree, int level, java.util.Date fromTime, java.util.Date toTime, java.lang.String[] source, java.lang.String text, int count) Method getDeviceLog retrieves log messages related to a given device group.
java.util.Enumeration	getDeviceLog(java.lang.String deviceType, java.lang.String deviceId, int level, java.util.Date fromTime, java.util.Date toTime) Retrieves log messages related to a given device.
java.util.Enumeration	getDeviceLog(java.lang.String deviceType, java.lang.String deviceId, int level, java.util.Date fromTime, java.util.Date toTime, java.lang.String[] source, java.lang.String text, int count) Method getDeviceLog ...
java.util.Enumeration	getGatewayLog(java.lang.String gatewayId, int level, java.util.Date fromTime, java.util.Date toTime) Deprecated. As of mPRM 4.0, the preferred way is to use getDeviceLog(String, String, int, Date, Date) method.
java.util.Enumeration	getLog(int level, java.util.Date fromTime, java.util.Date toTime) Retrieves log messages created within a given period.
java.util.Enumeration	getLog(int level, java.util.Date fromTime, java.util.Date toTime, java.lang.String[] source, java.lang.String text, int count) Method getLog retrieves log messages created within a given period.
java.io.InputStream	getLogFile(java.lang.String gatewayId, java.lang.String fileName) Deprecated. As of mPRM 4.0, the preferred way is to use @link com.prosyst.mprm.admin.logfile.LogFilesReader#getLogFile(String, String) method from the OSGi Device Management package.
java.lang.String[]	getLogFileNames(java.lang.String gatewayId) Deprecated. As of mPRM 4.0, the preferred way is to use com.prosyst.mprm.admin.logfile.LogFilesReader#getLogFileNames(String) method from the OSGi Device Management package.
java.util.Enumeration	getSources(int count) Method getSources retrieves the source values of the stored log entries.
java.util.Enumeration	getSources(java.lang.String deviceType, java.lang.String deviceId, int count) Method getSources retrieves the source values of the stored log entries.
java.util.Enumeration	getSystemLog(java.lang.String[] hostRoles, int level, java.util.Date fromTime, java.util.Date toTime) Retrieves system related log messages.
java.util.Enumeration	getSystemLog(java.lang.String[] hostRoles, int level, java.util.Date fromTime, java.util.Date toTime, java.lang.String[] source, java.lang.String text, int count) Method getSystemLog retrieves system related log messages.
void	removeLogListener(int level, LogListener listner) Removes a log listener for log entries with given severity level.

Methods inherited from interface org.osgi.service.log.LogReaderService

addLogListener, getLog, removeLogListener

Method Detail

getSystemLog

java.util.Enumeration getSystemLog(java.lang.String[] hostRoles,
                                   int level,
                                   java.util.Date fromTime,
                                   java.util.Date toTime)
                            throws ManagementException

Retrieves system related log messages.

Parameters:

hostRoles - - The host roles of backend hosts, that logs will be retrieved from. Host roles could be some of the constants:
com.prosyst.mprm.admin.system.Roles.CC
, com.prosyst.mprm.admin.system.Roles.RAS
, com.prosyst.mprm.admin.system.Roles.MS
or id-s of particular Management Servers

level - - Specifies the severity level of log entries being returned. The returned logs have a severity level with value equal to the specified or lower.

fromTime - - Only log messages created after this date will be returned.

toTime - - Only log messages created before this date will be returned.

Throws:

ManagementException

getGatewayLog

java.util.Enumeration getGatewayLog(java.lang.String gatewayId,
                                    int level,
                                    java.util.Date fromTime,
                                    java.util.Date toTime)
                             throws ManagementException

Deprecated. As of mPRM 4.0, the preferred way is to use getDeviceLog(String, String, int, Date, Date) method.

Retrieves log messages related to a given OSGi device.

Parameters:

gatewayId - - Specifies the id of an OSGi device, the retrieved logs are related to. If null is passed as value of this argument, then all logs related to OSGi devices will be returned.

level - - Specifies the severity level of log entries being returned. The returned logs have a severity level with value equal to the specified or lower.

fromTime - - Only log messages created after this date will be returned.

toTime - - Only log messages created before this date will be returned.

Throws:

ManagementException

getDeviceLog

java.util.Enumeration getDeviceLog(java.lang.String deviceType,
                                   java.lang.String deviceId,
                                   int level,
                                   java.util.Date fromTime,
                                   java.util.Date toTime)
                            throws ManagementException

Retrieves log messages related to a given device.

Parameters:

deviceType - - Specifies the type of a device, the retrieved logs are related to. If null is passed as value of this argument, then all logs related to managed devices will be returned.

deviceId - - Specifies the id of a device, the retrieved logs are related to. If null is passed as value of this argument, then all logs related to devices of the specified type will be returned.

level - - Specifies the severity level of log entries being returned. The returned logs have a severity level with value equal to the specified or lower.

fromTime - - Only log messages created after this date will be returned.

toTime - - Only log messages created before this date will be returned.

Throws:

ManagementException

getLog

java.util.Enumeration getLog(int level,
                             java.util.Date fromTime,
                             java.util.Date toTime)
                      throws ManagementException

Retrieves log messages created within a given period.

Parameters:

level - - Specifies the severity level of log entries being returned. The returned logs have a severity level with value equal to the specified or lower.

fromTime - - Only log messages created after this date will be returned.

toTime - - Only log messages created before this date will be returned.

Throws:

ManagementException

addLogListener

void addLogListener(int level,
                    LogListener listner)
             throws ManagementException

Adds a log listener for log entries with a given severity level. This listener will receive all newly added log entries that have the specified severity level.
Important: When retrieveing logs with a given severity level, all entries with the given level or lower are returned. This rule is not valid here and only logs with the specified severity level will be received.

Parameters:

level - - The severity level of logs to be received.

listner - - The listener to be registered.

Throws:

ManagementException

removeLogListener

void removeLogListener(int level,
                       LogListener listner)

Removes a log listener for log entries with given severity level.

Parameters:

level - - The severity level of logs entries.

listner - - The listener to be unregistered.

getLogFileNames

java.lang.String[] getLogFileNames(java.lang.String gatewayId)
                            throws ManagementException

Deprecated. As of mPRM 4.0, the preferred way is to use com.prosyst.mprm.admin.logfile.LogFilesReader#getLogFileNames(String) method from the OSGi Device Management package.

Gets all log file names, available in the log storage of a given OSGi device.

Parameters:

gatewayId - - Id of an OSGi device managed by the mPRM system.

Returns:

log file names or an empty array if there are none.

Throws:

ManagementException - if a system error occurs.

getLogFile

java.io.InputStream getLogFile(java.lang.String gatewayId,
                               java.lang.String fileName)
                        throws ManagementException

Deprecated. As of mPRM 4.0, the preferred way is to use @link com.prosyst.mprm.admin.logfile.LogFilesReader#getLogFile(String, String) method from the OSGi Device Management package.

Gets an input stream for the requested log file from a given OSGi device.

Parameters:

gatewayId - id of an OSGi device managed by the mPRM system

fileName - file name, whose content is retrieved in the stream

Returns:

stream to the file

Throws:

IOException - in case such a file does not exists or a system error occurs

ManagementException

getDeviceLog

java.util.Enumeration getDeviceLog(java.lang.String groupPath,
                                   boolean wholeSubTree,
                                   int level,
                                   java.util.Date fromTime,
                                   java.util.Date toTime,
                                   java.lang.String[] source,
                                   java.lang.String text,
                                   int count)
                            throws ManagementException

Method getDeviceLog retrieves log messages related to a given device group.

Parameters:

groupPath - of type String - Specifies the path group of devices for which the retrieved logs are related to

wholeSubTree - of type boolean - tells whether to include the whole subtree that stays under the selected groupPath

level - of type int - Specifies the severity level of log entries being returned. The returned logs have a severity level with value equal to the specified or lower.

fromTime - of type Date - Only log messages created after this date will be returned.

toTime - of type Date - Only log messages created before this date will be returned.

source - of type String[] - Filters the returned log entries with the provided source parameters

text - of type String - Filters the returned log entries with the text (provided via the parameter) included in the message

count - of type int - Specifies how many maximum log entries to be retrieved.

Returns:

Enumeration of type LogEntry - returns Enumeration containing the returned log entries objects

Throws:

ManagementException - when - Thrown if there is a problem executing that method

getSystemLog

java.util.Enumeration getSystemLog(java.lang.String[] hostRoles,
                                   int level,
                                   java.util.Date fromTime,
                                   java.util.Date toTime,
                                   java.lang.String[] source,
                                   java.lang.String text,
                                   int count)
                            throws ManagementException

Method getSystemLog retrieves system related log messages.

Parameters:

hostRoles - of type String[] - The host roles of backend hosts, that logs will be retrieved from. Host roles could be some of the constants:
com.prosyst.mprm.admin.system.Roles.CC
, com.prosyst.mprm.admin.system.Roles.RAS
, com.prosyst.mprm.admin.system.Roles.MS
or id-s of particular Management Servers

level - of type int - Specifies the severity level of log entries being returned. The returned logs have a severity level with value equal to the specified or lower.

fromTime - of type Date - Only log messages created after this date will be returned.

toTime - of type Date - Only log messages created before this date will be returned.

source - of type String[] - Filters the returned log entries with the provided source parameters

text - of type String - Filters the returned log entries with the text (provided via the parameter) included in the message

count - of type int - Specifies how many maximum log entries to be retrieved.

Returns:

Enumeration of type LogEntry - returns Enumeration containing the returned log entries objects

Throws:

ManagementException - when - Thrown if there is a problem executing that method

getLog

java.util.Enumeration getLog(int level,
                             java.util.Date fromTime,
                             java.util.Date toTime,
                             java.lang.String[] source,
                             java.lang.String text,
                             int count)
                      throws ManagementException

Method getLog retrieves log messages created within a given period.

Parameters:

level - of type int Specifies the severity level of log entries being returned. The returned logs have a severity level with value equal to the specified or lower.

fromTime - of type Date - Only log messages created after this date will be returned.

toTime - of type Date - Only log messages created before this date will be returned.

source - of type String[] - Only log messages created before this date will be returned.

text - of type String - Filters the returned log entries with the text (provided via the parameter) included in the message

count - of type int - Specifies how many maximum log entries to be retrieved.

Returns:

Enumeration of type LogEntry - returns Enumeration containing the returned log entries objects

Throws:

ManagementException - when - Thrown if there is a problem executing that method

getSources

java.util.Enumeration getSources(int count)
                          throws ManagementException

Method getSources retrieves the source values of the stored log entries.

Parameters:

count - of type int - Specifies how many maximum log entries to be retrieved.

Returns:

Enumeration of type String - returns Enumeration containing the returned source objects

Throws:

ManagementException - when - Thrown if there is a problem executing that method

getSources

java.util.Enumeration getSources(java.lang.String deviceType,
                                 java.lang.String deviceId,
                                 int count)
                          throws ManagementException

Method getSources retrieves the source values of the stored log entries.

Parameters:

deviceType - of type String - Specifies the type of a device, the retrieved logs are related to. If null is passed as value of this argument, then all logs related to managed devices will be returned.

deviceId - of type String - Specifies the id of a device, the retrieved logs are related to. If null is passed as value of this argument, then all logs related to devices of the specified type will be returned.

count - of type int - Specifies how many maximum log entries to be retrieved.

Returns:

Enumeration of type String - returns Enumeration containing the returned source objects

Throws:

ManagementException - when - Thrown if there is a problem executing that method

getDeviceLog

java.util.Enumeration getDeviceLog(java.lang.String deviceType,
                                   java.lang.String deviceId,
                                   int level,
                                   java.util.Date fromTime,
                                   java.util.Date toTime,
                                   java.lang.String[] source,
                                   java.lang.String text,
                                   int count)
                            throws ManagementException

Method getDeviceLog ...

Parameters:

deviceType - of type String - Specifies the type of a device, the retrieved logs are related to. If null is passed as value of this argument, then all logs related to managed devices will be returned.

deviceId - of type String - Specifies the id of a device, the retrieved logs are related to. If null is passed as value of this argument, then all logs related to devices of the specified type will be returned.

level - of type int - Specifies the severity level of log entries being returned. The returned logs have a severity level with value equal to the specified or lower.

fromTime - of type Date - Only log messages created after this date will be returned.

toTime - of type Date - Only log messages created before this date will be returned.

source - of type String[] - Filters the returned log entries with the provided source parameters

text - of type String - Filters the returned log entries with the text (provided via the parameter) included in the message

count - of type int - Specifies how many maximum log entries to be retrieved.

Returns:

Enumeration of type LogEntry - returns Enumeration containing the returned log entries objects

Throws:

ManagementException - when - Thrown if there is a problem executing that method