|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.ocap.diagnostics.MIBManager
public abstract class MIBManager
The MIBManager class provides Management Information Base (MIB) access to the host's MIB. Applications may use the MIBManager to make MIB queries. In addition, applications can set a MIB Object that can be retrieved from the Host device using SNMP.
Field Summary | |
---|---|
static int |
MIB_ACCESS_READONLY
Constant used to specify read-only access for the MIB being registered. |
static int |
MIB_ACCESS_READWRITE
Constant used to specify read/write access for the MIB being registered. |
static int |
MIB_ACCESS_WRITEONLY
Constant used to specify write-only access for the MIB being registered. |
Constructor Summary | |
---|---|
protected |
MIBManager()
Protected constructor, no application access. |
Method Summary | |
---|---|
static MIBManager |
getInstance()
Gets the MIBManager. |
abstract MIBDefinition[] |
queryMibs(java.lang.String oid)
Makes a query for all MIB objects matching the oid parameter, as well as any descendants in the MIB tree. |
abstract void |
registerOID(java.lang.String oid,
int access,
boolean leaf,
int dataType,
MIBListener listener)
Registers a MIB object by adding the OID and listener to the MIB tables. |
abstract void |
setMIBObject(MIBObject mibToSet)
Sets a Host MIB object. |
abstract void |
unregisterOID(java.lang.String oid)
Unregisters a previously registered OID if the OID was registered by the same application. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int MIB_ACCESS_READONLY
registerOID(java.lang.String, int, boolean, int, org.ocap.diagnostics.MIBListener)
,
Constant Field Valuespublic static final int MIB_ACCESS_READWRITE
registerOID(java.lang.String, int, boolean, int, org.ocap.diagnostics.MIBListener)
,
Constant Field Valuespublic static final int MIB_ACCESS_WRITEONLY
registerOID(java.lang.String, int, boolean, int, org.ocap.diagnostics.MIBListener)
,
Constant Field ValuesConstructor Detail |
---|
protected MIBManager()
Method Detail |
---|
public static MIBManager getInstance()
java.lang.SecurityException
- if the calling application does not have
MonitorAppPermission("diagnostics").public abstract void registerOID(java.lang.String oid, int access, boolean leaf, int dataType, MIBListener listener)
oid
- The Object Identifier of the MIB being registered. The
format of the string is based on the format defined by RFC 2578 for
OBJECT IDENTIFIER definition. Terms in the string are period
delimited, e.g. "1.3.6.1.4.1".leaf
- When true indicates if the object is a leaf, otherwise the
object is a non-leaf table column.access
- Indicates allowed access to the MIB being registered. See
access constants in the class for valid values.dataType
- The data type of the MIB being registered. See constants
in MIBDefinition
for valid values.listener
- Listener to the MIB being registered. Must not be null.
java.lang.IllegalArgumentException
- if oid is an invalid oid string,
if oid is already installed, or any other parameter has an
invalid value.public abstract void unregisterOID(java.lang.String oid)
oid
- An object identifier that was passed to the registerOID
method.
java.lang.IllegalArgumentException
- if parameter does not match an OID
registered with the registerOID method.public abstract MIBDefinition[] queryMibs(java.lang.String oid)
When both the Host device and CableCARD support the CARD MIB Access resource and the oid parameter is equal to the OID or within the subtree of the OID returned by the get_rootOID_req APDU, then the implementation SHALL use the snmp_request APDU in order to satisfy the query.
If the CableCARD supports MIB APDUs, then this method SHALL be able to query the CableCARD MIB objects.
oid
- The object identifier to search for. The format of the
string is based on the format defined by RFC 2578 for
OBJECT IDENTIFIER definition. Terms in the string
are period delimited, e.g. "1.3.6.1.4.1".
public abstract void setMIBObject(MIBObject mibToSet)
Note: CableCARD MIBs cannot be set using this method.
mibToSet
- The MIB to set. The OID in the MIBObject SHALL be used to
replace values with the data array in the parameter.
java.lang.IllegalArgumentException
- if the OID in the MIBObject parameter does
not reference a supported Host MIB or if the data attribute in the MIBObject
parameter is not in the correct ASN.1 form for the OID.
java.lang.SecurityException
- if the MIB is not writable or if the calling
application does not have MonitorAppPermission("diagnostics").
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |