Package org.snmp4j.agent.request

Interface SnmpSubRequest

All Superinterfaces:

SubRequest

All Known Implementing Classes:

SnmpRequest.SnmpSubRequest

public interface SnmpSubRequest
extends SubRequest

The SnmpSubRequest class holds data for a SNMP sub-request.

Version:

1.0

Author:

Frank Fock

Method Summary

Modifier and Type	Method	Description
SnmpRequest	getSnmpRequest()
RequestStatus	getStatus()	Gets the status object associated with this sub-request.
org.snmp4j.smi.VariableBinding	getVariableBinding()	Returns the variable binding associated with the sub-request.
void	setErrorStatus(int errorStatus)	Sets the error status for this sub-request.
void	setStatus(RequestStatus status)

Methods inherited from interface org.snmp4j.agent.request.SubRequest

completed, getErrorStatus, getIndex, getQuery, getRequest, getScope, getTargetMO, getUndoValue, getUserObject, hasError, isComplete, repetitions, setQuery, setTargetMO, setUndoValue, setUserObject, updateNextRepetition

Method Details

setStatus

void setStatus(RequestStatus status)

getStatus

RequestStatus getStatus()

Description copied from interface: SubRequest

Gets the status object associated with this sub-request.

Specified by:

getStatus in interface SubRequest

Returns:

a RequestStatus instance.

getVariableBinding

org.snmp4j.smi.VariableBinding getVariableBinding()

Description copied from interface: SubRequest

Returns the variable binding associated with the sub-request. In order to process a sub-request this variable binding needs to be modified (if not an error condition prevents that).

Specified by:

getVariableBinding in interface SubRequest

Returns:

the VariableBinding that holds the sub-request result or operation parameter (in case of a SET request).

getSnmpRequest

SnmpRequest getSnmpRequest()

setErrorStatus

void setErrorStatus(int errorStatus)

Description copied from interface: SubRequest

Sets the error status for this sub-request. Calling this method is a shortcut for SubRequest.getStatus().setErrorStatus(int errorStatus) .

Specified by:

setErrorStatus in interface SubRequest

Parameters:

errorStatus - a SNMPv2/v3 error status.