uk.co.westhawk.snmp.stack

Class PassiveSnmpContextv3

java.lang.Object

uk.co.westhawk.snmp.stack.AbstractSnmpContext

uk.co.westhawk.snmp.stack.SnmpContextv3Basis

uk.co.westhawk.snmp.stack.SnmpContextv3

uk.co.westhawk.snmp.stack.PassiveSnmpContextv3

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Runnable, java.util.EventListener, RawPduListener, SnmpContextBasisFace, SnmpContextv3Face

public class PassiveSnmpContextv3
extends SnmpContextv3

This class contains the SNMPv3 context that is needed by every Trapv2 to send a trap in environments where thread creation is unwanted. Note, this class is not suitable to send all PDUs, but only traps. This is because most PDUs need discovery, which will create threads.

This extends SnmpContextv3 so that it does not create any threads to send PDUs. It must be used with the PDU class PassiveTrapPduv2. The original purpose of the Passive classes is to allow the stack to be used in environments where thread creation is unwanted, eg database JVMs such as Oracle JServer. See SNMPv2-PDU.

See notes on how to send traps in an Oracle JServer environment.

Since:

6_2

Version:

$Revision$ $Date$

Author:

Russell Arrowsmith

See Also:

PassiveTrapPduv2

Field Summary

Fields inherited from class uk.co.westhawk.snmp.stack.SnmpContextv3Basis

authenticationProtocol, contextEngineId, contextName, privacyProtocol, useAuthentication, usePrivacy, userAuthenticationPassword, userAuthKeyMD5, userAuthKeySHA1, userName, userPrivacyPassword, userPrivKeyMD5, userPrivKeySHA1, usmAgent

Fields inherited from class uk.co.westhawk.snmp.stack.AbstractSnmpContext

anyPduExpectingResponse, bindAddr, hostname, hostPort, isDestroyed, maxRecvSize, pduSupport, trapSupport, typeSocket

Fields inherited from interface uk.co.westhawk.snmp.stack.SnmpContextv3Face

AES_ENCRYPT, Default_ContextName, Default_UserName, DES_ENCRYPT, MD5_PROTOCOL, ProtocolNames, SHA1_PROTOCOL, SNMPv1_Security_Model, SNMPv2c_Security_Model, USM_Security_Model

Fields inherited from interface uk.co.westhawk.snmp.stack.SnmpContextBasisFace

DEFAULT_PORT, MAXPDU, MSS, STANDARD_SOCKET, TCP_SOCKET

Constructor Summary

Constructors

Modifier	Constructor and Description
	PassiveSnmpContextv3(java.lang.String host, int port) Constructor.
	PassiveSnmpContextv3(java.lang.String host, int port, java.lang.String typeSocketA) Constructor.
protected	PassiveSnmpContextv3(java.lang.String host, int port, java.lang.String bindAddress, java.lang.String typeSocketA) Constructor.

Method Summary

Modifier and Type	Method and Description
protected void	activate() Overrides the AbstractSnmpContext.activate() to do nothing.

Methods inherited from class uk.co.westhawk.snmp.stack.SnmpContextv3

addRequestPduListener, clone, processIncomingPdu, processPotentialRequest, processPotentialTrap, removeRequestPduListener

Methods inherited from class uk.co.westhawk.snmp.stack.SnmpContextv3Basis

actualEncodePacket, addDiscoveryPdu, addPdu, addPdu, checkContextSanity, cloneParameters, createUsmAgent, encodeDiscoveryPacket, encodePacket, getAuthenticationProtocol, getContextEngineId, getContextName, getHashKey, getPrivacyProtocol, getUserAuthenticationPassword, getUserName, getUserPrivacyPassword, getUsmAgent, getVersion, isAuthoritative, isUseAuthentication, isUsePrivacy, processIncomingResponse, removePdu, setAuthenticationProtocol, setContextEngineId, setContextName, setPrivacyProtocol, setUseAuthentication, setUsePrivacy, setUserAuthenticationPassword, setUserName, setUserPrivacyPassword, setUsmAgent, toString

Methods inherited from class uk.co.westhawk.snmp.stack.AbstractSnmpContext

addRequestPduListener, addRequestPduListener, addTrapListener, addTrapListener, addTrapListener, destroy, freeTransmitters, getBindAddress, getDebugString, getHost, getHostAddress, getMaxRecvSize, getPort, getReceivedFromHostAddress, getSendToHostAddress, getTypeSocket, isDestroyed, rawPduReceived, removeRequestPduListener, removeRequestPduListener, removeTrapListener, removeTrapListener, removeTrapListener, run, sendPacket, setMaxRecvSize, stop

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface uk.co.westhawk.snmp.stack.SnmpContextBasisFace

addRequestPduListener, addRequestPduListener, addTrapListener, addTrapListener, addTrapListener, destroy, getBindAddress, getHost, getPort, getReceivedFromHostAddress, getSendToHostAddress, getTypeSocket, isDestroyed, removeRequestPduListener, removeRequestPduListener, removeTrapListener, removeTrapListener, removeTrapListener, sendPacket

Constructor Detail

PassiveSnmpContextv3

public PassiveSnmpContextv3(java.lang.String host,
                            int port)
                     throws java.io.IOException

Constructor.

Parameters:

host - The host to which the Pdu will be sent

port - The port where the SNMP server will be

Throws:

java.io.IOException

See Also:

SnmpContextv3.SnmpContextv3(String, int)

PassiveSnmpContextv3

public PassiveSnmpContextv3(java.lang.String host,
                            int port,
                            java.lang.String typeSocketA)
                     throws java.io.IOException

Constructor. Parameter typeSocketA should be either STANDARD_SOCKET, TCP_SOCKET or a fully qualified classname.

Parameters:

host - The host to which the Pdu will be sent

port - The port where the SNMP server will be

typeSocketA - The type of socket to use.

Throws:

java.io.IOException

See Also:

SnmpContextv3.SnmpContextv3(String, int, String), SnmpContextBasisFace.STANDARD_SOCKET, SnmpContextBasisFace.TCP_SOCKET

PassiveSnmpContextv3

protected PassiveSnmpContextv3(java.lang.String host,
                               int port,
                               java.lang.String bindAddress,
                               java.lang.String typeSocketA)
                        throws java.io.IOException

Constructor. If bindAddress is null, then the system will pick up a valid local address to bind the socket. The typeSocketA will indicate which type of socket to use. This way different handlers can be provided. It should be either STANDARD_SOCKET, TCP_SOCKET or a fully qualified classname.

Parameters:

host - The host to which the Pdu will be sent

port - The port where the SNMP server will be

bindAddress - The local address the server will bind to

typeSocketA - The type of socket to use.

Throws:

java.io.IOException - Thrown when the socket cannot be created.

See Also:

SnmpContextBasisFace.STANDARD_SOCKET, SnmpContextBasisFace.TCP_SOCKET

Method Detail

activate

protected void activate()

Overrides the AbstractSnmpContext.activate() to do nothing. This prevents the creation of threads in the base class.

Overrides:

activate in class AbstractSnmpContext

See Also:

AbstractSnmpContext.activate()