com.ibm.retail.si.mgmt.logging
Interface RemoteLoggingCtrlMBean

All Known Subinterfaces:
RemoteJDKLoggingCtrlMBean, RemoteLog4JLoggingCtrlMBean, RemoteSyslogLoggingCtrlMBean

public interface RemoteLoggingCtrlMBean

Management interface for controlling the forwarding of logging events from a particular logging implementation as RtlTracePointNotifications. This interface should not be instantiated but instead be extended for each logging implementation. Each implementation should map each of the remote logging levels listed below to a level in their implementation.

This management interface includes the following attributes. These attributes are described in more detail in the accessor methods.

The following operations are included in this management interface. These are described in more detail in the corresponding method documentation.

Classes that implement this interface emit a RtlTracePointNotification for each logging event it is configured to forward.

Author:
Paul Ruocchio, Chris D Arrington

Field Summary
static int LEVEL_ALERT
           
static int LEVEL_CRIT
           
static int LEVEL_DEBUG
           
static int LEVEL_EMERGENCY
           
static int LEVEL_ERR
           
static int LEVEL_INFO
           
static int LEVEL_MASK_ALL
           
static int LEVEL_MASK_OFF
           
static int LEVEL_MASK_SEVERE
           
static int LEVEL_NOTICE
           
static int LEVEL_WARNING
           
static int[] LEVELS
           
 
Method Summary
 java.lang.Integer getLevel()
          Returns a mask indicating the current level of logging that is enabled.
 java.lang.String getLogType()
          Returns a sting to indicate the type of logger that is managed by this interface.
 boolean isActive()
          Returns a string to indicate the type of logger that is managed by this interface.
 void setLevel(java.lang.Integer LevelMask)
          Returns a mask indicating the current level of logging that is enabled.
 boolean start()
          Causes the logger that is managed by this MBean to start logging.
 boolean stop()
          Causes the logger that is managed by this MBean to stop logging.
 

Field Detail

LEVEL_EMERGENCY

public static final int LEVEL_EMERGENCY
See Also:
Constant Field Values

LEVEL_ALERT

public static final int LEVEL_ALERT
See Also:
Constant Field Values

LEVEL_CRIT

public static final int LEVEL_CRIT
See Also:
Constant Field Values

LEVEL_ERR

public static final int LEVEL_ERR
See Also:
Constant Field Values

LEVEL_WARNING

public static final int LEVEL_WARNING
See Also:
Constant Field Values

LEVEL_NOTICE

public static final int LEVEL_NOTICE
See Also:
Constant Field Values

LEVEL_INFO

public static final int LEVEL_INFO
See Also:
Constant Field Values

LEVEL_DEBUG

public static final int LEVEL_DEBUG
See Also:
Constant Field Values

LEVEL_MASK_ALL

public static final int LEVEL_MASK_ALL
See Also:
Constant Field Values

LEVEL_MASK_OFF

public static final int LEVEL_MASK_OFF
See Also:
Constant Field Values

LEVEL_MASK_SEVERE

public static final int LEVEL_MASK_SEVERE
See Also:
Constant Field Values

LEVELS

public static final int[] LEVELS
Method Detail

setLevel

public void setLevel(java.lang.Integer LevelMask)
              throws javax.management.InvalidAttributeValueException
Returns a mask indicating the current level of logging that is enabled.

Throws:
javax.management.InvalidAttributeValueException - An attempt is made to set an undefined level or mask

getLevel

public java.lang.Integer getLevel()
Returns a mask indicating the current level of logging that is enabled.

Returns:
Integer RC - A mask indicating the current level of logging. See the Mask values defined for this interface.

isActive

public boolean isActive()
Returns a string to indicate the type of logger that is managed by this interface.

Returns:
boolean - Return code indicating that the logging is or is not currenly forwarding information to the JMX infrastructure.

getLogType

public java.lang.String getLogType()
Returns a sting to indicate the type of logger that is managed by this interface.

Returns:
String - The name of the logger.

start

public boolean start()
Causes the logger that is managed by this MBean to start logging. The result is that assuming the entries pass the set level filter, they are forwarded as notifications.

Returns:
boolean - The result of the operation. True if the MBean was started successfully, false if there was an error starting or the MBean was already started

stop

public boolean stop()
Causes the logger that is managed by this MBean to stop logging. The result is that NO log entries are forwarded as notifications.

Returns:
boolean - The result of the operation. True if the MBean was stopped successfully, false if there was an error stopping or the MBean was already stopped.


Copyright © 2004 IBM. All Rights Reserved.
Generated: July 19 2004