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

SnmpMibHandler

public interface SnmpMibHandler
The logical link between an SNMP MIB and the SNMP communication stack.

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

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

Fields Summary
Constructors Summary
Methods Summary
public com.sun.jmx.snmp.agent.SnmpMibHandleraddMib(SnmpMibAgent mib)
Adds a new MIB in the SNMP MIB handler. This method is called automatically by {@link com.sun.jmx.snmp.agent.SnmpMibAgent#setSnmpAdaptor(SnmpMibHandler)} and {@link com.sun.jmx.snmp.agent.SnmpMibAgent#setSnmpAdaptorName(ObjectName)} and should not be called directly.

param
mib The MIB to add.
return
A reference on the SNMP MIB handler.
exception
IllegalArgumentException If the parameter is null.

public com.sun.jmx.snmp.agent.SnmpMibHandleraddMib(SnmpMibAgent mib, com.sun.jmx.snmp.SnmpOid[] oids)
Adds a new MIB in the SNMP MIB handler.

param
mib The MIB to add.
param
oids The array of oid used to add the mib. Each oid is a root oid for the mib.
return
A reference on the SNMP MIB handler.
exception
IllegalArgumentException If the parameter is null.
since
1.5

public com.sun.jmx.snmp.agent.SnmpMibHandleraddMib(SnmpMibAgent mib, java.lang.String contextName)
Adds a new contextualized MIB in the SNMP MIB handler.

param
mib The MIB to add.
param
contextName The MIB context name. If null is passed, will be registered in the default context.
return
A reference to the SNMP MIB handler.
exception
IllegalArgumentException If the parameter is null.
since
1.5

public com.sun.jmx.snmp.agent.SnmpMibHandleraddMib(SnmpMibAgent mib, java.lang.String contextName, com.sun.jmx.snmp.SnmpOid[] oids)
Adds a new contextualized MIB in the SNMP MIB handler.

param
mib The MIB to add.
param
contextName The MIB context name. If null is passed, will be registered in the default context.
param
oids The array of oid used to add the mib. Each oid is a root oid for the mib.
return
A reference to the SNMP MIB handler.
exception
IllegalArgumentException If the parameter is null.
since
1.5

public booleanremoveMib(SnmpMibAgent mib)
Removes the specified MIB from the SNMP protocol adaptor. This method is called automatically by {@link com.sun.jmx.snmp.agent.SnmpMibAgent#setSnmpAdaptor(SnmpMibHandler)} and {@link com.sun.jmx.snmp.agent.SnmpMibAgent#setSnmpAdaptorName(ObjectName)} and should not be called directly.

param
mib The MIB to be removed.
return
true if the specified mib was a MIB included in the SNMP MIB handler, false otherwise.

public booleanremoveMib(SnmpMibAgent mib, com.sun.jmx.snmp.SnmpOid[] oids)
Removes the specified MIB from the SNMP protocol adaptor. This method is called automatically by {@link com.sun.jmx.snmp.agent.SnmpMibAgent#setSnmpAdaptor(SnmpMibHandler)} and {@link com.sun.jmx.snmp.agent.SnmpMibAgent#setSnmpAdaptorName(ObjectName)} and should not be called directly.

param
mib The MIB to be removed.
param
oids The oid the MIB was previously registered for.
return
true if the specified mib was a MIB included in the SNMP MIB handler, false otherwise.
since
1.5

public booleanremoveMib(SnmpMibAgent mib, java.lang.String contextName)
Removes the specified MIB from the SNMP protocol adaptor.

param
mib The MIB to be removed.
param
contextName The context name used at registration time.
return
true if the specified mib was a MIB included in the SNMP MIB handler, false otherwise.
since
1.5

public booleanremoveMib(SnmpMibAgent mib, java.lang.String contextName, com.sun.jmx.snmp.SnmpOid[] oids)
Removes the specified MIB from the SNMP protocol adaptor.

param
mib The MIB to be removed.
param
contextName The context name used at registration time.
param
oids The oid the MIB was previously registered for.
return
true if the specified mib was a MIB included in the SNMP MIB handler, false otherwise.
since
1.5