Package org.snmp4j.agent.agentx

Class AgentXContextPDU

java.lang.Object

org.snmp4j.agent.agentx.AgentXPDU

org.snmp4j.agent.agentx.AgentXContextPDU

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AgentXAddAgentCapsPDU, AgentXPingPDU, AgentXRegisterPDU, AgentXRemoveAgentCapsPDU, AgentXRequestPDU, AgentXVariableBindingPDU

public abstract class AgentXContextPDU
extends AgentXPDU

A AgentXContextPDU is a AgentXPDU with context support.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected org.snmp4j.smi.OctetString	context	The SNMPv43 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

Constructors

Modifier	Constructor	Description
protected	AgentXContextPDU(byte type, byte flags, int sessionID, int transactionID, int packetID)	Creates a AgentXContextPDU.
protected	AgentXContextPDU(byte type, org.snmp4j.smi.OctetString context)	Create a AgentXPDU from its type.
protected	AgentXContextPDU(AgentXMessageHeader header)	Creates a AgentXContextPDU from a AgentXMessageHeader.

Method Summary

Modifier and Type	Method	Description
protected void	beforeEncode()	Initialize flags and other things before a PDU is encoded.
protected abstract void	decodeAfterContext(ByteBuffer buf, int length)	Decode this PDU after the end of the encoded context.
final void	decodePayload(ByteBuffer buf, int length)	Decode the PDU payload from the ByteBuffer.
protected abstract void	encodeAfterContext(ByteBuffer buf)	Encode this PDU after already encoded context (thus context will not be encoded by this operation).
final void	encodePayload(ByteBuffer buf)	Encode this PDU payload to the given ByteBuffer.
protected abstract int	getAfterContextLength()	Gets the encoded length after an already encoded context.
org.snmp4j.smi.OctetString	getContext()	Gets the context.
final int	getPayloadLength()	Gets the payload length.
void	setContext(org.snmp4j.smi.OctetString context)	Sets the context.
protected String	toStringExtMembers()	Returns a string representation of the PDU members.

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

Methods inherited from class java.lang.Object

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

Field Details

context

protected org.snmp4j.smi.OctetString context

The SNMPv43 context.

Constructor Details

AgentXContextPDU

protected AgentXContextPDU(byte type,
 org.snmp4j.smi.OctetString context)

Create a AgentXPDU from its type.

Parameters:

type - a AgentX PDU type from AgentXPDU.AGENTX_OPEN_PDU to AgentXPDU.AGENTX_RESPONSE_PDU.

context - the context.

AgentXContextPDU

protected AgentXContextPDU(AgentXMessageHeader header)

Creates a AgentXContextPDU from a AgentXMessageHeader.

Parameters:

header - the message header.

AgentXContextPDU

protected AgentXContextPDU(byte type,
 byte flags,
 int sessionID,
 int transactionID,
 int packetID)

Creates a AgentXContextPDU.

Parameters:

type - a AgentX PDU type from AgentXPDU.AGENTX_OPEN_PDU to AgentXPDU.AGENTX_RESPONSE_PDU.

flags - a set of flags (bit-or), see also AgentXProtocol.FLAG_NETWORK_BYTE_ORDER.

sessionID - a session ID.

transactionID - a transaction ID.

packetID - a packet ID.

Method Details

decodeAfterContext

protected abstract void decodeAfterContext(ByteBuffer buf,
 int length)
                                    throws IOException

Decode this PDU after the end of the encoded context.

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

protected abstract void encodeAfterContext(ByteBuffer buf)

Encode this PDU after already encoded context (thus context will not be encoded by this operation).

Parameters:

buf - the target buffer.

getAfterContextLength

protected abstract int getAfterContextLength()

Gets the encoded length after an already encoded context.

Returns:

the BER encoded length (without context).

decodePayload

public final void decodePayload(ByteBuffer buf,
 int length)
                         throws IOException

Decode the PDU payload from the ByteBuffer.

Specified by:

decodePayload in class AgentXPDU

Parameters:

buf - the byte buffer from which to decode the payload.

length - the length of the payload to decode.

Throws:

IOException - if the byte bufferdoes not contain the expected data.

encodePayload

public final void encodePayload(ByteBuffer buf)

Encode this PDU payload to the given ByteBuffer.

Specified by:

encodePayload in class AgentXPDU

Parameters:

buf - the byte buffer into which to encode the payload.

getPayloadLength

public final int getPayloadLength()

Gets the payload length.

Specified by:

getPayloadLength in class AgentXPDU

Returns:

the number of bytes needed to encode the payload.

getContext

public org.snmp4j.smi.OctetString getContext()

Gets the context.

Returns:

an OctetString representing the context.

setContext

public void setContext(org.snmp4j.smi.OctetString context)

Sets the context.

Parameters:

context - an OctetString representing the context.

toStringExtMembers

protected String 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 class AgentXPDU

Returns:

a string representation of the PDU members.

beforeEncode

protected void beforeEncode()

Initialize flags and other things before a PDU is encoded.

Specified by:

beforeEncode in class AgentXPDU