Package org.snmp4j.agent.agentx

Class AgentXVariableBindingPDU

java.lang.Object

org.snmp4j.agent.agentx.AgentXPDU

org.snmp4j.agent.agentx.AgentXContextPDU

org.snmp4j.agent.agentx.AgentXVariableBindingPDU

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AgentXIndexAllocatePDU, AgentXIndexDeallocatePDU, AgentXNotifyPDU, AgentXTestSetPDU

public class AgentXVariableBindingPDU
extends AgentXContextPDU

The AgentXVariableBindingPDU is the base class for all AgentX PDUs with a list of VariableBindings.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected org.snmp4j.smi.VariableBinding[]	variableBindings	The variable bindings in the PDU.

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

Constructors

Modifier	Constructor	Description
protected	AgentXVariableBindingPDU(byte type, byte flags, int sessionID, int transactionID, int packetID)	Creates a AgentXVariableBindingPDU from its type.
protected	AgentXVariableBindingPDU(byte type, org.snmp4j.smi.OctetString context, org.snmp4j.smi.VariableBinding[] vbs)	Creates a AgentXVariableBindingPDU from its type.
protected	AgentXVariableBindingPDU(AgentXMessageHeader header)	Creates a AgentXVariableBindingPDU from a AgentXMessageHeader.

Method Summary

Modifier and Type	Method	Description
void	decodeAfterContext(ByteBuffer buf, int length)	Decode this PDU after the end of the encoded context.
void	encodeAfterContext(ByteBuffer buf)	Encode this PDU after already encoded context (thus context will not be encoded by this operation).
int	getAfterContextLength()	Gets the encoded length after an already encoded context.
org.snmp4j.smi.VariableBinding[]	getVariableBindings()	Gets the VariableBindings array.
void	setVariableBindings(org.snmp4j.smi.VariableBinding[] variableBindings)	Sets the VariableBindings array.
int	size()	Gets the size of the VariableBindings array.
String	toStringExtMembers()	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

Methods inherited from class java.lang.Object

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

Field Details

variableBindings

protected org.snmp4j.smi.VariableBinding[] variableBindings

The variable bindings in the PDU.

Constructor Details

AgentXVariableBindingPDU

protected AgentXVariableBindingPDU(byte type,
 org.snmp4j.smi.OctetString context,
 org.snmp4j.smi.VariableBinding[] vbs)

Creates a AgentXVariableBindingPDU from its type.

Parameters:

type - a AgentX PDU type.

context - the context.

vbs - an array of VariableBinding instances.

AgentXVariableBindingPDU

protected AgentXVariableBindingPDU(AgentXMessageHeader header)

Creates a AgentXVariableBindingPDU from a AgentXMessageHeader.

Parameters:

header - the message header.

AgentXVariableBindingPDU

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

Creates a AgentXVariableBindingPDU from its type.

Parameters:

type - a AgentX PDU type.

flags - a set of AgentX flags, see AgentXProtocol.FLAG_ALLOCATE_INDEX for example.

sessionID - a session ID.

transactionID - a transaction ID.

packetID - a packet ID.

Method Details

decodeAfterContext

public void decodeAfterContext(ByteBuffer buf,
 int length)
                        throws IOException

Description copied from class: AgentXContextPDU

Decode this PDU after the end of the encoded context.

Specified by:

decodeAfterContext in class AgentXContextPDU

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 fewer data than expected.

encodeAfterContext

public void encodeAfterContext(ByteBuffer buf)

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 class AgentXContextPDU

Parameters:

buf - the target buffer.

getAfterContextLength

public int getAfterContextLength()

Description copied from class: AgentXContextPDU

Gets the encoded length after an already encoded context.

Specified by:

getAfterContextLength in class AgentXContextPDU

Returns:

the BER encoded length (without context).

getVariableBindings

public org.snmp4j.smi.VariableBinding[] getVariableBindings()

Gets the VariableBindings array.

Returns:

the VariableBindings array.

setVariableBindings

public void setVariableBindings(org.snmp4j.smi.VariableBinding[] variableBindings)

Sets the VariableBindings array.

Parameters:

variableBindings - a VariableBindings array.

size

public int size()

Gets the size of the VariableBindings array.

Returns:

the number of variable bindings in this PDU.

toStringExtMembers

public 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 AgentXContextPDU

Returns:

a string representation of the PDU members.