Serialized Form (SNMP4J-AgentX 4.2.0)

Package org.snmp4j.agent.agentx
- Class org.snmp4j.agent.agentx.AgentXAddAgentCapsPDU
  
  class AgentXAddAgentCapsPDU extends AgentXContextPDU implements Serializable
  
  serialVersionUID:
  
  5612445856184490038L
  - Serialized Fields
    
    descr
    
    org.snmp4j.smi.OctetString descr
    
    The human readable description of the agent capabilities.
    
    id
    
    org.snmp4j.smi.OID id
    
    The object identifier of the agent capabilities to be added.
- Class org.snmp4j.agent.agentx.AgentXCleanupSetPDU
  
  class AgentXCleanupSetPDU extends AgentXPDU implements Serializable
  
  serialVersionUID:
  
  3773066629531422013L
- Class org.snmp4j.agent.agentx.AgentXClosePDU
  
  class AgentXClosePDU extends AgentXPDU implements Serializable
  
  serialVersionUID:
  
  -8999433267014947249L
  - Serialized Fields
    
    reason
    
    byte reason
    
    The reason for closing the session, see AgentXProtocol.REASON_OTHER for example.
- Class org.snmp4j.agent.agentx.AgentXCommandEvent
  
  class AgentXCommandEvent extends EventObject implements Serializable
  
  serialVersionUID:
  
  -1607657485924685015L
  - Serialized Fields
    
    command
    
    AgentXPDU command
    
    The AgentX command (PDU) that triggered this event, or null if a parse exception occurred.
    
    dispatcher
    
    AgentXMessageDispatcher dispatcher
    
    The AgentXMessageDispatcher associated with the command.
    
    exception
    
    AgentXParseException exception
    
    The parse exception that occurred while decoding the command, or null if none occurred.
    
    peerAddress
    
    A extends org.snmp4j.smi.Address peerAddress
    
    The address of the peer on whose behalf this event is emitted.
    
    peerTransport
    
    org.snmp4j.transport.ConnectionOrientedTransportMapping<A extends org.snmp4j.smi.Address> peerTransport
    
    The connection-oriented transport mapping over which the peer communicates.
    
    processed
    
    boolean processed
    
    Indicates whether the command has already been processed.
    
    tmStateReference
    
    org.snmp4j.TransportStateReference tmStateReference
    
    The transport state reference associated with the received command.
- Class org.snmp4j.agent.agentx.AgentXCommitSetPDU
  
  class AgentXCommitSetPDU extends AgentXPDU implements Serializable
  
  serialVersionUID:
  
  7565202303478262014L
- Class org.snmp4j.agent.agentx.AgentXContextPDU
  
  class AgentXContextPDU extends AgentXPDU implements Serializable
  
  serialVersionUID:
  
  4649210580838933182L
  - Serialized Fields
    
    context
    
    org.snmp4j.smi.OctetString context
    
    The SNMPv43 context.
- Class org.snmp4j.agent.agentx.AgentXGetBulkPDU
  
  class AgentXGetBulkPDU extends AgentXRequestPDU implements Serializable
  
  serialVersionUID:
  
  -8406339539172636681L
  - Serialized Fields
    
    maxRepetitions
    
    short maxRepetitions
    
    GETBULK maximum repetitions.
    
    nonRepeaters
    
    short nonRepeaters
    
    GETBULK non-repeaters.
- Class org.snmp4j.agent.agentx.AgentXGetNextPDU
  
  class AgentXGetNextPDU extends AgentXRequestPDU implements Serializable
  
  serialVersionUID:
  
  1201288450489361579L
- Class org.snmp4j.agent.agentx.AgentXGetPDU
  
  class AgentXGetPDU extends AgentXRequestPDU implements Serializable
  
  serialVersionUID:
  
  -6529473376764354480L
- Class org.snmp4j.agent.agentx.AgentXIndexAllocatePDU
  
  class AgentXIndexAllocatePDU extends AgentXVariableBindingPDU implements Serializable
  
  serialVersionUID:
  
  969569037726025193L
- Class org.snmp4j.agent.agentx.AgentXIndexDeallocatePDU
  
  class AgentXIndexDeallocatePDU extends AgentXVariableBindingPDU implements Serializable
  
  serialVersionUID:
  
  -7720318114293103666L
- Class org.snmp4j.agent.agentx.AgentXMessageHeader
  
  class AgentXMessageHeader extends org.snmp4j.transport.MessageLength implements Serializable
  
  serialVersionUID:
  
  -4401111336131096427L
  - Serialized Fields
    
    flags
    
    byte flags
    
    The AgentX flags of the PDU (bitwise OR), see AgentXProtocol.FLAG_INSTANCE_REGISTRATION for example.
    
    packetID
    
    int packetID
    
    The packet ID that uniquely identifies the PDU within a transaction.
    
    sessionID
    
    int sessionID
    
    The session ID that identifies the AgentX session the PDU belongs to.
    
    transactionID
    
    int transactionID
    
    The transaction ID that associates the PDU with a management operation.
    
    type
    
    byte type
    
    The AgentX PDU type, see AgentXPDU.AGENTX_OPEN_PDU for example.
- Class org.snmp4j.agent.agentx.AgentXNotifyPDU
  
  class AgentXNotifyPDU extends AgentXVariableBindingPDU implements Serializable
  
  serialVersionUID:
  
  6133809140158452146L
- Class org.snmp4j.agent.agentx.AgentXOpenPDU
  
  class AgentXOpenPDU extends AgentXPDU implements Serializable
  
  serialVersionUID:
  
  -8128999107664220880L
  - Serialized Fields
    
    subagentDescr
    
    org.snmp4j.smi.OctetString subagentDescr
    
    The subagent description.
    
    subagentID
    
    org.snmp4j.smi.OID subagentID
    
    The sub-agent ID.
    
    timeout
    
    byte timeout
    
    AgentX timeout in seconds.
- Exception Class org.snmp4j.agent.agentx.AgentXParseException
  
  class AgentXParseException extends IOException implements Serializable
  
  serialVersionUID:
  
  -5201526181692556627L
  - Serialized Fields
    
    agentXHeader
    
    AgentXMessageHeader agentXHeader
    
    The AgentX message header (as complete as could be parsed) associated with the parse error.
- Class org.snmp4j.agent.agentx.AgentXPDU
  
  class AgentXPDU extends Object implements Serializable
  
  serialVersionUID:
  
  -1162042633774482416L
  - Serialized Fields
    
    byteOrder
    
    ByteOrder byteOrder
    
    The byte order.
    
    flags
    
    byte flags
    
    Flags (bitwise OR), see AgentXProtocol.FLAG_INSTANCE_REGISTRATION for example.
    
    packetID
    
    int packetID
    
    Packet ID
    
    sessionID
    
    int sessionID
    
    Session ID
    
    transactionID
    
    int transactionID
    
    Transaction ID.
    
    type
    
    byte type
    
    AgentX PDU type.
    
    version
    
    byte version
    
    AgentX protocol version
- Class org.snmp4j.agent.agentx.AgentXPeer
  
  class AgentXPeer extends Object implements Serializable
  
  serialVersionUID:
  
  8420653697945606497L
  - Serialized Fields
    
    address
    
    A extends org.snmp4j.smi.Address address
    
    The network address of this peer's end-point.
    
    closing
    
    boolean closing
    
    Indicates whether the peer is closing its transport and thus no longer accepts new connections.
    
    connectionTime
    
    long connectionTime
    
    The time (see Date.getTime()) when the connection to this peer was established.
    
    id
    
    Object id
    
    A unique ID associated with this peer definition.
    
    parseErrors
    
    AtomicInteger parseErrors
    
    Counts the total number of parse errors that occurred on this peer.
    
    timeout
    
    int timeout
    
    The message timeout in seconds used when communicating with this peer.
    
    transport
    
    org.snmp4j.transport.ConnectionOrientedTransportMapping<A extends org.snmp4j.smi.Address> transport
    
    The connection-oriented transport mapping used to communicate with this peer.
- Class org.snmp4j.agent.agentx.AgentXPingPDU
  
  class AgentXPingPDU extends AgentXContextPDU implements Serializable
  
  serialVersionUID:
  
  -6351582124674315648L
- Class org.snmp4j.agent.agentx.AgentXRegion
  
  class AgentXRegion extends org.snmp4j.agent.DefaultMOScope implements Serializable
  
  serialVersionUID:
  
  -6110407395132112108L
  - Serialized Fields
    
    rangeSubID
    
    byte rangeSubID
    
    The sub-identifier index at which a range registration applies, or zero if the region is not a range registration.
    
    singleOID
    
    boolean singleOID
    
    Indicates whether this region represents a single object instance rather than a subtree range.
- Class org.snmp4j.agent.agentx.AgentXRegisterPDU
  
  class AgentXRegisterPDU extends AgentXContextPDU implements Serializable
  
  serialVersionUID:
  
  2377335776967076409L
  - Serialized Fields
    
    priority
    
    byte priority
    
    The registration priority, where smaller values take precedence over larger ones.
    
    rangeSubID
    
    byte rangeSubID
    
    The sub-identifier index within the AgentXRegisterPDU.subtree at which the AgentXRegisterPDU.upperBound applies to define a range registration, or zero if no range is registered.
    
    subtree
    
    org.snmp4j.smi.OID subtree
    
    The object identifier of the subtree (MIB region) to be registered.
    
    timeout
    
    byte timeout
    
    The length of time, in seconds, that the master agent should allow to elapse for requests on the registered region before timing out. A value of zero indicates that the session or master agent default should be used.
    
    upperBound
    
    int upperBound
    
    The upper bound of the range sub-identifier when AgentXRegisterPDU.rangeSubID is non-zero.
- Class org.snmp4j.agent.agentx.AgentXRemoveAgentCapsPDU
  
  class AgentXRemoveAgentCapsPDU extends AgentXContextPDU implements Serializable
  
  serialVersionUID:
  
  -4417974339806785162L
  - Serialized Fields
    
    id
    
    org.snmp4j.smi.OID id
    
    The object identifier of the agent capabilities to be removed.
- Class org.snmp4j.agent.agentx.AgentXRequestPDU
  
  class AgentXRequestPDU extends AgentXContextPDU implements Serializable
  
  serialVersionUID:
  
  4463505479247648609L
  - Serialized Fields
    
    nextOidFilter
    
    Function<org.snmp4j.smi.OID, Boolean> nextOidFilter
    
    The next OID filter can filter OIDs returned by AgentX GetNext and GetBulk operations before they are returned to the master agent.
    
    Since:
    
    4.1.0
    
    ranges
    
    org.snmp4j.agent.MOScope[] ranges
    
    The request ranges.
- Class org.snmp4j.agent.agentx.AgentXResponseEvent
  
  class AgentXResponseEvent extends EventObject implements Serializable
  
  serialVersionUID:
  
  2056878008019512927L
  - Serialized Fields
    
    error
    
    Exception error
    
    The exception that occurred while processing the request, if any.
    
    peerAddress
    
    A extends org.snmp4j.smi.Address peerAddress
    
    The transport address of the entity that sent the response.
    
    request
    
    AgentXPDU request
    
    The request PDU that triggered the response.
    
    response
    
    AgentXResponsePDU response
    
    The received response PDU, or null if the request timed out.
    
    target
    
    AgentXTarget<A extends org.snmp4j.smi.Address> target
    
    The target to which the request had been sent.
- Class org.snmp4j.agent.agentx.AgentXResponsePDU
  
  class AgentXResponsePDU extends AgentXPDU implements Serializable
  
  serialVersionUID:
  
  -937978539587831243L
  - Serialized Fields
    
    errorIndex
    
    short errorIndex
    
    The one-based index of the variable binding that caused the error, or zero if no error occurred.
    
    errorStatus
    
    short errorStatus
    
    The error status reported for the response.
    
    sysUpTime
    
    int sysUpTime
    
    The value of sysUpTime returned to the command sender.
    
    variableBindings
    
    List<org.snmp4j.smi.VariableBinding> variableBindings
    
    The list of variable bindings carried by this response PDU.
- Class org.snmp4j.agent.agentx.AgentXSession
  
  class AgentXSession extends Object implements Serializable
  
  serialVersionUID:
  
  2890153102679435259L
  - Serialized Fields
    
    byteOrder
    
    ByteOrder byteOrder
    
    The byte order used to encode and decode AgentX PDUs of this session.
    
    closed
    
    boolean closed
    
    Indicates whether this session has been closed.
    
    consecutiveTimeouts
    
    int consecutiveTimeouts
    
    The number of consecutive request timeouts observed on this session.
    
    peer
    
    AgentXPeer<A extends org.snmp4j.smi.Address> peer
    
    The AgentX peer this session is connected to.
    
    sessionID
    
    int sessionID
    
    The unique ID of this session.
    
    timeout
    
    byte timeout
    
    The session timeout in seconds.
- Class org.snmp4j.agent.agentx.AgentXTarget
  
  class AgentXTarget extends Object implements Serializable
  
  serialVersionUID:
  
  -2305474833796499902L
  - Serialized Fields
    
    address
    
    A extends org.snmp4j.smi.Address address
    
    The transport address of the target.
    
    timeout
    
    long timeout
    
    The request timeout in milliseconds.
- Class org.snmp4j.agent.agentx.AgentXTestSetPDU
  
  class AgentXTestSetPDU extends AgentXVariableBindingPDU implements Serializable
  
  serialVersionUID:
  
  -1260273186753634224L
- Class org.snmp4j.agent.agentx.AgentXUndoSetPDU
  
  class AgentXUndoSetPDU extends AgentXPDU implements Serializable
  
  serialVersionUID:
  
  -8558260951917880886L
- Class org.snmp4j.agent.agentx.AgentXUnregisterPDU
  
  class AgentXUnregisterPDU extends AgentXRegisterPDU implements Serializable
  
  serialVersionUID:
  
  8897170591779762528L
- Class org.snmp4j.agent.agentx.AgentXVariableBindingPDU
  
  class AgentXVariableBindingPDU extends AgentXContextPDU implements Serializable
  
  serialVersionUID:
  
  -2031250227490466821L
  - Serialized Fields
    
    variableBindings
    
    org.snmp4j.smi.VariableBinding[] variableBindings
    
    The variable bindings in the PDU.
Package org.snmp4j.agent.agentx.event
- Class org.snmp4j.agent.agentx.event.PingEvent
  
  class PingEvent extends EventObject implements Serializable
  
  serialVersionUID:
  
  -659743205138032769L
  - Serialized Fields
    
    closeSession
    
    boolean closeSession
    
    Indicates whether the pinged session should be closed.
    
    error
    
    Exception error
    
    The exception that caused the ping to fail, if any.
    
    resetSession
    
    boolean resetSession
    
    Indicates whether the pinged session should be reset.
    
    response
    
    AgentXResponsePDU response
    
    The response received for the ping, or null if the ping failed.
    
    session
    
    AgentXSession<A extends org.snmp4j.smi.Address> session
    
    The AgentX session that has been pinged.
Package org.snmp4j.agent.agentx.master
- Class org.snmp4j.agent.agentx.master.AbstractAgentXPending
  
  class AbstractAgentXPending extends Object implements Serializable
  
  serialVersionUID:
  
  -7904568557569179078L
  - Serialized Fields
    
    pending
    
    boolean pending
    
    Indicates whether this request is still pending (i.e. no response has been processed yet).
    
    registration
    
    AgentXRegEntry<A extends org.snmp4j.smi.Address> registration
    
    The region entry of the affected region by this pending request.
    
    request
    
    org.snmp4j.agent.request.SnmpRequest request
    
    The SNMP request that triggered this pending AgentX request.
    
    timeout
    
    int timeout
    
    The timeout in seconds after which this pending request is considered to have timed out.
    
    timestamp
    
    long timestamp
    
    The time in milliseconds when this request was sent, used to detect timeouts.
- Class org.snmp4j.agent.agentx.master.AgentXMasterEvent
  
  class AgentXMasterEvent extends EventObject implements Serializable
  
  serialVersionUID:
  
  3832573623483809788L
  - Serialized Fields
    
    changedObject
    
    Object changedObject
    
    An optional reference to the changed object (or the object to be changed), for example an AgentXPeer, AgentXSession, or AgentXRegistration instance.
    
    type
    
    int type
    
    The event type; a value less than zero indicates a veto-able event, a value greater than zero an informational event.
    
    vetoReason
    
    int vetoReason
    
    The veto reason set by a listener to cancel a veto-able event, or AgentXProtocol.AGENTX_SUCCESS if the event is not vetoed.
- Class org.snmp4j.agent.agentx.master.AgentXMasterSession
  
  class AgentXMasterSession extends AgentXSession<A extends org.snmp4j.smi.Address> implements Serializable
  
  serialVersionUID:
  
  2076735780892800483L
  - Serialized Fields
    
    agentCaps
    
    Map<org.snmp4j.smi.OID, org.snmp4j.smi.OID> agentCaps
    
    The agent capabilities registered by this session, mapping each sysORID to its associated agentXCapsIndex.
    
    agentXVersion
    
    int agentXVersion
    
    The AgentX protocol version negotiated for this session.
    
    descr
    
    org.snmp4j.smi.OctetString descr
    
    The description of the sub-agent of this session (sysDescr).
    
    oid
    
    org.snmp4j.smi.OID oid
    
    The OID identifying the sub-agent of this session (sysObjectID).
    
    queue
    
    AgentXQueue queue
    
    The AgentX request queue of this master agent.
- Class org.snmp4j.agent.agentx.master.AgentXPendingClose
  
  class AgentXPendingClose extends AbstractAgentXPending<A extends org.snmp4j.smi.Address> implements Serializable
  
  serialVersionUID:
  
  6969612307657156605L
  - Serialized Fields
    
    pendingPDU
    
    AgentXClosePDU pendingPDU
    
    The close PDU that triggered this pending close request.
    
    session
    
    AgentXMasterSession<A extends org.snmp4j.smi.Address> session
    
    The AgentX master session that is to be closed.
- Class org.snmp4j.agent.agentx.master.AgentXPendingGet
  
  class AgentXPendingGet extends AbstractAgentXPending<A extends org.snmp4j.smi.Address> implements Serializable
  
  serialVersionUID:
  
  -8370197543450517767L
  - Serialized Fields
    
    agentXRequestPDU
    
    AgentXPDU agentXRequestPDU
    
    The AgentX request PDU (Get, GetNext, or GetBulk) sent to the sub-agent.
    
    nonRepeater
    
    short nonRepeater
    
    The number of non-repeater variable bindings for a GetBulk request.
    
    oidFilter
    
    Function<org.snmp4j.smi.OID, Boolean> oidFilter
    
    Optional filter to remove objects returned by an AgentX sub-agent from the result of GetNext or GetBulk operations. Typically, this can be VACM filtering. Only if the provided function returns true, the retrieved OID will be returned to the command generator.
    
    Since:
    
    4.1.0
    
    searchRanges
    
    List<AgentXSearchRange> searchRanges
    
    The search ranges of the request that are dispatched to the sub-agent.
- Class org.snmp4j.agent.agentx.master.AgentXPendingSet
  
  class AgentXPendingSet extends AbstractAgentXPending<A extends org.snmp4j.smi.Address> implements Serializable
  
  serialVersionUID:
  
  6075492117112399140L
  - Serialized Fields
    
    requestPDU
    
    AgentXPDU requestPDU
    
    The AgentX request PDU (TestSet, CommitSet, UndoSet, or CleanupSet) currently being processed.
    
    session
    
    AgentXMasterSession<A extends org.snmp4j.smi.Address> session
    
    The AgentX master session over which the SET request is processed.
    
    vbs
    
    List<org.snmp4j.agent.agentx.master.AgentXPendingSet.AgentXSetVB> vbs
    
    The variable bindings of the SET request to be sent to the sub-agent.
- Class org.snmp4j.agent.agentx.master.AgentXQueue
  
  class AgentXQueue extends Object implements Serializable
  
  serialVersionUID:
  
  4177433540588469413L
  - Serialized Fields
    
    queue
    
    LinkedList<org.snmp4j.agent.agentx.master.AgentXQueue.AgentXQueueEntry<?>> queue
    
    The ordered list of AgentX requests waiting to be processed.
- Class org.snmp4j.agent.agentx.master.AgentXRegEntry
  
  class AgentXRegEntry extends Object implements Serializable
  
  serialVersionUID:
  
  7889656078544847560L
  - Serialized Fields
    
    context
    
    org.snmp4j.smi.OctetString context
    
    The SNMPv3 context for which this region is registered.
    
    id
    
    org.snmp4j.smi.OID id
    
    The index OID associated with this region entry.
    
    priority
    
    int priority
    
    The priority of this registration (a lower value takes precedence).
    
    region
    
    AgentXRegion region
    
    The MIB region covered by this registration.
    
    session
    
    AgentXMasterSession<A extends org.snmp4j.smi.Address> session
    
    The master session that registered this region.
    
    timeout
    
    int timeout
    
    The timeout in seconds for requests dispatched to this region.
- Class org.snmp4j.agent.agentx.master.MasterContextInfo
  
  class MasterContextInfo extends Object implements Serializable
  
  serialVersionUID:
  
  1940496150873271394L
  - Serialized Fields
    
    context
    
    org.snmp4j.smi.OctetString context
    
    The context this information is associated with.
    
    upTime
    
    org.snmp4j.agent.mo.snmp.SysUpTime upTime
    
    The uptime of the context, derived from its sysUpTime object.
Package org.snmp4j.agent.agentx.subagent.index
- Class org.snmp4j.agent.agentx.subagent.index.AnyNewIndexOID
  
  class AnyNewIndexOID extends org.snmp4j.smi.OID implements Serializable
  
  serialVersionUID:
  
  8029122221046539737L
- Class org.snmp4j.agent.agentx.subagent.index.NewIndexOID
  
  class NewIndexOID extends org.snmp4j.smi.OID implements Serializable
  
  serialVersionUID:
  
  -7941697204485878916L

Serialized Form

Package org.snmp4j.agent.agentx

Class org.snmp4j.agent.agentx.AgentXAddAgentCapsPDU

Serialized Fields

descr

id

Class org.snmp4j.agent.agentx.AgentXCleanupSetPDU

Class org.snmp4j.agent.agentx.AgentXClosePDU

Serialized Fields

reason

Class org.snmp4j.agent.agentx.AgentXCommandEvent

Serialized Fields

command

dispatcher

exception

peerAddress

peerTransport

processed

tmStateReference

Class org.snmp4j.agent.agentx.AgentXCommitSetPDU

Class org.snmp4j.agent.agentx.AgentXContextPDU

Serialized Fields

context

Class org.snmp4j.agent.agentx.AgentXGetBulkPDU

Serialized Fields

maxRepetitions

nonRepeaters

Class org.snmp4j.agent.agentx.AgentXGetNextPDU

Class org.snmp4j.agent.agentx.AgentXGetPDU

Class org.snmp4j.agent.agentx.AgentXIndexAllocatePDU

Class org.snmp4j.agent.agentx.AgentXIndexDeallocatePDU

Class org.snmp4j.agent.agentx.AgentXMessageHeader

Serialized Fields

flags

packetID

sessionID

transactionID

type

Class org.snmp4j.agent.agentx.AgentXNotifyPDU

Class org.snmp4j.agent.agentx.AgentXOpenPDU

Serialized Fields

subagentDescr

subagentID

timeout

Exception Class org.snmp4j.agent.agentx.AgentXParseException

Serialized Fields

agentXHeader

Class org.snmp4j.agent.agentx.AgentXPDU

Serialized Fields

byteOrder

flags

packetID

sessionID

transactionID

type

version

Class org.snmp4j.agent.agentx.AgentXPeer

Serialized Fields

address

closing

connectionTime

id

parseErrors

timeout

transport

Class org.snmp4j.agent.agentx.AgentXPingPDU

Class org.snmp4j.agent.agentx.AgentXRegion

Serialized Fields

rangeSubID

singleOID

Class org.snmp4j.agent.agentx.AgentXRegisterPDU

Serialized Fields

priority

rangeSubID

subtree

timeout

upperBound

Class org.snmp4j.agent.agentx.AgentXRemoveAgentCapsPDU

Serialized Fields

id