FileDocCategorySizeDatePackage
SnmpMibAgentMBean.javaAPI DocJava SE 5 API11393Fri Aug 26 14:55:04 BST 2005com.sun.jmx.snmp.agent

SnmpMibAgentMBean

public interface SnmpMibAgentMBean
Exposes the remote management interface of the SnmpMibAgent MBean.

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

version
1.24 12/19/03
author
Sun Microsystems, Inc

Fields Summary
Constructors Summary
Methods Summary
public voidcheck(SnmpMibRequest req)
Checks if a set operation can be performed. If the operation cannot be performed, the method should emit a SnmpStatusException.

param
req The SnmpMibRequest object holding the list of variables to be set. This list is composed of SnmpVarBind objects.
exception
SnmpStatusException The set operation cannot be performed.
see
SnmpMibAgent#check(SnmpMibRequest)

public voidget(SnmpMibRequest req)
Processes a get operation. This method must not be called from remote.

param
req The SnmpMibRequest object holding the list of variables to be retrieved. This list is composed of SnmpVarBind objects.
exception
SnmpStatusException An error occured during the operation.
see
SnmpMibAgent#get(SnmpMibRequest)

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

return
true if the MIB module is bound, false otherwise.

public voidgetBulk(SnmpMibRequest req, int nonRepeat, int maxRepeat)
Processes a getBulk operation. This method must not be called from remote.

param
req The SnmpMibRequest object holding the list of variables to be retrieved. This list is composed of SnmpVarBind objects.
param
nonRepeat The number of variables, starting with the first variable in the variable-bindings, for which a single lexicographic successor is requested.
param
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.
exception
SnmpStatusException An error occured during the operation.
see
SnmpMibAgent#getBulk(SnmpMibRequest,int,int)

public javax.management.MBeanServergetMBeanServer()
Gets the reference to the MBean server in which the SNMP MIB is registered.

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

public java.lang.StringgetMibName()
Gets the MIB name.

return
The MIB name.

public voidgetNext(SnmpMibRequest req)
Processes a getNext operation. This method must not be called from remote.

param
req The SnmpMibRequest object holding the list of variables to be retrieved. This list is composed of SnmpVarBind objects.
exception
SnmpStatusException An error occured during the operation.
see
SnmpMibAgent#getNext(SnmpMibRequest)

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

return
The SNMP MIB handler.

public javax.management.ObjectNamegetSnmpAdaptorName()
Gets the object name of the SNMP protocol adaptor to which the MIB is bound.

return
The name of the SNMP protocol adaptor.

public voidset(SnmpMibRequest req)
Processes a set operation. This method must not be called from remote.

param
req The SnmpMibRequest object holding the list of variables to be set. This list is composed of SnmpVarBind objects.
exception
SnmpStatusException An error occured during the operation.
see
SnmpMibAgent#set(SnmpMibRequest)

public voidsetSnmpAdaptor(SnmpMibHandler stack, java.lang.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.

param
stack The SNMP MIB handler.
param
contextName The MIB context name. If null is passed, will be registered in the default context.
exception
IllegalArgumentException If the parameter is null.
since
1.5

public voidsetSnmpAdaptor(SnmpMibHandler stack, java.lang.String contextName, com.sun.jmx.snmp.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.

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

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

param
stack The SNMP MIB handler.

public voidsetSnmpAdaptor(SnmpMibHandler stack, com.sun.jmx.snmp.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.

param
stack The SNMP MIB handler.
param
oids The set of OIDs this agent implements.
since
1.5

public voidsetSnmpAdaptorName(javax.management.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.

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

public voidsetSnmpAdaptorName(javax.management.ObjectName name, com.sun.jmx.snmp.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.

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

public voidsetSnmpAdaptorName(javax.management.ObjectName name, java.lang.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.

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

public voidsetSnmpAdaptorName(javax.management.ObjectName name, java.lang.String contextName, com.sun.jmx.snmp.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.

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