com.sun.management.snmp.manager
Class SnmpOptions

java.lang.Object
  com.sun.management.snmp.manager.SnmpOptions

All Implemented Interfaces:

Serializable

public final class SnmpOptions
extends Object
implements Serializable

Is used to configure various options for SnmpSession.
Each session can be tuned to suit a specific need. Setting these options changes the behavior of all future requests. The existing requests are also influenced, depending on the nature of the option.
There are currently 3 different options:

• Multiplex allowed: variable binding list of different requests on a same session are merged when sending the request (but the responses are de-multiplexed)
• Fix PDU on error: if a response contains an error, the variable corresponding to the error (given by the error-index field of the SNMP PDU) is removed from the variable binding list and the request is sent to the agent again
• Handle too big PDU: if a request is too big to be held in one SNMP PDU, the request will be split into as many requests required to send the original request

Since:

Java DMK 5.1

See Also:

SnmpSession, Serialized Form

Field Summary

static int	optAllowMultiplexing This option can be set to control the behavior of a request.
static int	optFixPduOnError This option can be set to control the behavior of a request.
static int	optHandleTooBigError This option can be set to control the behavior of a request.

Constructor Summary

SnmpOptions()
Creates a new option with a default value.

SnmpOptions(int options)
Creates a new option with the specified value.

Method Summary

int	getOptions() Gets all the options set in the object.
boolean	isMultiplexAllowed() Indicates whether multiplexing is allowed or not.
boolean	isPduFixedOnError() Indicates whether the PduFixedOnError option is set or not.
boolean	isTooBigHandled() Indicates if the TooBigHandled option is set or not.
void	resetToDefault() Resets to default options.
void	setMultiplexAllowed(boolean flag) Sets the MultiplexAllowed option.
void	setPduFixedOnError(boolean flag) Sets the PduFixedOnError option.
void	setTooBigHandled(boolean flag) Sets the TooBigHandled option.

Methods inherited from class java.lang.Object

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

Field Detail

optAllowMultiplexing

public static final int optAllowMultiplexing

This option can be set to control the behavior of a request.

See Also:

Constant Field Values

optFixPduOnError

public static final int optFixPduOnError

This option can be set to control the behavior of a request.

See Also:

Constant Field Values

optHandleTooBigError

public static final int optHandleTooBigError

This option can be set to control the behavior of a request.

See Also:

Constant Field Values

Constructor Detail

SnmpOptions

public SnmpOptions()

Creates a new option with a default value. This default value sets the following options:

• optAllowMultiplexing
• optFixPduOnError
• optHandleTooBigError

SnmpOptions

public SnmpOptions(int options)

Creates a new option with the specified value.

Parameters:

options - The initializing options.

Method Detail

getOptions

public int getOptions()

Gets all the options set in the object.

Returns:

All the options set in the object.

isMultiplexAllowed

public boolean isMultiplexAllowed()

Indicates whether multiplexing is allowed or not.

Returns:

true if multiplexing is allowed, false otherwise.

setMultiplexAllowed

public void setMultiplexAllowed(boolean flag)

Sets the MultiplexAllowed option.

Parameters:

flag - The MultiplexAllowed option value.

isPduFixedOnError

public boolean isPduFixedOnError()

Indicates whether the PduFixedOnError option is set or not.

Returns:

true if the PduFixedOnError option is set, false otherwise.

setPduFixedOnError

public void setPduFixedOnError(boolean flag)

Sets the PduFixedOnError option.

Parameters:

flag - The PduFixedOnError option value.

isTooBigHandled

public boolean isTooBigHandled()

Indicates if the TooBigHandled option is set or not.

Returns:

true if the TooBigHandled option is set, false otherwise.

setTooBigHandled

public void setTooBigHandled(boolean flag)

Sets the TooBigHandled option.

Parameters:

flag - The TooBigHandled option value.

resetToDefault

public void resetToDefault()

Resets to default options.