com.sun.jdmk.snmp.usm.usmmib
Class UsmUserEntryMeta

java.lang.Object
  extended bycom.sun.jdmk.snmp.agent.SnmpMibNode
      extended bycom.sun.jdmk.snmp.agent.SnmpMibEntry
          extended bycom.sun.jdmk.snmp.usm.usmmib.UsmUserEntryMeta
All Implemented Interfaces:
Serializable, SnmpStandardMetaServer

Deprecated. Use package com.sun.management.snmp.usm.usmmib in preference to classes in this package. This class may be removed in a future version of Java DMK.

public class UsmUserEntryMeta
extends SnmpMibEntry
implements Serializable, SnmpStandardMetaServer

The class is used for representing SNMP metadata for the "UsmUserEntry" group. The group is defined with the following oid: 1.3.6.1.6.3.15.1.2.2.1.

Since:
Java DMK 5.0
See Also:
Serialized Form

Field Summary
protected  UsmUserEntryMBean node
          Deprecated.  
protected  SnmpStandardObjectServer objectserver
          Deprecated.  
 
Fields inherited from class com.sun.jdmk.snmp.agent.SnmpMibNode
noSuchInstanceException, noSuchNameException, noSuchObjectException, varList
 
Constructor Summary
UsmUserEntryMeta(SnmpMib myMib, SnmpStandardObjectServer objserv)
          Deprecated. Constructor for the metadata associated to "UsmUserEntry".
 
Method Summary
 void check(SnmpMibSubRequest req, int depth)
          Deprecated. Generic handling of the check operation.
 void check(SnmpValue x, long var, Object data)
          Deprecated. Check the value of a scalar variable
 SnmpValue get(long var, Object data)
          Deprecated. Get the value of a scalar variable
 void get(SnmpMibSubRequest req, int depth)
          Deprecated. Generic handling of the get operation.
 String getAttributeName(long id)
          Deprecated. Return the name of the attribute corresponding to the SNMP variable identified by "id".
 int getRowStatus(Object userData)
          Deprecated.  
 long getRowStatusId()
          Deprecated.  
 String getRowStatusName()
          Deprecated.  
 boolean isReadable(long arc)
          Deprecated. Returns true if "arc" identifies a readable scalar object.
 boolean isRowReady(Object userData)
          Deprecated.  
 boolean isVariable(long arc)
          Deprecated. Returns true if "arc" identifies a scalar object.
protected  int mapRowStatus(SnmpVarBind var, Object userData)
          Deprecated.  
 void set(SnmpMibSubRequest req, int depth)
          Deprecated. Generic handling of the set operation.
 SnmpValue set(SnmpValue x, long var, Object data)
          Deprecated. Set the value of a scalar variable
protected  void setInstance(UsmUserEntryMBean var)
          Deprecated. Allow to bind the metadata description to a specific object.
 SnmpValue setRowStatus(int status, Object userData)
          Deprecated.  
 
Methods inherited from class com.sun.jdmk.snmp.agent.SnmpMibEntry
getNextVarId, validateVarId
 
Methods inherited from class com.sun.jdmk.snmp.agent.SnmpMibNode
getNextIdentifier, getNextVarId, getRootOid, skipVariable, sort
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

node

protected UsmUserEntryMBean node
Deprecated. 

objectserver

protected SnmpStandardObjectServer objectserver
Deprecated. 
Constructor Detail

UsmUserEntryMeta

public UsmUserEntryMeta(SnmpMib myMib,
                        SnmpStandardObjectServer objserv)
Deprecated. 
Constructor for the metadata associated to "UsmUserEntry".

Method Detail

get

public SnmpValue get(long var,
                     Object data)
              throws SnmpStatusException
Deprecated. 
Get the value of a scalar variable

Specified by:
get in interface SnmpStandardMetaServer
Parameters:
var - OID arc of the queried scalar object.
data - A contextual object containing user-data. This object is allocated through the SnmpUserDataFactory for each incoming SNMP request.
Returns:
The SnmpValue of the scalar object identified by arc.
Throws:
SnmpStatusException - If the arc is not valid, or if access is denied.

set

public SnmpValue set(SnmpValue x,
                     long var,
                     Object data)
              throws SnmpStatusException
Deprecated. 
Set the value of a scalar variable

Specified by:
set in interface SnmpStandardMetaServer
Parameters:
x - New value for the scalar object identified by arc
var - OID arc of the scalar object whose value is set.
data - A contextual object containing user-data. This object is allocated through the SnmpUserDataFactory for each incoming SNMP request.
Returns:
The new SnmpValue of the scalar object identified by arc.
Throws:
SnmpStatusException - If the arc is not valid, or if access is denied.

check

public void check(SnmpValue x,
                  long var,
                  Object data)
           throws SnmpStatusException
Deprecated. 
Check the value of a scalar variable

Specified by:
check in interface SnmpStandardMetaServer
Parameters:
x - New value for the scalar object identified by arc
var - OID arc of the scalar object whose value is set.
data - A contextual object containing user-data. This object is allocated through the SnmpUserDataFactory for each incoming SNMP request.
Throws:
SnmpStatusException - If the arc is not valid, or if access is denied, or if the new desired value is not valid.

setInstance

protected void setInstance(UsmUserEntryMBean var)
Deprecated. 
Allow to bind the metadata description to a specific object.


get

public void get(SnmpMibSubRequest req,
                int depth)
         throws SnmpStatusException
Deprecated. 
Description copied from class: SnmpMibEntry
Generic handling of the get operation.

The actual implementation of this method will be generated by mibgen. Usually, this implementation only delegates the job to some other provided runtime class, which knows how to access the MBean. The current toolkit thus provides two implementations:

Both implementations rely upon specific - and distinct, set of mibgen generated methods.

You can override this method if you need to implement some specific policies for minimizing the accesses made to some remote underlying resources.

Specified by:
get in class SnmpMibEntry
Parameters:
req - The sub-request that must be handled by this node.
depth - The depth reached in the OID tree.
Throws:
SnmpStatusException - An error occurred while accessing the MIB node.

set

public void set(SnmpMibSubRequest req,
                int depth)
         throws SnmpStatusException
Deprecated. 
Description copied from class: SnmpMibEntry
Generic handling of the set operation.

The actual implementation of this method will be generated by mibgen. Usually, this implementation only delegates the job to some other provided runtime class, which knows how to access the MBean. The current toolkit thus provides two implementations:

Both implementations rely upon specific - and distinct, set of mibgen generated methods.

You can override this method if you need to implement some specific policies for minimizing the accesses made to some remote underlying resources.

Specified by:
set in class SnmpMibEntry
Parameters:
req - The sub-request that must be handled by this node.
depth - The depth reached in the OID tree.
Throws:
SnmpStatusException - An error occurred while accessing the MIB node.

check

public void check(SnmpMibSubRequest req,
                  int depth)
           throws SnmpStatusException
Deprecated. 
Description copied from class: SnmpMibEntry
Generic handling of the check operation.

The actual implementation of this method will be generated by mibgen. Usually, this implementation only delegates the job to some other provided runtime class, which knows how to access the MBean. The current toolkit thus provides two implementations:

Both implementations rely upon specific - and distinct, set of mibgen generated methods.

You can override this method if you need to implement some specific policies for minimizing the accesses made to some remote underlying resources, or if you need to implement some consistency checks between the different values provided in the varbind list.

Specified by:
check in class SnmpMibEntry
Parameters:
req - The sub-request that must be handled by this node.
depth - The depth reached in the OID tree.
Throws:
SnmpStatusException - An error occurred while accessing the MIB node.

isVariable

public boolean isVariable(long arc)
Deprecated. 
Returns true if "arc" identifies a scalar object.

Specified by:
isVariable in class SnmpMibEntry
Parameters:
arc - An OID arc.
Returns:
true if `arc' leads to a variable.

isReadable

public boolean isReadable(long arc)
Deprecated. 
Returns true if "arc" identifies a readable scalar object.

Specified by:
isReadable in class SnmpMibEntry
Parameters:
arc - An OID arc.
Returns:
true if `arc' leads to a readable variable.

getAttributeName

public String getAttributeName(long id)
                        throws SnmpStatusException
Deprecated. 
Return the name of the attribute corresponding to the SNMP variable identified by "id".

Throws:
SnmpStatusException

getRowStatusId

public long getRowStatusId()
Deprecated. 

getRowStatusName

public String getRowStatusName()
Deprecated. 

mapRowStatus

protected int mapRowStatus(SnmpVarBind var,
                           Object userData)
                    throws SnmpStatusException
Deprecated. 
Throws:
SnmpStatusException

getRowStatus

public int getRowStatus(Object userData)
                 throws SnmpStatusException
Deprecated. 
Throws:
SnmpStatusException

setRowStatus

public SnmpValue setRowStatus(int status,
                              Object userData)
                       throws SnmpStatusException
Deprecated. 
Throws:
SnmpStatusException

isRowReady

public boolean isRowReady(Object userData)
                   throws SnmpStatusException
Deprecated. 
Throws:
SnmpStatusException

FCS Release
jdmk-5_1-b34.2 2005.11.29_16:24:00_MET

Copyright 1998-2004 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms.