SnmpSession (Open source project for the Java Dynamic Management Kit 1.0 API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.sun.management.snmp.manager
Class SnmpSession

java.lang.Object
  com.sun.management.snmp.manager.SnmpSession

All Implemented Interfaces:: SnmpDefinitions, Serializable, Runnable

public class SnmpSession
extends Object
implements SnmpDefinitions, Runnable, Serializable
extends Object
implements SnmpDefinitions, Runnable, Serializable

Creates, controls, and manages one or more requests. A session is associated with one SnmpEngine (see RFC 2571). It can construct the engine or make use of an already created one. A session can be bound to a peer so that all requests created (without specifying a peer) will use this as the default. Alternatively, there can be a mixture of peers, that is, two requests can talk to two different peers.

In a typical manager application, a single engine is needed. So you should share a session within your process.

WARNING: Be aware that if you instantiate another session, you will instantiate another engine.

Each SnmpSession has a dispatcher, which is a thread used to service all the requests it creates. Each SnmpSession uses a separate socket for sending requests and receiving responses. The socket imposes an upper limit on the size of response packets. Any packet which exceeds this limit is truncated. By default, this limit is SnmpPeer.defaultSnmpResponsePktSize. It can be changed using setResponsePktSize(int).

This class implements an SNMP command interface which provides a variety of convenience methods that are used to create requests. Each of the requests performs a specific SNMP operation. These methods are simple to use and automatically start the request. The session maintains the list of all active requests and responses.

Users can explicitly create and start requests. This is usually not required for most applications.

Each method provides specific SNMP operations like SnmpGet, SnmpGetNext and SnmpSet. The SnmpGet and SnmpGetNext operations can be either poll or non-poll. In addition, there is a convenience method which automatically walks through a set of instances starting at any arbitrary place in the MIB hierarchy and terminates when a specified condition becomes true.

The requests are retried when the peer does not respond within a specified time. There is a maximum try limit. Certain options of sessions can be configured using the SnmpOptions object. This allows enabling and disabling of features like fixing protocol data units (PDU) on error, handling SnmpTooBig errors and multiplexing requests. If not specified, the default value sets the following options:

multiplex allowed
fix PDU on error
handle too big PDU

Once a session is created the user can perform one or more SNMP operations in a one-at-a-time sequence. Usually this sequence is a set of logical operations which together form a complete operation. For example, a SnmpSet operation, which involves an initial query to the agent for obtaining a valid index. This is followed by one or more SnmpSet commands to complete the set operation.

At any time, one or more requests active in a session can be canceled.

Since:: Java DMK 5.1
See Also:: SnmpRequest, Serialized Form

Field Summary
`String`	`sessionName` The name identifying this session.
`SnmpOptions`	`snmpOptions` Set of options used to configure all `SnmpRequests` created in this session.

Fields inherited from interface com.sun.management.snmp.SnmpDefinitions
authMask, authNoPriv, authPriv, authPrivMask, CtxtConsFlag, noAuthNoPriv, noGroupName, noSuchContext, noSuchView, notInView, pduGetBulkRequestPdu, pduGetNextRequestPdu, pduGetRequestPdu, pduGetResponsePdu, pduInformRequestPdu, pduReportPdu, pduSetRequestPdu, pduV1TrapPdu, pduV2TrapPdu, pduWalkRequest, privMask, reportableFlag, snmpAuthNotSupported, snmpBadSecurityLevel, snmpPrivNotSupported, snmpReqAborted, snmpReqEncodingError, snmpReqHandleTooBig, snmpReqInternalError, snmpReqPacketOverflow, snmpReqRefireAfterVbFix, snmpReqSocketIOError, snmpReqTimeout, snmpReqTooBigImpossible, snmpReqUnknownError, snmpRspAuthorizationError, snmpRspBadValue, snmpRspCommitFailed, snmpRspDecodingError, snmpRspEndOfTable, snmpRspGenErr, snmpRspInconsistentName, snmpRspInconsistentValue, snmpRspNoAccess, snmpRspNoCreation, snmpRspNoError, snmpRspNoSuchName, snmpRspNotWritable, snmpRspReadOnly, snmpRspResourceUnavailable, snmpRspTooBig, snmpRspUndoFailed, snmpRspWrongEncoding, snmpRspWrongLength, snmpRspWrongType, snmpRspWrongValue, snmpUnknownPrincipal, snmpUsmBadEngineId, snmpUsmInvalidTimeliness, snmpUsmSecurityModel, snmpV1AccessControlModel, snmpV1MsgProcessingModel, snmpV1SecurityModel, snmpV2AccessControlModel, snmpV2MsgProcessingModel, snmpV2SecurityModel, snmpV3AccessControlModel, snmpV3MsgProcessingModel, snmpVersionOne, snmpVersionThree, snmpVersionTwo, snmpWrongSnmpVersion, trapAuthenticationFailure, trapColdStart, trapEgpNeighborLoss, trapEnterpriseSpecific, trapLinkDown, trapLinkUp, trapWarmStart

Fields inherited from interface com.sun.management.snmp.SnmpDefinitions

authMask, authNoPriv, authPriv, authPrivMask, CtxtConsFlag, noAuthNoPriv, noGroupName, noSuchContext, noSuchView, notInView, pduGetBulkRequestPdu, pduGetNextRequestPdu, pduGetRequestPdu, pduGetResponsePdu, pduInformRequestPdu, pduReportPdu, pduSetRequestPdu, pduV1TrapPdu, pduV2TrapPdu, pduWalkRequest, privMask, reportableFlag, snmpAuthNotSupported, snmpBadSecurityLevel, snmpPrivNotSupported, snmpReqAborted, snmpReqEncodingError, snmpReqHandleTooBig, snmpReqInternalError, snmpReqPacketOverflow, snmpReqRefireAfterVbFix, snmpReqSocketIOError, snmpReqTimeout, snmpReqTooBigImpossible, snmpReqUnknownError, snmpRspAuthorizationError, snmpRspBadValue, snmpRspCommitFailed, snmpRspDecodingError, snmpRspEndOfTable, snmpRspGenErr, snmpRspInconsistentName, snmpRspInconsistentValue, snmpRspNoAccess, snmpRspNoCreation, snmpRspNoError, snmpRspNoSuchName, snmpRspNotWritable, snmpRspReadOnly, snmpRspResourceUnavailable, snmpRspTooBig, snmpRspUndoFailed, snmpRspWrongEncoding, snmpRspWrongLength, snmpRspWrongType, snmpRspWrongValue, snmpUnknownPrincipal, snmpUsmBadEngineId, snmpUsmInvalidTimeliness, snmpUsmSecurityModel, snmpV1AccessControlModel, snmpV1MsgProcessingModel, snmpV1SecurityModel, snmpV2AccessControlModel, snmpV2MsgProcessingModel, snmpV2SecurityModel, snmpV3AccessControlModel, snmpV3MsgProcessingModel, snmpVersionOne, snmpVersionThree, snmpVersionTwo, snmpWrongSnmpVersion, trapAuthenticationFailure, trapColdStart, trapEgpNeighborLoss, trapEnterpriseSpecific, trapLinkDown, trapLinkUp, trapWarmStart

Constructor Summary
`SnmpSession(SnmpEngineParameters parameters, SnmpEngineFactory factory, String name, SnmpPeer apeer)` Constructor for creating a new session.
`SnmpSession(SnmpEngineParameters parameters, SnmpEngineFactory factory, String name, SnmpPeer apeer, InetAddress localaddress, int port)` Constructor for creating a new session.
`SnmpSession(SnmpEngineParameters parameters, SnmpEngineFactory factory, String name, SnmpPeer apeer, InetSocketAddress localaddress)` Constructor for creating a new session.
`SnmpSession(SnmpEngine engine, String name, SnmpPeer apeer)` Constructor for creating a new session.
`SnmpSession(String name)` Constructor for creating a new session.
`SnmpSession(String name, SnmpPeer apeer)` Constructor for creating a new session.

Method Summary
`boolean`	`anyPendingResponses()` Indicates whether there are any responses available for processing.
`void`	`cancelAllRequests()` Cancels all pending requests in this session.
`boolean`	`checkResponseFor(SnmpRequest req)` Indicates whether a response was received for this request.
`void`	`destroySession()` Destroys any pending requests and then stops the session.
`void`	`finalize()` Finalizer of the `SnmpSession` objects.
`Vector`	`getAllRequestsForPeer(SnmpPeer apeer)` Gets a list of requests which have the specified destination.
`SnmpPeer`	`getDefaultPeer()` Gets a default peer (if any) bound to this session.
`SnmpEngine`	`getEngine()` Engine the `SnmpSession` is linked with.
`SnmpEngineId`	`getEngineId()` Get the local engine Id.
`int`	`getInPkts()` Gets the number of packets received.
`String`	`getName()` Gets the session name (often used in identification).
`int`	`getOutPkts()` Gets the number of packets sent.
`SnmpPduFactory`	`getPduFactory()` Gets the PDU factory.
`int`	`getPktsErrors()` Gets the number of errors that occurred.
`int`	`getResponsePktSize()` Gets the maximum size allowed for response packet.
`void`	`hideInvalidResponseError(boolean hide)` Hides invalid response errors.
`boolean`	`isInvalidResponseErrorHidden()` Checks if invalid response errors are hidden.
`boolean`	`isSessionActive()` Indicates whether the thread for this session is active.
`void`	`performResetPktStatistics()` Reset all the counters.
`void`	`run()` Dispatcher method for this session thread.
`void`	`setDefaultPeer(SnmpPeer apeer)` Sets peer as default.
`void`	`setName(String name)` Sets the session name (often used in identification).
`void`	`setPduFactory(SnmpPduFactory factory)` Sets the PDU factory.
`void`	`setResponsePktSize(int size)` Sets the maximum size allowed for response packet.
`SnmpRequest`	`snmpGetBulkRequest(SnmpPeer peer, SnmpRequestHandler cb, SnmpVarBindList vblst, int nonRepeat, int maxRepeat)` Performs a single SNMP `getbulk` request on the variable binding list.
`SnmpRequest`	`snmpGetBulkRequest(SnmpRequestHandler cb, SnmpVarBindList vblst, int nonRepeat, int maxRepeat)` Performs a single SNMP `getbulk` request on the variable binding list.
`SnmpRequest`	`snmpGetNextPollRequest(SnmpPeer peer, SnmpRequestHandler cb, SnmpVarBindList vblst, int intrvl)` Starts polling the peer at the specified intervals, for the MIB variables in the variable binding list.
`SnmpRequest`	`snmpGetNextPollRequest(SnmpRequestHandler cb, SnmpVarBindList vblst, int intrvl)` Starts polling the peer at the specified intervals, for the MIB variables in the variable binding list.
`SnmpRequest`	`snmpGetNextRequest(SnmpPeer peer, SnmpRequestHandler cb, SnmpVarBindList vblst)` Performs a single SNMP `getnext` request on the variable binding list.
`SnmpRequest`	`snmpGetNextRequest(SnmpRequestHandler cb, SnmpVarBindList vblst)` Performs a single SNMP `getnext` request on the variable binding list.
`SnmpRequest`	`snmpGetPollRequest(SnmpPeer peer, SnmpRequestHandler cb, SnmpVarBindList vblst, int intrvl)` Starts polling the peer at the specified intervals, for the MIB variables in the variable binding list.
`SnmpRequest`	`snmpGetPollRequest(SnmpRequestHandler cb, SnmpVarBindList vblst, int intrvl)` Starts polling the peer at the specified intervals, for the MIB variables in the variable binding list.
`SnmpRequest`	`snmpGetRequest(SnmpPeer peer, SnmpRequestHandler cb, SnmpVarBindList vblst)` Performs a single SNMP `get` request on the variable binding list.
`SnmpRequest`	`snmpGetRequest(SnmpRequestHandler cb, SnmpVarBindList vblst)` Performs a single SNMP `get` request on the variable binding list.
`SnmpRequest`	`snmpInformRequest(SnmpPeer peer, SnmpRequestHandler cb, SnmpOid trapOid, SnmpVarBindList vblst)` Performs a single SNMP `inform` request on the variable binding list.
`SnmpRequest`	`snmpInformRequest(SnmpRequestHandler cb, SnmpOid trapOid, SnmpVarBindList vblst)` Performs a single SNMP `inform` request on the variable binding list.
`SnmpRequest`	`snmpSetRequest(SnmpPeer peer, SnmpRequestHandler cb, SnmpVarBindList vblst)` Performs a single SNMP `set` request on the peer for the specified variable binding list.
`SnmpRequest`	`snmpSetRequest(SnmpRequestHandler cb, SnmpVarBindList vblst)` Performs a single SNMP `set` request on the peer for the specified variable binding list.
`SnmpRequest`	`snmpWalkUntilRequest(SnmpPeer peer, SnmpRequestHandler cb, SnmpVarBindList vblst, SnmpOid key)` Walks through the lexicographic ordering of the agent MIB.
`SnmpRequest`	`snmpWalkUntilRequest(SnmpRequestHandler cb, SnmpVarBindList vblst, SnmpOid key)` Walks through the lexicographic ordering of the agent MIB.
`boolean`	`syncInProgress()` Indicates whether this session is performing synchronous operation for a request.
`boolean`	`thisSessionContext()` Returns `true` if the current executing thread is this session's dispatcher.
`String`	`toString()` Gets a `String` representation of the session.

Methods inherited from class java.lang.Object
`clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Field Detail

sessionName

public String sessionName

The name identifying this session. Useful in debugging a session.

snmpOptions

public SnmpOptions snmpOptions

Set of options used to configure all SnmpRequests created in this session. The user can manipulate the options directly. Note that this variable is public.

Constructor Detail

SnmpSession

public SnmpSession(SnmpEngine engine,
                   String name,
                   SnmpPeer apeer)
            throws SnmpStatusException,
                   IllegalArgumentException

Constructor for creating a new session. The given


 SnmpEngine

is used.

Parameters:: engine - The engine to use.; name - The session name.; apeer - The default peer to which to send requests.
Throws:: SnmpStatusException - Unable to initialize the SNMP Datagram Socket.; IllegalArgumentException - if the passed engine is null.