* The class contains the following properties: *
This API is a Sun Microsystems internal API and is subject * to change without notice.
* @see com.sun.jmx.snmp.SnmpParameters */ public class SnmpPeer implements Serializable { // PUBLIC VARIABLES //----------------- /** * The default SNMP packet size of an SNMP request (2 * 1024). *SnmpPduFactoryBER.
*/
private SnmpPduFactory pduFactory = new SnmpPduFactoryBER() ;
/**
* The maximum round trip time for a packet with the peer.
*/
private long _maxrtt ;
/**
* The minimum round trip time for a packet with the peer.
*/
private long _minrtt ;
/**
* The average round trip time for a packet with the peer.
*/
private long _avgrtt ;
/**
* SNMP parameters for this peer are valid for all requests using this peer.
* @see com.sun.jmx.snmp.SnmpParameters
*/
private SnmpParams _snmpParameter = new SnmpParameters() ;
/**
* Internet address of the peer to be used when communicating with the peer.
*/
private InetAddress _devAddr = null ;
/**
* Maximum packet size of the request PDU. This can be set by the user.
* If the request crosses this limit while encoding, the request is automatically split
* into multiple small request. Each of these requests will again be within this limit.
* The default value is (2 * 1024).
*/
private int maxSnmpPacketSize = defaultSnmpRequestPktSize ;
/**
* List of alternate addresses.
*/
InetAddress _devAddrList[] = null ;
/**
* The index of address currently being used.
*/
int _addrIndex = 0 ;
private boolean customPduFactory = false;
// CONSTRUCTORS
//-------------
/**
* Creates an SNMP peer object for a device. The default port is 161.
* @param host The peer name.
* @exception UnknownHostException If the host name cannot be resolved.
*/
public SnmpPeer(String host) throws UnknownHostException {
this(host, (int)161) ;
}
/**
* Creates an SNMP peer object for a device. The default port is 161.
* @param netaddr The peer InetAddress.
* @param port The port number.
*/
public SnmpPeer(InetAddress netaddr, int port) {
_devAddr = netaddr ;
portNum = port;
}
/**
* Creates an SNMP peer object for a device. The default port is 161.
* @param netaddr The peer InetAddress.
*/
public SnmpPeer(InetAddress netaddr) {
_devAddr = netaddr ;
}
/**
* Creates an SNMP peer object for a device with the specified port.
* @param host The peer name.
* @param port The port number.
* @exception UnknownHostException If the host name cannot be resolved.
*/
public SnmpPeer(String host, int port) throws UnknownHostException {
useIPAddress(host) ;
portNum = port;
}
// PUBLIC METHODS
//---------------
/**
* Sets a specific IP address to which the peer will communicate.
* Typically used to set an alternate IP address or a specific address which is known to respond to requests.
* The IP address String can either be a machine name, such as ibiza,
* or a String representing its IP address, such as "206.26.48.100".
* @param ipaddr Dot formatted IP address or logical host name.
* @exception UnknownHostException If the host name cannot be resolved.
*/
final public synchronized void useIPAddress(String ipaddr) throws UnknownHostException {
_devAddr = InetAddress.getByName(ipaddr) ;
}
/**
* Returns the dot-formatted IP address string (for example 171.69.220.224).
* Useful when you want to know which IP address is used
* when the address was resolved using a DNS name.
* @return The dot-formatted IP address being used.
*/
final public synchronized String ipAddressInUse() {
byte [] adr = _devAddr.getAddress() ;
return
(adr[0]&0xFF) + "." + (adr[1]&0xFF) + "." +
(adr[2]&0xFF) + "." + (adr[3]&0xFF);
}
/**
* Specifies the list of addresses to be used. When a host is not responding
* the user can switch to the next address by calling useNextAddress.
* @param adrList The list of InetAddresses.
*/
final public synchronized void useAddressList(InetAddress adrList[]) {
_devAddrList = adrList ;
_addrIndex = 0 ;
useNextAddress() ;
}
/**
* Causes all subsequent requests to go to the new address
* obtained from the specified list of alternate addresses.
* If it reaches the end of list, it starts again at the first address.
*/
final public synchronized void useNextAddress() {
if (_devAddrList == null)
return ;
/* NPCTE fix for bug 4486059, esc 0 MR 03-August-2001 */
/* if (_addrIndex > _devAddrList.length) */
if (_addrIndex > _devAddrList.length-1)
/* end of NPCTE fix for bugid 4486059 */
_addrIndex = 0 ;
_devAddr = _devAddrList[_addrIndex++] ;
}
/**
* Determines whether an SNMP set operation is allowed with this
* peer object. For now it just makes sure a parameter is configured for a write operation.
* @return true if SNMP set is allowed and the parameter is configured,
* false otherwise.
*/
public boolean allowSnmpSets() {
return _snmpParameter.allowSnmpSets() ;
}
/**
* Compares the two peer objects to determine whether they are the same. This is used
* to determine whether requests can be multiplexed.
* @param obj The object to compare this with.
* @return true if they are referring to same peer and using same address;
* false otherwise.
*/
public boolean equals(Object obj) {
if (this == obj)
return true ;
/*
if (obj instanceof SnmpPeer) {
SnmpPeer peer = (SnmpPeer) obj ;
if (_devAddr.equals(peer.getDestAddr()) &&
portNum == peer.getDestPort())
return true ;
}
*/
return false ;
}
/**
* Gets the list of alternate InetAddress configured for this peer.
* @return The InetAddress of the peer.
*/
final public InetAddress[] getDestAddrList() {
return _devAddrList;
}
/**
* Gets the InetAddress object for this peer.
* @return The InetAddress of the peer.
*/
final public InetAddress getDestAddr() {
return _devAddr ;
}
/**
* Gets the destination port number of the peer to which SNMP requests are to be sent.
* @return The destination port number.
*/
final public int getDestPort() {
return portNum ;
}
/**
* Changes the port address of the destination for the request.
* @param newPort The destination port.
*/
final public synchronized void setDestPort(int newPort) {
portNum = newPort ;
}
/**
* Gets the timeout to wait for a response from the peer.
* @return The value of the timeout property.
*/
final public int getTimeout() {
return timeout;
}
/**
* Changes the timeout to wait for a response from the peer.
* @param newTimeout The timeout (in milliseconds).
*/
final public synchronized void setTimeout(int newTimeout) {
if (newTimeout < 0)
throw new IllegalArgumentException();
timeout= newTimeout;
}
/**
* Gets the number of times to try before giving up.
* @return The maximun number of tries.
*/
final public int getMaxTries() {
return maxTries;
}
/**
* Changes the maximun number of times to try before giving up.
* @param newMaxTries The maximun number of tries.
*/
final public synchronized void setMaxTries(int newMaxTries) {
if (newMaxTries < 0)
throw new IllegalArgumentException();
maxTries= newMaxTries;
}
/**
* Gets the name specified in the constructor while creating this object.
* @return The name of the host as specified while creating this object.
*/
final public String getDevName() {
return getDestAddr().getHostName() ;
}
/**
* Returns the String representation for this SnmpPeer.
* @return The String representation.
*/
public String toString() {
return "Peer/Port : " + getDevName() + "/" + getDestPort() ;
}
/**
* Gets the maximum number of variable bindings that can be sent to a peer.
* @return The maximum variable bindings that can be encoded into a request packet.
*/
final public synchronized int getVarBindLimit() {
return maxVarBindLimit ;
}
/**
* Configures the maximum number of variable bindings that can be sent to a peer.
* @param limit The desired limit.
*/
final public synchronized void setVarBindLimit(int limit) {
maxVarBindLimit = limit ;
}
/**
* Sets the SnmpParams object associated with the peer.
* @param params The desired parameters.
*/
public void setParams(SnmpParams params) {
_snmpParameter = params;
}
/**
* Gets the SnmpParams object associated with the peer.
* @return The associated parameters.
*/
public SnmpParams getParams() {
return _snmpParameter;
}
/**
* Gets the maximum request packet size that is currently used.
* @return The maximum request packet size.
*/
final public int getMaxSnmpPktSize() {
return maxSnmpPacketSize ;
}
/**
* Configures the maximum packet size that can be used when generating an SNMP request.
* @param newsize The desired packet size.
*/
final public synchronized void setMaxSnmpPktSize(int newsize) {
maxSnmpPacketSize = newsize ;
}
boolean isCustomPduFactory() {
return customPduFactory;
}
/**
* Finalizer of the SnmpPeer objects.
* This method is called by the garbage collector on an object
* when garbage collection determines that there are no more references to the object.
* Sets all the references to this SNMP peer object to null.
*/
public void finalize() {
_devAddr = null ;
_devAddrList = null ;
_snmpParameter = null ;
}
/**
* Gets the minimum round trip time for a packet with the peer.
* @return The minimum round trip time for a packet with the peer.
*/
public long getMinRtt() {
return _minrtt ;
}
/**
* Gets the maximum round trip time for a packet with the peer.
* @return The maximum round trip time for a packet with the peer.
*/
public long getMaxRtt() {
return _maxrtt ;
}
/**
* Gets the average round trip time for a packet with the peer.
* @return The average round trip time for a packet with the peer.
*/
public long getAvgRtt() {
return _avgrtt ;
}
// PRIVATE METHODS
//----------------
private void updateRttStats(long tm) {
if (_minrtt > tm)
_minrtt = tm ;
else if (_maxrtt < tm)
_maxrtt = tm ;
else
_avgrtt = tm ; // to do later.
}
}