com.ibm.retail.si.mgmt
Class MgmtDeviceInfo

java.lang.Object
  |
  +--com.ibm.retail.si.mgmt.MgmtDeviceInfo
All Implemented Interfaces:
java.io.Serializable

public class MgmtDeviceInfo
extends java.lang.Object
implements java.io.Serializable

A Collection of information pertaining to a device that has been discovered, and is being tracked by the discovery MBean: MgmtMasterHealth.

Author:
Paul A Ruocchio, Chris D. Arrington
See Also:
Serialized Form

Field Summary
(package private)  java.net.InetAddress Address
           
protected  long agentStartTime
           
protected  int agentType
           
(package private)  int ConfiguredInterval
           
protected  boolean connectionAttempted
           
protected  int connectionTics
           
(package private)  java.lang.String deviceId
           
(package private)  int DeviceType
           
(package private) static int GENERAL_AGENT
           
(package private) static int MASTER_AGENT
           
protected  java.lang.String mbeanQueryString
           
(package private)  int MgmtPort
           
protected  java.lang.String mgmtProtocol
           
protected  int MissedTics
           
(package private)  int OfflineThreshold
           
(package private)  java.lang.String SystemID
           
 
Constructor Summary
MgmtDeviceInfo(java.lang.String systemID, int deviceType, java.lang.String deviceId, java.net.InetAddress address, int mgmtPort, java.lang.String mgmtProtocol, int configuredInterval)
          Constructs a new instance with all needed values
MgmtDeviceInfo(java.lang.String systemId, int deviceType, java.lang.String deviceId, int mgmtPort)
          Constructor to obtain an instance containing the minumum values required to determine equality
 
Method Summary
 java.lang.String BuildKey()
           
protected  void decrementConnectionTics()
           
 boolean equals(java.lang.Object o)
          Determines equality based on device id, device type, system id, and management port
 java.net.InetAddress getAddress()
           
 long getAgentStartTime()
           
 int getAgentType()
           
 boolean getConnectionAttempted()
           
protected  int getConnectionTics()
           
 java.lang.String getDeviceId()
           
 int getDeviceType()
           
 java.lang.String getMbeanQueryString()
           
 int getMgmtPort()
           
 java.lang.String getMgmtProtocol()
           
 int getMissedTics()
           
 java.lang.String getSystemId()
           
protected  void setAgentStartTime(long agentStartTime)
           
protected  void setAgentType(int agentType)
           
 void setConnectionAttempted(boolean connectionAttempted)
           
 void setMbeanQueryString(java.lang.String string)
           
 void setMissedTics(int i)
           
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

SystemID

java.lang.String SystemID

DeviceType

int DeviceType

deviceId

java.lang.String deviceId

Address

java.net.InetAddress Address

MgmtPort

int MgmtPort

ConfiguredInterval

int ConfiguredInterval

MissedTics

protected int MissedTics

OfflineThreshold

int OfflineThreshold

GENERAL_AGENT

static final int GENERAL_AGENT
See Also:
Constant Field Values

MASTER_AGENT

static final int MASTER_AGENT
See Also:
Constant Field Values

agentType

protected int agentType

mbeanQueryString

protected java.lang.String mbeanQueryString

agentStartTime

protected long agentStartTime

connectionAttempted

protected boolean connectionAttempted

connectionTics

protected int connectionTics

mgmtProtocol

protected java.lang.String mgmtProtocol
Constructor Detail

MgmtDeviceInfo

public MgmtDeviceInfo(java.lang.String systemID,
                      int deviceType,
                      java.lang.String deviceId,
                      java.net.InetAddress address,
                      int mgmtPort,
                      java.lang.String mgmtProtocol,
                      int configuredInterval)
Constructs a new instance with all needed values

Parameters:
systemID - System Id of the remote agent
deviceType - Device type of the agent device, as defined in MgmtConst
deviceId - Device Id of the agent device
address - Address of the interface to use for managment connectivity
mgmtPort - Management port number
mgmtProtocol - Name of the protocol used by the agent's JMXConnectorServer
configuredInterval - For a general agent, the time interval between discovery broadcasts

MgmtDeviceInfo

public MgmtDeviceInfo(java.lang.String systemId,
                      int deviceType,
                      java.lang.String deviceId,
                      int mgmtPort)
Constructor to obtain an instance containing the minumum values required to determine equality

See Also:
MgmtDeviceInfo(String, int, String, InetAddress, int, String, int)
Method Detail

BuildKey

public java.lang.String BuildKey()
Returns:
A unique String key based on the agent information

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object
See Also:
Object.toString()

equals

public boolean equals(java.lang.Object o)
Determines equality based on device id, device type, system id, and management port

Overrides:
equals in class java.lang.Object
See Also:
Object.equals(java.lang.Object)

getMissedTics

public int getMissedTics()
Returns:
The number of seconds since a discovery packet has been received by the MgmtMasterHealthMBean

setMissedTics

public void setMissedTics(int i)
Parameters:
i - New MissedTics value
See Also:
getMissedTics()

getDeviceType

public int getDeviceType()
Returns:
The numerical device type for the device, as defined in MgmtConst

getSystemId

public java.lang.String getSystemId()
Returns:
The system identifier for this agent, which is a combination of device ID and management port

getDeviceId

public java.lang.String getDeviceId()
Returns:
The device identifier for this device

getAddress

public java.net.InetAddress getAddress()
Returns:
The address of the interface used for management

getMgmtPort

public int getMgmtPort()
Returns:
Port number used for management

getMgmtProtocol

public java.lang.String getMgmtProtocol()
Returns:
Name of the protocol used by the agent's JMXConnectorServer

getAgentType

public int getAgentType()
Returns:
The type of agent, either MASTER_AGENT, or GENERAL_AGENT

setAgentType

protected void setAgentType(int agentType)
Parameters:
agentType - The new agent type
See Also:
getAgentType()

decrementConnectionTics

protected void decrementConnectionTics()
See Also:
getConnectionTics()

getConnectionTics

protected int getConnectionTics()
Returns:
The number of seconds since the last connection attempt to this agent by the Master Agent

getAgentStartTime

public long getAgentStartTime()
Returns:
The time in milliseconds when this agent was started

setAgentStartTime

protected void setAgentStartTime(long agentStartTime)
Parameters:
agentStartTime - New start time
See Also:
getAgentStartTime()

setMbeanQueryString

public void setMbeanQueryString(java.lang.String string)
                         throws javax.management.MalformedObjectNameException
Parameters:
string - New value
Throws:
javax.management.MalformedObjectNameException - Invalid query string
See Also:
getMbeanQueryString()

getMbeanQueryString

public java.lang.String getMbeanQueryString()
Returns:
The default MBean query string used by the Master Agent to determine the MBeans to proxy

getConnectionAttempted

public boolean getConnectionAttempted()
Returns:
True if an attempt has been made to contact the remote MgmtAgent

setConnectionAttempted

public void setConnectionAttempted(boolean connectionAttempted)
Parameters:
connectionAttempted - New connection attemp status
See Also:
getConnectionAttempted()


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