org.soulwing.snmp

Class SimpleSnmpTargetConfig

java.lang.Object

org.soulwing.snmp.SimpleSnmpTargetConfig

All Implemented Interfaces:

Cloneable, SnmpTargetConfig

public class SimpleSnmpTargetConfig
extends Object
implements SnmpTargetConfig

An SnmpTargetConfig implemented as a simple configurable bean.

Author:

Carl Harris

Constructor Summary

Constructors

Constructor and Description
SimpleSnmpTargetConfig()

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.
void	setRetries(int retries) Sets the retries property.
void	setTimeout(long timeout) Sets the timeout property.
void	setWalkAllowsTruncatedRepetition(boolean walkAllowsTruncatedRepetition) Sets the walkAllowsTruncatedRepetition property.
void	setWalkMaxRepetitions(int walkMaxRepetitions) Sets the walkMaxRepetitions property.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleSnmpTargetConfig

public SimpleSnmpTargetConfig()

Method Detail

getRetries

public int getRetries()

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

Specified by:

getRetries in interface SnmpTargetConfig

Returns:

retry count

setRetries

public void setRetries(int retries)

Sets the retries property.

Parameters:

retries - the value to set

getTimeout

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

Specified by:

getTimeout in interface SnmpTargetConfig

Returns:

timeout in milliseconds

setTimeout

public void setTimeout(long timeout)

Sets the timeout property.

Parameters:

timeout - the value to set

getWalkMaxRepetitions

public 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).

Specified by:

getWalkMaxRepetitions in interface SnmpTargetConfig

Returns:

max repetitions value > 0

setWalkMaxRepetitions

public void setWalkMaxRepetitions(int walkMaxRepetitions)

Sets the walkMaxRepetitions property.

Parameters:

walkMaxRepetitions - the value to set

isWalkAllowsTruncatedRepetition

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

Specified by:

isWalkAllowsTruncatedRepetition in interface SnmpTargetConfig

Returns:

flag state

setWalkAllowsTruncatedRepetition

public void setWalkAllowsTruncatedRepetition(boolean walkAllowsTruncatedRepetition)

Sets the walkAllowsTruncatedRepetition property.

Parameters:

walkAllowsTruncatedRepetition - the value to set

clone

public SnmpTargetConfig clone()

Creates a clone of this configuration.

Specified by:

clone in interface SnmpTargetConfig

Overrides:

clone in class Object

Returns:

configuration clone