public interface

SnmpMibAgentMBean

com.sun.jmx.snmp.agent.SnmpMibAgentMBean
Known Indirect Subclasses

Class Overview

Exposes the remote management interface of the SnmpMibAgent MBean.

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

Summary

Public Methods
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.

Public Methods

public abstract void check (SnmpMibRequest req)

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

Parameters
req 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.
See Also

public abstract void get (SnmpMibRequest req)

Processes a get operation. This method must not be called from remote.

Parameters
req The SnmpMibRequest object holding the list of variables to be retrieved. This list is composed of SnmpVarBind objects.
Throws
SnmpStatusException An error occured during the operation.
See Also

public abstract boolean getBindingState ()

Indicates whether or not the MIB module is bound to a SNMP protocol adaptor. As a reminder, only bound MIBs can be accessed through SNMP protocol adaptor.

Returns
  • true if the MIB module is bound, false otherwise.

public abstract void getBulk (SnmpMibRequest req, int nonRepeat, int maxRepeat)

Processes a getBulk operation. This method must not be called from remote.

Parameters
req The SnmpMibRequest object holding the list of variables to be retrieved. This list is composed of SnmpVarBind objects.
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.
See Also

public abstract MBeanServer getMBeanServer ()

Gets the reference to the MBean server in which the SNMP MIB is registered.

Returns
  • The MBean server or null if the MIB is not registered in any MBean server.

public abstract String getMibName ()

Gets the MIB name.

Returns
  • The MIB name.

public abstract void getNext (SnmpMibRequest req)

Processes a getNext operation. This method must not be called from remote.

Parameters
req The SnmpMibRequest object holding the list of variables to be retrieved. This list is composed of SnmpVarBind objects.
Throws
SnmpStatusException An error occured during the operation.
See Also

public abstract SnmpMibHandler getSnmpAdaptor ()

Gets the reference to the SNMP protocol adaptor to which the MIB is bound.
This method is used for accessing the SNMP MIB handler property of the SNMP MIB agent in case of a standalone agent.

Returns
  • The SNMP MIB handler.

public abstract ObjectName getSnmpAdaptorName ()

Gets the object name of the SNMP protocol adaptor to which the MIB is bound.

Returns
  • The name of the SNMP protocol adaptor.

public abstract void set (SnmpMibRequest req)

Processes a set operation. This method must not be called from remote.

Parameters
req The SnmpMibRequest object holding the list of variables to be set. This list is composed of SnmpVarBind objects.
Throws
SnmpStatusException An error occured during the operation.
See Also

public 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. This method is to be called to set a specific agent to a specific OID. This can be useful when dealing with MIB overlapping. Some OID can be implemented in more than one MIB. In this case, the OID nearer agent will be used on SNMP operations.

Parameters
stack The SNMP MIB handler.
oids The set of OIDs this agent implements.

public 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.
This method is used for setting the SNMP MIB handler property of the SNMP MIB agent in case of a standalone agent.

Parameters
stack The SNMP MIB handler.

public 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. Adds a new contextualized MIB in the SNMP MIB handler.

Parameters
stack The SNMP MIB handler.
contextName The MIB context name. If null is passed, will be registered in the default context.
Throws
IllegalArgumentException If the parameter is null.

public 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. Adds a new contextualized MIB in the SNMP MIB handler.

Parameters
stack The SNMP MIB handler.
contextName The MIB context name. If null is passed, will be registered in the default context.
oids The set of OIDs this agent implements.
Throws
IllegalArgumentException If the parameter is null.

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

Parameters
name The name of the SNMP protocol adaptor.
contextName The MIB context name. If null is passed, will be registered in the default context.
oids The set of OIDs this agent implements.
Throws
InstanceNotFoundException The SNMP protocol adaptor does not exist in the MBean server.
ServiceNotFoundException This SNMP MIB is not registered in the MBean server or the requested service is not supported.

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

Parameters
name The object name of the SNMP MIB handler.
Throws
InstanceNotFoundException The MBean does not exist in the MBean server.
ServiceNotFoundException This SNMP MIB is not registered in the MBean server or the requested service is not supported.

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

Parameters
name The name of the SNMP protocol adaptor.
contextName The MIB context name. If null is passed, will be registered in the default context.
Throws
InstanceNotFoundException The SNMP protocol adaptor does not exist in the MBean server.
ServiceNotFoundException This SNMP MIB is not registered in the MBean server or the requested service is not supported.

public 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. This method is to be called to set a specific agent to a specific OID. This can be useful when dealing with MIB overlapping. Some OID can be implemented in more than one MIB. In this case, the OID nearer agent will be used on SNMP operations.

Parameters
name The name of the SNMP protocol adaptor.
oids The set of OIDs this agent implements.
Throws
InstanceNotFoundException The SNMP protocol adaptor does not exist in the MBean server.
ServiceNotFoundException This SNMP MIB is not registered in the MBean server or the requested service is not supported.