Summary: Inherited Fields | Ctors | Methods | Inherited Methods | [Expand All]

public class

SnmpErrorHandlerAgent

extends SnmpMibAgent
implements Serializable

java.lang.Object
↳	com.sun.jmx.snmp.agent.SnmpMibAgent
	↳	com.sun.jmx.snmp.agent.SnmpErrorHandlerAgent

Class Overview

A simple MIB agent that implements SNMP calls (get, set, getnext and getbulk) in a way that only errors or exceptions are returned. Every call done on this agent fails. Error handling is done according to the manager's SNMP protocol version.

It is used by SnmpAdaptorServer for its default agent behavior. When a received Oid doesn't match, this agent is called to fill the result list with errors.

This API is a Sun Microsystems internal API and is subject to change without notice.

Summary

[Expand]

Inherited Fields

From class com.sun.jmx.snmp.agent.SnmpMibAgent

Public Constructors
	SnmpErrorHandlerAgent()

Public Methods
void	check(SnmpMibRequest inRequest) Checks if a `set` operation can be performed.
void	get(SnmpMibRequest inRequest) Processes a `get` operation.
void	getBulk(SnmpMibRequest inRequest, int nonRepeat, int maxRepeat) Processes a `getBulk` operation.
void	getNext(SnmpMibRequest inRequest) Processes a `getNext` operation.
long[]	getRootOid() Gets the root object identifier of the MIB.
void	init() Initializes the MIB (with no registration of the MBeans into the MBean server).
ObjectName	preRegister(MBeanServer server, ObjectName name) Initializes the MIB but each single MBean representing the MIB is inserted into the MBean server.
void	set(SnmpMibRequest inRequest) Processes a `set` operation.

[Expand]

Inherited Methods

From class com.sun.jmx.snmp.agent.SnmpMibAgent

abstract void	check(SnmpMibRequest req) Checks if a `set` operation can be performed.
abstract void	get(SnmpMibRequest req) Processes a `get` operation.
boolean	getBindingState() Indicates whether or not the MIB module is bound to a SNMP protocol adaptor.
abstract void	getBulk(SnmpMibRequest req, int nonRepeat, int maxRepeat) Processes a `getBulk` operation.
MBeanServer	getMBeanServer() Gets the reference to the MBean server in which the SNMP MIB is registered.
String	getMibName() Gets the MIB name.
abstract void	getNext(SnmpMibRequest req) Processes a `getNext` operation.
abstract long[]	getRootOid() Gets the root object identifier of the MIB.
SnmpMibHandler	getSnmpAdaptor() Gets the reference to the SNMP protocol adaptor to which the MIB is bound.
ObjectName	getSnmpAdaptorName() Gets the object name of the SNMP protocol adaptor to which the MIB is bound.
abstract void	init() Initializes the MIB (with no registration of the MBeans into the MBean server).
static SnmpMibRequest	newMibRequest(SnmpPdu reqPdu, Vector<SnmpVarBind> vblist, int version, Object userData) This is a factory method for creating new SnmpMibRequest objects.
static SnmpMibRequest	newMibRequest(SnmpEngine engine, SnmpPdu reqPdu, Vector<SnmpVarBind> vblist, int version, Object userData, String principal, int securityLevel, int securityModel, byte[] contextName, byte[] accessContextName) This is a factory method for creating new SnmpMibRequest objects.
void	postDeregister() Not used in this context.
void	postRegister(Boolean registrationDone) Not used in this context.
void	preDeregister() Not used in this context.
abstract ObjectName	preRegister(MBeanServer server, ObjectName name) Initializes the MIB but each single MBean representing the MIB is inserted into the MBean server.
abstract void	set(SnmpMibRequest req) Processes a `set` operation.
void	setSnmpAdaptor(SnmpMibHandler stack, SnmpOid[] oids) Sets the reference to the SNMP protocol adaptor through which the MIB will be SNMP accessible and add this new MIB in the SNMP MIB handler.
void	setSnmpAdaptor(SnmpMibHandler stack, String contextName) Sets the reference to the SNMP protocol adaptor through which the MIB will be SNMP accessible and adds this new MIB in the SNMP MIB handler.
void	setSnmpAdaptor(SnmpMibHandler stack) Sets the reference to the SNMP protocol adaptor through which the MIB will be SNMP accessible and add this new MIB in the SNMP MIB handler.
void	setSnmpAdaptor(SnmpMibHandler stack, String contextName, SnmpOid[] oids) Sets the reference to the SNMP protocol adaptor through which the MIB will be SNMP accessible and adds this new MIB in the SNMP MIB handler.
void	setSnmpAdaptorName(ObjectName name, String contextName, SnmpOid[] oids) Sets the reference to the SNMP protocol adaptor through which the MIB will be SNMP accessible and add this new MIB in the SNMP MIB handler associated to the specified `name`.
void	setSnmpAdaptorName(ObjectName name, String contextName) Sets the reference to the SNMP protocol adaptor through which the MIB will be SNMP accessible and add this new MIB in the SNMP MIB handler associated to the specified `name`.
void	setSnmpAdaptorName(ObjectName name) Sets the reference to the SNMP protocol adaptor through which the MIB will be SNMP accessible and add this new MIB in the SNMP MIB handler associated to the specified `name`.
void	setSnmpAdaptorName(ObjectName name, SnmpOid[] oids) Sets the reference to the SNMP protocol adaptor through which the MIB will be SNMP accessible and add this new MIB in the SNMP MIB handler associated to the specified `name`.

From class java.lang.Object

Object	clone() Creates and returns a copy of this object.
boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
void	finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
final Class<?>	getClass() Returns the runtime class of this `Object`.
int	hashCode() Returns a hash code value for the object.
final void	notify() Wakes up a single thread that is waiting on this object's monitor.
final void	notifyAll() Wakes up all threads that are waiting on this object's monitor.
String	toString() Returns a string representation of the object.
final void	wait() Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.
final void	wait(long timeout, int nanos) Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
final void	wait(long timeout) Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.

From interface com.sun.jmx.snmp.agent.SnmpMibAgentMBean

abstract void	check(SnmpMibRequest req) Checks if a `set` operation can be performed.
abstract void	get(SnmpMibRequest req) Processes a `get` operation.
abstract boolean	getBindingState() Indicates whether or not the MIB module is bound to a SNMP protocol adaptor.
abstract void	getBulk(SnmpMibRequest req, int nonRepeat, int maxRepeat) Processes a `getBulk` operation.
abstract MBeanServer	getMBeanServer() Gets the reference to the MBean server in which the SNMP MIB is registered.
abstract String	getMibName() Gets the MIB name.
abstract void	getNext(SnmpMibRequest req) Processes a `getNext` operation.
abstract SnmpMibHandler	getSnmpAdaptor() Gets the reference to the SNMP protocol adaptor to which the MIB is bound.
abstract ObjectName	getSnmpAdaptorName() Gets the object name of the SNMP protocol adaptor to which the MIB is bound.
abstract void	set(SnmpMibRequest req) Processes a `set` operation.
abstract void	setSnmpAdaptor(SnmpMibHandler stack, SnmpOid[] oids) Sets the reference to the SNMP protocol adaptor through which the MIB will be SNMP accessible and add this new MIB in the SNMP MIB handler.
abstract void	setSnmpAdaptor(SnmpMibHandler stack) Sets the reference to the SNMP protocol adaptor through which the MIB will be SNMP accessible and add this new MIB in the SNMP MIB handler.
abstract void	setSnmpAdaptor(SnmpMibHandler stack, String contextName) Sets the reference to the SNMP protocol adaptor through which the MIB will be SNMP accessible and add this new MIB in the SNMP MIB handler.
abstract void	setSnmpAdaptor(SnmpMibHandler stack, String contextName, SnmpOid[] oids) Sets the reference to the SNMP protocol adaptor through which the MIB will be SNMP accessible and adds this new MIB in the SNMP MIB handler.
abstract void	setSnmpAdaptorName(ObjectName name, String contextName, SnmpOid[] oids) Sets the reference to the SNMP protocol adaptor through which the MIB will be SNMP accessible and add this new MIB in the SNMP MIB handler associated to the specified `name`.
abstract void	setSnmpAdaptorName(ObjectName name) Sets the reference to the SNMP protocol adaptor through which the MIB will be SNMP accessible and add this new MIB in the SNMP MIB handler associated to the specified `name`.
abstract void	setSnmpAdaptorName(ObjectName name, String contextName) Sets the reference to the SNMP protocol adaptor through which the MIB will be SNMP accessible and add this new MIB in the SNMP MIB handler associated to the specified `name`.
abstract void	setSnmpAdaptorName(ObjectName name, SnmpOid[] oids) Sets the reference to the SNMP protocol adaptor through which the MIB will be SNMP accessible and add this new MIB in the SNMP MIB handler associated to the specified `name`.

From interface javax.management.MBeanRegistration

Public Constructors

public SnmpErrorHandlerAgent ()

Public Methods

public void check (SnmpMibRequest inRequest)

Checks if a set operation can be performed. If the operation can not be performed, the method should emit a SnmpStatusException.

Parameters

inRequest	The SnmpMibRequest object holding the list of variables to be set. This list is composed of `SnmpVarBind` objects.

Throws

SnmpStatusException	The `set` operation cannot be performed.

public void get (SnmpMibRequest inRequest)

Processes a get operation. It will throw an exception for V1 requests or it will set exceptions within the list for V2 requests.

Parameters

inRequest	The SnmpMibRequest object holding the list of variable to be retrieved.

Throws

SnmpStatusException	An error occured during the operation.

public void getBulk (SnmpMibRequest inRequest, int nonRepeat, int maxRepeat)

Processes a getBulk operation. It will throw an exception if the request is a V1 one or it will set exceptions within the list for V2 ones.

Parameters

inRequest	The SnmpMibRequest object holding the list of variable to be retrieved.
nonRepeat	The number of variables, starting with the first variable in the variable-bindings, for which a single lexicographic successor is requested.
maxRepeat	The number of lexicographic successors requested for each of the last R variables. R is the number of variables following the first `nonRepeat` variables for which multiple lexicographic successors are requested.

Throws

SnmpStatusException	An error occured during the operation.

public void getNext (SnmpMibRequest inRequest)

Processes a getNext operation. It will throw an exception for V1 requests or it will set exceptions within the list for V2 requests..

Parameters

inRequest	The SnmpMibRequest object holding the list of variables to be retrieved.

Throws

SnmpStatusException	An error occured during the operation.

public long[] getRootOid ()

Gets the root object identifier of the MIB.

The root object identifier is the object identifier uniquely identifying the MIB.

Returns

The returned oid is null.

public void init ()

Initializes the MIB (with no registration of the MBeans into the MBean server). Does nothing.

Throws

IllegalAccessException	The MIB cannot be initialized.

public ObjectName preRegister (MBeanServer server, ObjectName name)

Initializes the MIB but each single MBean representing the MIB is inserted into the MBean server.

Parameters

server	The MBean server to register the service with.
name	The object name.

Returns

The passed name paramter.

Throws

Exception

public void set (SnmpMibRequest inRequest)

Processes a set operation. Should never be called (check previously called having failed).

Parameters

inRequest	The SnmpMibRequest object holding the list of variable to be set.

Throws

SnmpStatusException	An error occured during the operation.

Interfaces

Classes

SnmpErrorHandlerAgent

Class Overview

Summary

Public Constructors

public SnmpErrorHandlerAgent ()

Public Methods

public void check (SnmpMibRequest inRequest)

Parameters

Throws

public void get (SnmpMibRequest inRequest)

Parameters

Throws

public void getBulk (SnmpMibRequest inRequest, int nonRepeat, int maxRepeat)

Parameters

Throws

public void getNext (SnmpMibRequest inRequest)

Parameters

Throws

public long[] getRootOid ()

Returns

public void init ()

Throws

public ObjectName preRegister (MBeanServer server, ObjectName name)

Parameters

Returns

Throws

public void set (SnmpMibRequest inRequest)

Parameters

Throws