Commit 4696fcd8 authored by kkershaw's avatar kkershaw

Update for EC OCAP1.1.5-O-09.1388-6

parent e165afce
......@@ -8,23 +8,21 @@ package org.ocap.diagnostics;
*/
public abstract class MIBManager
{
/**
* Constant used to specify read-only access for the MIB being registered.
* @see #registerOID
*/
public final static int MIB_ACCESS_READONLY = 0;
public final static int MIB_ACCESS_READWRITE = 1;
public final static int MIB_ACCESS_WRITEONLY = 2;
/**
* Constant used to specify read/write access for the MIB being registered.
* @see #registerOID
* Used to identify the subdevice type and query eCM MIB values.
*/
public final static int MIB_ACCESS_READWRITE = 1;
public final static int ECM_SUBDEVICE = 1;
/**
* Constant used to specify write-only access for the MIB being registered.
* @see #registerOID
* Used to identify the subdevice type and query Host MIB values.
*/
public final static int MIB_ACCESS_WRITEONLY = 2;
public final static int ESTB_SUBDEVICE = ECM_SUBDEVICE + 1;
/**
* Protected constructor, no application access.
......@@ -61,11 +59,10 @@ public abstract class MIBManager
* 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".
* @param leaf When true indicates if the object is a leaf, otherwise the
* object is a non-leaf table column.
* @param access Indicates allowed access to the MIB being registered. See
* access constants in the class for valid values.
* @param dataType The data type of the MIB being registered. See constants
* @param leaf When true indicates if the object is a leaf, otherwise the
* object is a non-leaf table column. * @param dataType The data type of the MIB being registered. See constants
* in {@link MIBDefinition} for valid values.
* @param listener Listener to the MIB being registered. Must not be null.
*
......@@ -106,19 +103,9 @@ public abstract class MIBManager
* OID. For example; if 1.2.3.4 is the query OID then 1.2.3.5 is not
* returned. </p><p>
*
* </p><p>
* 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.
* </p>
*
*
* If the CableCARD supports MIB APDUs, then this method SHALL be able to
* query the CableCARD MIB objects. </p>
* query the CableCARD MIB objects. </p>
*
*
* @param 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
......@@ -130,11 +117,50 @@ public abstract class MIBManager
*/
public abstract MIBDefinition [] queryMibs(String oid);
/**
* Makes a query for all MIB objects matching the oid parameter, as
* well as any descendants in the MIB tree, in a specific sub-device
* including eSTB and eCM. If the object to be searched
* for is a leaf the trailing ".0" must be included for an exact match.
* A query for a leaf object SHALL return just that object if found. A
* query for a non-leaf OID SHALL return all MIB objects below that OID.
* Existing leaf and table items SHALL be included in the results;
* branch-nodes without data SHALL NOT. For example; If a query is for
* OID 1.2.3.4 then all table items and leafs below that OID are returned.
* If OIDs 1.2.3.4.1 and 1.2.3.4.2 are the only items below the query object
* they would be returned. The query SHALL NOT return items outside the
* OID. For example; if 1.2.3.4 is the query OID then 1.2.3.5 is not
* returned.</p><p>
*
* If ECM_SUBDEVICE is the subDevice argument value the implementation SHALL
* allow eCM MIB query in an implementation specific fashion. The Host
* device may restrict eCM MIB access to a particular subset of MIB objects;
* see Host CFR for required eCM MIB support.
*
* @param subDevice The sub-device to read the MIB from. Using
* ESTB_SUBDEVICE is equivalent to calling
* <code>queryMibs(String)</code>.
* @param 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".
*
* @return An array of MIB definitions. The array is lexographically ordered
* by increasing value of OID with the lowest value in the first element
* of the array.
*
* @throws IllegalArgumentException if the subDevice is not one of the
* ECM_SUBDEVICE or ESTB_SUBDEVICE.
*/
public abstract MIBDefinition [] queryMibs(int subDevice, String oid);
/**
* Sets a Host MIB object. The OID in the MIBObject parameter must reference
* a writable MIB object supported by the implementation. </p><p>
*
* Note: CableCARD MIBs cannot be set using this method. </p>
* Note; This method can only set writable MIBs in the Host device
* (i.e. ESTB_SUBDEVICE). Writable MIBs for other sub-devices such as
* CableCARD and eCM cannot be set using this method. </p>
*
* @param mibToSet The MIB to set. The OID in the MIBObject SHALL be used to
* replace values with the data array in the parameter.
......@@ -147,3 +173,5 @@ public abstract class MIBManager
*/
public abstract void setMIBObject(MIBObject mibToSet);
}
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment