com.ibm.retail.si.mgmt
Interface MgmtClientHealthMBean

All Superinterfaces:
MgmtExtendedControlMBean, MgmtHealthMBean

public interface MgmtClientHealthMBean
extends MgmtHealthMBean

Management interface for the MgmtClientHealth MBean. It represents the client side discovery and health checking done on behalf of the General Agent ONLY. The MBean emits UDP discovery packets at a configured interval for discovery by a Master Agent.

The ObjectName of this MBean includes the following attributes, in addition to the SIF attribute of DeviceID:

This management interface includes the following attributes. These attributes are described in more detail in the accessor methods, and in the MgmtHealthMBean and MgmtExtendedControlMBean interfaces.

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

An AgentShutdownNotification is emitted by classes implementing this interface when the General Agent is cleanly shut down. The notification userData will contain the MgmtDeviceInfo for the agent.

Author:
Paul Ruocchio, Kriselie D Rivera, Chris D Arrington
See Also:
MgmtHealthMBean

Field Summary
static java.lang.String mbQueryDefault
           
static java.lang.String mbQueryWAS
           
static java.lang.String OBJECT_NAME
           
 
Fields inherited from interface com.ibm.retail.si.mgmt.MgmtExtendedControlMBean
EXTENDED_CTRL, EXTENDED_DEBUG, EXTENDED_LOG
 
Method Summary
 int getInterval()
          Returns the number of seconds between the transmission of discovery UDP packets
 void setInterval(int seconds)
           
 
Methods inherited from interface com.ibm.retail.si.mgmt.MgmtHealthMBean
getDeviceInfo, getHostname, getIPAddress, isAgentStarted
 
Methods inherited from interface com.ibm.retail.si.mgmt.MgmtExtendedControlMBean
destroyDebug, destroyDetailedControl, destroyDetailedLogControl, enableDebug, enableDetailedControl, enableDetailedLogControl, getCurrentlyActiveCapabilities, getExtendedCapabilities
 

Field Detail

OBJECT_NAME

public static final java.lang.String OBJECT_NAME
See Also:
Constant Field Values

mbQueryWAS

public static final java.lang.String mbQueryWAS
See Also:
Constant Field Values

mbQueryDefault

public static final java.lang.String mbQueryDefault
See Also:
Constant Field Values
Method Detail

setInterval

public void setInterval(int seconds)
                 throws javax.management.InvalidAttributeValueException
Parameters:
seconds - The new number of seconds between discovery transmissions
javax.management.InvalidAttributeValueException

getInterval

public int getInterval()
Returns the number of seconds between the transmission of discovery UDP packets

Returns:
The number of seconds between the transmission of discovery UDP packets


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