- java.lang.Object
-
- org.snmp4j.agent.mo.ext.StaticMOGroup
-
- All Implemented Interfaces:
ManagedObject
,MOGroup
public class StaticMOGroup extends java.lang.Object implements ManagedObject, MOGroup
TheStaticMOGroup
can be used to easily implement static (read-only) managed objects.Note: Dynamic variables (see
Variable.isDynamic()
) cannot be used to when using defaultVariableBinding
s sinceVariable
s are cloned when added to them. In order to use dynamic objects (i.e., objects that may change their value when being accessed), a sub-class ofVariableBinding
needs to be used that overwrites itsVariableBinding.setVariable(org.snmp4j.smi.Variable)
method.- Since:
- 1.2
- Version:
- 1.2
- Author:
- Frank Fock
-
-
Constructor Summary
Constructors Constructor Description StaticMOGroup(org.snmp4j.smi.OID root, org.snmp4j.smi.VariableBinding[] vbs)
Creates a static managed object group for the sub-tree with the specified root OID.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
cleanup(SubRequest request)
Cleansup a (sub)request and frees all resources locked during the preparation phase.void
commit(SubRequest request)
Sets the error status of the request toPDU.commitFailed
.org.snmp4j.smi.OID
find(MOScope range)
Finds the first object ID (OID) in the specified search range.void
get(SubRequest request)
Processes a GET request and return the result in the supplied sub-request.MOScope
getScope()
Returns the scope of object identifiers this managed object is managing.boolean
next(SubRequest request)
Finds the successor instance for the object instance ID (OID) given by the supplied sub-request and returns it within the supplied sub-request object.void
prepare(SubRequest request)
Sets the error status of the request toPDU.notWritable
.void
registerMOs(MOServer server, org.snmp4j.smi.OctetString context)
Registers the managed objects of this group with the server for the supplied context.java.lang.String
toString()
void
undo(SubRequest request)
Sets the error status of the request toPDU.undoFailed
.void
unregisterMOs(MOServer server, org.snmp4j.smi.OctetString context)
Unregisters the managed objects of this group from the supplied server and from the supplied context.
-
-
-
Constructor Detail
-
StaticMOGroup
public StaticMOGroup(org.snmp4j.smi.OID root, org.snmp4j.smi.VariableBinding[] vbs)
Creates a static managed object group for the sub-tree with the specified root OID.- Parameters:
root
- the root OID of the sub-tree to be registered by this managed object.vbs
- the variable bindings to be returned in this sub-tree.
-
-
Method Detail
-
registerMOs
public void registerMOs(MOServer server, org.snmp4j.smi.OctetString context) throws DuplicateRegistrationException
Description copied from interface:MOGroup
Registers the managed objects of this group with the server for the supplied context.- Specified by:
registerMOs
in interfaceMOGroup
- Parameters:
server
- theMOServer
where to register the managed objects.context
- the context to use (may benull
if no specific context is selected).- Throws:
DuplicateRegistrationException
- if a managed object's scope (i.e. lower bound) is already registered at the server.
-
unregisterMOs
public void unregisterMOs(MOServer server, org.snmp4j.smi.OctetString context)
Description copied from interface:MOGroup
Unregisters the managed objects of this group from the supplied server and from the supplied context.- Specified by:
unregisterMOs
in interfaceMOGroup
- Parameters:
server
- theMOServer
where to unregister the managed objects.context
- the context to use (may benull
if no specific context is selected).
-
getScope
public MOScope getScope()
Description copied from interface:ManagedObject
Returns the scope of object identifiers this managed object is managing.- Specified by:
getScope
in interfaceManagedObject
- Returns:
- the
MOScope
that defines a range (possibly also a single or none instance OID) of object IDs managed by this managed object.
-
find
public org.snmp4j.smi.OID find(MOScope range)
Description copied from interface:ManagedObject
Finds the first object ID (OID) in the specified search range.- Specified by:
find
in interfaceManagedObject
- Parameters:
range
- theMOScope
for the search.- Returns:
- the
OID
that is included in the searchrange
andnull
if no such instances could be found.
-
get
public void get(SubRequest request)
Description copied from interface:ManagedObject
Processes a GET request and return the result in the supplied sub-request.- Specified by:
get
in interfaceManagedObject
- Parameters:
request
- theSubRequest
to process.
-
next
public boolean next(SubRequest request)
Description copied from interface:ManagedObject
Finds the successor instance for the object instance ID (OID) given by the supplied sub-request and returns it within the supplied sub-request object.- Specified by:
next
in interfaceManagedObject
- Parameters:
request
- theSubRequest
to process.- Returns:
true
if the search request found an appropriate instance,false
otherwise.
-
prepare
public void prepare(SubRequest request)
Sets the error status of the request toPDU.notWritable
.- Specified by:
prepare
in interfaceManagedObject
- Parameters:
request
- a request to process prepare SET request for.
-
commit
public void commit(SubRequest request)
Sets the error status of the request toPDU.commitFailed
.- Specified by:
commit
in interfaceManagedObject
- Parameters:
request
- a request to process commit SET request for.
-
undo
public void undo(SubRequest request)
Sets the error status of the request toPDU.undoFailed
.- Specified by:
undo
in interfaceManagedObject
- Parameters:
request
- a request to process undo SET request for.
-
cleanup
public void cleanup(SubRequest request)
Description copied from interface:ManagedObject
Cleansup a (sub)request and frees all resources locked during the preparation phase.- Specified by:
cleanup
in interfaceManagedObject
- Parameters:
request
- theSubRequest
to process.
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-