org.soulwing.snmp

Interface SnmpTargetConfig

All Superinterfaces:

Cloneable

All Known Implementing Classes:

SimpleSnmpTargetConfig

public interface SnmpTargetConfig
extends Cloneable

A configuration for an SnmpContext.

Author:

Carl Harris

Method Summary

Methods

Modifier and Type	Method and Description
SnmpTargetConfig	clone() Creates a clone of this configuration.
int	getRetries() Gets the number of retries for an SNMP operation when no response is received before the configured timeout.
long	getTimeout() Gets the interval of time that should elapse before an SNMP operation should be assumed to have not been received by the target agent.
int	getWalkMaxRepetitions() Gets the maximum repetitions for repeating OIDs in a call to a walk operation.
boolean	isWalkAllowsTruncatedRepetition() Gets a flag that determines whether a walk operation should allow a truncated response.

Method Detail

getRetries

int getRetries()

Gets the number of retries for an SNMP operation when no response is received before the configured timeout.

Returns:

retry count

getTimeout

long getTimeout()

Gets the interval of time that should elapse before an SNMP operation should be assumed to have not been received by the target agent.

Returns:

timeout in milliseconds

getWalkMaxRepetitions

int getWalkMaxRepetitions()

Gets the maximum repetitions for repeating OIDs in a call to a walk operation.

This value is used as the maxRepetitions value for the underlying GETBULK operation used to implement MIB walking. It does not effect the total number of objects that can be returned from a walk. Rather, it controls the number of objects that are fetched in a single protocol operation with the target agent. The value selected here represents a tradeoff between minimizing the number of round trips needed to complete a walk versus the effort required by the agent to respond to each request and the amount of information that will be discarded from the last response (when the end of the information needed to complete the walk has been reached).

Returns:

max repetitions value > 0

isWalkAllowsTruncatedRepetition

boolean isWalkAllowsTruncatedRepetition()

Gets a flag that determines whether a walk operation should allow a truncated response.

The underlying GETBULK protocol operation used to implement walks allows an arbitrary number of non-repeating and repeating objects to be requested. If a GETBULK response contains few repeating objects than were specified in the request, it is generally due to some limitation of the target agent. When this occurs, the walk is terminated with a TruncatedResponseException. Set this flag if you may wish to allow the walk to proceed, making use of the objects that the agent can successfully return, and ignoring the absence of the requested objects that were not returned by the agent.

Returns:

flag state

clone

SnmpTargetConfig clone()

Creates a clone of this configuration.

Returns:

configuration clone