com.ibm.retail.si.mgmt
Interface MgmtExtendedControlMBean

All Known Subinterfaces:
MgmtClientHealthMBean, MgmtHealthMBean, MgmtMasterHealthMBean, SessionMBean, SessionServerMBean

public interface MgmtExtendedControlMBean

Management interface for controlling extended management functions. This interface allows the remote creation and removal of extended capabilities that are not normally instanciated by the component's MBeans. Examples include extended debugging, extended logging,...

This interface should be implemented by any device/component that wishes to provide very detailed command/control/monitoring functions, but does not wish to expose those functions all the time. This interface would be implemented within an MBean that is always present, and the use of it will either create an instance of the extended function MBean or remove it. By using this functionality a management application can enable very granular control over a component ONLY when explicitly required.

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.

Version:
1.0
Author:
Paul Ruocchio

Field Summary
static int EXTENDED_CTRL
           
static int EXTENDED_DEBUG
           
static int EXTENDED_LOG
           
 
Method Summary
 int destroyDebug()
          Destroy the instance of the extended debug MBean.
 int destroyDetailedControl()
          Destroy the instance of the extended debug MBean.
 int destroyDetailedLogControl()
          Destroy the instance of the extended debug MBean.
 javax.management.ObjectName enableDebug()
          Enable, if available, the extended Debug facilities of this component.
 javax.management.ObjectName enableDetailedControl()
          Enable, if available, the extended Control facilities of this component.
 javax.management.ObjectName enableDetailedLogControl()
          Enable, if available, the extended Logging control facilities of this component.
 int getCurrentlyActiveCapabilities()
          Query the which extened functions are currenly active.
 int getExtendedCapabilities()
          Query the capabilities of this implemetation of this interface.
 

Field Detail

EXTENDED_DEBUG

public static final int EXTENDED_DEBUG
See Also:
Constant Field Values

EXTENDED_LOG

public static final int EXTENDED_LOG
See Also:
Constant Field Values

EXTENDED_CTRL

public static final int EXTENDED_CTRL
See Also:
Constant Field Values
Method Detail

getExtendedCapabilities

public int getExtendedCapabilities()
Query the capabilities of this implemetation of this interface.

Returns:
int - A mask indicating the functions that are available for control by this interface.

getCurrentlyActiveCapabilities

public int getCurrentlyActiveCapabilities()
Query the which extened functions are currenly active.

Returns:
int - A mask indicating the functions that are currenly active.

enableDebug

public javax.management.ObjectName enableDebug()
Enable, if available, the extended Debug facilities of this component.

Returns:
ObjectName - The ObjectName of the newly created MBean.

destroyDebug

public int destroyDebug()
Destroy the instance of the extended debug MBean.

Returns:
int - General return code.

enableDetailedLogControl

public javax.management.ObjectName enableDetailedLogControl()
Enable, if available, the extended Logging control facilities of this component.

Returns:
ObjectName - The ObjectName of the newly created MBean.

destroyDetailedLogControl

public int destroyDetailedLogControl()
Destroy the instance of the extended debug MBean.

Returns:
int - General return code.

enableDetailedControl

public javax.management.ObjectName enableDetailedControl()
Enable, if available, the extended Control facilities of this component.

Returns:
ObjectName - The ObjectName of the newly created MBean.

destroyDetailedControl

public int destroyDetailedControl()
Destroy the instance of the extended debug MBean.

Returns:
int - General return code.


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