com.ibm.retail.si.mgmt.masteragent
Interface RemoteServerPoolMBean


public interface RemoteServerPoolMBean

MBean interface definition for the RemoteServerPool, contains methods to add, get and remove MBeanServerConnections from the pool.

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.

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

This MBean emits no Notifications.

Author:
Kriselie D Rivera

Field Summary
static java.lang.String OBJECT_NAME
           
 
Method Summary
 void addRemoteServer(com.ibm.retail.si.mgmt.MgmtDeviceInfo devInfo, javax.management.remote.JMXConnector connector, javax.management.MBeanServerConnection server)
          Adds a MBeanServerConnection reference to the pool.
 com.ibm.retail.si.mgmt.MgmtDeviceInfo[] getAllDevInfo()
           
 com.ibm.retail.si.mgmt.MgmtDeviceInfo getDevInfo(java.lang.String jndiName)
          Returns the MgmtDeviceInfo object for a remote agent
 com.ibm.retail.si.mgmt.MgmtDeviceInfo[] getDevInfoByDevice(java.lang.String deviceId)
          Returns an array of currently known MgmtDeviceInfo running the supplied device
 com.ibm.retail.si.mgmt.MgmtDeviceInfo[] getDevInfoByType(java.lang.Integer deviceType)
          Returns a List of currently known MgmtDeviceInfo that are of the supplied device type
 javax.management.MBeanServerConnection getServer(java.lang.String jndiName)
          Returns a reference to a MBeanServerConnection that has been stored in the pool, which is associated by the JNDI name of the remote agent
 javax.management.MBeanServerConnection[] getServers()
          Returns references to all MBeanServerConnections that have been stored in the pool
 javax.management.MBeanServerConnection[] getServers(java.lang.Integer deviceType)
          Returns references to all MBeanServerConnections that have been stored in the pool that are associated to devices with the supplied deviceType
 java.lang.Integer getSize()
           
 void removeRemoteServer(com.ibm.retail.si.mgmt.MgmtDeviceInfo devInfo)
          Removes a MBeanServerConnection reference from the pool, usually in response to an agent being lost or disconnected from the monitoring agent.
 void shutdown()
          Shuts down the server pool, closing all remote JMXConnectors
 

Field Detail

OBJECT_NAME

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

addRemoteServer

public void addRemoteServer(com.ibm.retail.si.mgmt.MgmtDeviceInfo devInfo,
                            javax.management.remote.JMXConnector connector,
                            javax.management.MBeanServerConnection server)
                     throws java.io.IOException
Adds a MBeanServerConnection reference to the pool. It uses the MgmtDeviceInfo object from the agent which contains the MBeanServerConnection reference to use as a key for storing the servers in the pool.

Parameters:
devInfo - MgmtDeviceInfo object corresponding to the remote agent.
connector - JMXConnector used to obtain this MBeanServerConnection
server - MBeanServerConnection reference
Throws:
java.io.IOException - if there is a problem communicating with the remote reference.

removeRemoteServer

public void removeRemoteServer(com.ibm.retail.si.mgmt.MgmtDeviceInfo devInfo)
                        throws java.io.IOException
Removes a MBeanServerConnection reference from the pool, usually in response to an agent being lost or disconnected from the monitoring agent.

Parameters:
devInfo - MgmtDeviceInfo corresponding to the remote agent.
Throws:
java.io.IOException - if there is a problem communicating with the remote reference.

getServer

public javax.management.MBeanServerConnection getServer(java.lang.String jndiName)
Returns a reference to a MBeanServerConnection that has been stored in the pool, which is associated by the JNDI name of the remote agent

Parameters:
jndiName - JNDI name associated to a remote agent
Returns:
MBeanServerConnection if one exists for the supplied name, or null

getServers

public javax.management.MBeanServerConnection[] getServers()
Returns references to all MBeanServerConnections that have been stored in the pool

Returns:
MBeanServerConnection[]

getServers

public javax.management.MBeanServerConnection[] getServers(java.lang.Integer deviceType)
Returns references to all MBeanServerConnections that have been stored in the pool that are associated to devices with the supplied deviceType

Parameters:
deviceType - Device type associated with the connections
Returns:
MBeanServerConnection[]

getAllDevInfo

public com.ibm.retail.si.mgmt.MgmtDeviceInfo[] getAllDevInfo()
Returns:
Array containing each MgmtDeviceInfo corresponding to each stored MBeanServerConnection.

getDevInfo

public com.ibm.retail.si.mgmt.MgmtDeviceInfo getDevInfo(java.lang.String jndiName)
Returns the MgmtDeviceInfo object for a remote agent

Parameters:
jndiName - JNDI Name of the remote agent connection
Returns:
MgmtDeviceInfo object for a remote agent, or null if none exists

getDevInfoByDevice

public com.ibm.retail.si.mgmt.MgmtDeviceInfo[] getDevInfoByDevice(java.lang.String deviceId)
Returns an array of currently known MgmtDeviceInfo running the supplied device

Parameters:
deviceId - Device to search for
Returns:
MgmtDeviceInfo[] of information about each running agent on the supplied device, or an empty array if no agents are known

getDevInfoByType

public com.ibm.retail.si.mgmt.MgmtDeviceInfo[] getDevInfoByType(java.lang.Integer deviceType)
Returns a List of currently known MgmtDeviceInfo that are of the supplied device type

Parameters:
deviceType - Integer device type to search for
Returns:
Array of currently known MgmtDeviceInfo that are of the supplied device type, or an empty array if no devices of that type are known

getSize

public java.lang.Integer getSize()
Returns:
Integer size of the server pool

shutdown

public void shutdown()
Shuts down the server pool, closing all remote JMXConnectors



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