Package org.snmp4j.agent.agentx
Class AgentXRequestPDU
java.lang.Object
org.snmp4j.agent.agentx.AgentXPDU
org.snmp4j.agent.agentx.AgentXContextPDU
org.snmp4j.agent.agentx.AgentXRequestPDU
- All Implemented Interfaces:
Serializable
- Direct Known Subclasses:
AgentXGetBulkPDU
,AgentXGetNextPDU
,AgentXGetPDU
The
AgentXRequestPDU
represents the base class for all agentx-Get*Request-PDUs defined by RFC 2741.- See Also:
-
Field Summary
Fields inherited from class org.snmp4j.agent.agentx.AgentXContextPDU
context
Fields inherited from class org.snmp4j.agent.agentx.AgentXPDU
AGENTX_ADDAGENTCAPS_PDU, AGENTX_CLEANUPSET_PDU, AGENTX_CLOSE_PDU, AGENTX_COMMITSET_PDU, AGENTX_GET_PDU, AGENTX_GETBULK_PDU, AGENTX_GETNEXT_PDU, AGENTX_INDEXALLOCATE_PDU, AGENTX_INDEXDEALLOCATE_PDU, AGENTX_NOTIFY_PDU, AGENTX_OPEN_PDU, AGENTX_PING_PDU, AGENTX_REGISTER_PDU, AGENTX_REMOVEAGENTCAPS_PDU, AGENTX_RESPONSE_PDU, AGENTX_TESTSET_PDU, AGENTX_UNDOSET_PDU, AGENTX_UNREGISTER_PDU, byteOrder, flags, packetID, RESERVED, sessionID, transactionID, type, version
-
Constructor Summary
ModifierConstructorDescriptionprotected
AgentXRequestPDU
(byte type, org.snmp4j.smi.OctetString context) Creates aAgentXRequestPDU
from payload values.protected
AgentXRequestPDU
(byte type, org.snmp4j.smi.OctetString context, org.snmp4j.agent.MOScope[] ranges) Creates aAgentXRequestPDU
from payload values.protected
AgentXRequestPDU
(AgentXMessageHeader header) Creates aAgentXRequestPDU
from aAgentXMessageHeader
. -
Method Summary
Modifier and TypeMethodDescriptionprotected void
decodeAfterContext
(ByteBuffer buf, int length) Decode this PDU after the end of the encoded context.protected void
Encode this PDU after already encoded context (thus context will not be encoded by this operation).protected int
Gets the encoded length after an already encoded context.org.snmp4j.agent.MOScope[]
Gets the ranges of this request.int
size()
Gets the size of the ranges array.protected String
Returns a string representation of the PDU members.Methods inherited from class org.snmp4j.agent.agentx.AgentXContextPDU
beforeEncode, decodePayload, encodePayload, getContext, getPayloadLength, setContext
Methods inherited from class org.snmp4j.agent.agentx.AgentXPDU
addFlag, decode, encode, getByteOrder, getFlags, getPacketID, getSessionID, getTransactionID, getType, getVersion, isConfirmedPDU, isFlagSet, setByteOrder, setFlags, setPacketID, setSessionAttributes, setSessionID, setTransactionID, setType, setVersion, toString
-
Field Details
-
ranges
protected org.snmp4j.agent.MOScope[] rangesThe request ranges.
-
-
Constructor Details
-
AgentXRequestPDU
protected AgentXRequestPDU(byte type, org.snmp4j.smi.OctetString context) Creates aAgentXRequestPDU
from payload values.- Parameters:
type
- the PDU type.context
- the SNMPv3 context.
-
AgentXRequestPDU
protected AgentXRequestPDU(byte type, org.snmp4j.smi.OctetString context, org.snmp4j.agent.MOScope[] ranges) Creates aAgentXRequestPDU
from payload values.- Parameters:
type
- the PDU type.context
- the SNMPv3 context.ranges
- the requested ranges.
-
AgentXRequestPDU
Creates aAgentXRequestPDU
from aAgentXMessageHeader
.- Parameters:
header
- the message header.
-
-
Method Details
-
decodeAfterContext
Description copied from class:AgentXContextPDU
Decode this PDU after the end of the encoded context.- Specified by:
decodeAfterContext
in classAgentXContextPDU
- Parameters:
buf
- the buffer positioned at the end of the encoded context.length
- the length of the PDU to be decoded.- Throws:
IOException
- if the buffer contains less data than expected.
-
encodeAfterContext
Description copied from class:AgentXContextPDU
Encode this PDU after already encoded context (thus context will not be encoded by this operation).- Specified by:
encodeAfterContext
in classAgentXContextPDU
- Parameters:
buf
- the target buffer.
-
getAfterContextLength
protected int getAfterContextLength()Description copied from class:AgentXContextPDU
Gets the encoded length after an already encoded context.- Specified by:
getAfterContextLength
in classAgentXContextPDU
- Returns:
- the BER encoded length (without context).
-
size
public int size()Gets the size of the ranges array.- Returns:
- the number of ranges in this request.
-
getRanges
public org.snmp4j.agent.MOScope[] getRanges()Gets the ranges of this request.- Returns:
- an array of
MOScope
instances.
-
toStringExtMembers
Description copied from class:AgentXPDU
Returns a string representation of the PDU members. An empty string is returned by this base class.- Overrides:
toStringExtMembers
in classAgentXContextPDU
- Returns:
- a string representation of the PDU members.
-