com.sun.management.comm
Class SnmpV3InformRequest

java.lang.Object
  com.sun.management.comm.SnmpInformRequest
      com.sun.management.comm.SnmpV3InformRequest

All Implemented Interfaces:

SnmpDefinitions

public class SnmpV3InformRequest
extends SnmpInformRequest

This class is used by the SNMP adaptor server to send inform requests to an SNMP V3 manager and receive inform responses.

This class provides basic functions that enable you to fire inform requests, handle retries, timeouts, and process responses from the manager.
The SNMP adaptor server specifies the destination of the inform request and controls the size of a single inform request/response to fit into its bufferSize. It specifies the maximum number of tries and the timeout to be used for the inform requests.

Each inform request, when ready to be sent, is assigned a unique identifier which helps in identifying the inform request with matching inform responses to the protocol engine lying transparently underneath. The engine does the job of retrying the inform requests when the timer expires and calls the SNMP adaptor server when a timeout occurs after exhausting the maximum number of tries.

The inform request object provides the method, waitForCompletion(long time), which enables a user to operate in a synchronous mode with an inform request. This is done by blocking the user thread for the desired time interval. The user thread gets notified whenever a request reaches completion, independently of the status of the response.

If an inform callback is provided when sending the inform request, the user operates in an asynchronous mode with the inform request. The user thread is not blocked and the specific inform callback implementation provided by the user is invoked when the inform response is received.

Since:

Java DMK 5.1

Field Summary

Fields inherited from class com.sun.management.comm.SnmpInformRequest

stAborted, stInProgress, stInternalError, stNeverUsed, stReceivedReply, stResultsAvailable, stTimeout, stWaitingForReply, stWaitingToSend

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

Method Summary

SnmpVarBindList	getReportVarBindList() Gets the report SnmpVarBindList.
boolean	isReport() Test if the received reply is an SNMP report.
boolean	isResponse() Test if the received reply is an SNMP response.

Methods inherited from class com.sun.management.comm.SnmpInformRequest

cancelRequest, finalize, getAbsMaxTimeToWait, getAbsNextPollTime, getErrorIndex, getErrorStatus, getMaxTries, getNumTries, getRequestId, getRequestStatus, getResponseVarBindList, inProgress, isAborted, isResultAvailable, notifyClient, snmpErrorToString, toString, waitForCompletion

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getReportVarBindList

public SnmpVarBindList getReportVarBindList()

Gets the report SnmpVarBindList. The contents of it are not guaranteed to be consistent when the request is active. It should be called if isReport() is true.

Returns:

The SnmpVarBindList received in the report.

isReport

public boolean isReport()

Test if the received reply is an SNMP report.

Returns:

The test result. true if a report is received, false otherwise.

isResponse

public boolean isResponse()

Test if the received reply is an SNMP response.

Returns:

The test result. true if a response is received, false otherwise.