- All Known Subinterfaces:
ChangeableManagedObject<SR>
,GenericManagedObject
,ManagedObjectValueAccess<SR>
,MOTable<R,
,C, M> RandomAccessManagedObject<SR>
,RegisteredManagedObject<SR>
,SerializableManagedObject<SR>
,UpdatableManagedObject<SR>
- All Known Implementing Classes:
AgentppSimulationMib.AgentppSimDeleteRow
,AgentppSimulationMib.AgentppSimDeleteTableContents
,AgentppSimulationMib.AgentppSimMode
,DateAndTimeScalar
,DefaultMOTable
,DisplayStringScalar
,EnumeratedScalar
,MOScalar
,MOSubtreeProxy
,NotificationLogMib.NlmConfigGlobalAgeOut
,NotificationLogMib.NlmConfigGlobalEntryLimit
,Snmp4jConfigMib.Snmp4jCfgReset
,Snmp4jConfigMib.Snmp4jCfgSecSrcAddrValidation
,SnmpTsmMib.SnmpTsmConfigurationUsePrefix
,SnmpUsmDhObjectsMib.UsmDHParameters
,SNMPv2MIB.SysOREntry
,SNMPv2MIB.SysUpTimeImpl
,StaticMOGroup
,TestAndIncr
,TimeStampScalar
,UsmDHParametersImpl
public interface ManagedObject<SR extends SubRequest<?>>
The
ManagedObject
interface defines the basic operations
for all SNMP4J manageable objects.- Version:
- 3.8.0
- Author:
- Frank Fock
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Cleanup a (sub)request and free all resources locked during the preparation phase.void
Commit a previously prepared SET (sub)request.default org.snmp4j.smi.OID
Find the first object ID (OID) in the specified search range.org.snmp4j.smi.OID
Find the first object ID (OID) in the specified search range.void
Process a GET request and return the result in the supplied sub-request.getScope()
Return the scope of object identifiers this managed object is managing.boolean
Deprecated.default boolean
Find 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 a SET (sub)request.void
Compensate (undo) a (sub)request when a commit of another subrequest failed with an error.
-
Method Details
-
getScope
MOScope getScope()Return the scope of object identifiers this managed object is managing.- Returns:
- the
MOScope
that defines a range (possibly also a single or none instance OID) of object IDs managed by this managed object.
-
find
Find the first object ID (OID) in the specified search range.- Parameters:
range
- theMOScope
for the search.- Returns:
- the
OID
that is included in the searchrange
andnull
if no such instances could be found.
-
find
Find the first object ID (OID) in the specified search range.- Parameters:
query
- theMOQuery
for the search.filter
- the filter criteria that needs to be true on the OID to be returned. If the filter returnsfalse
onFunction.apply(Object)
then the next OID is being tested that is in the provided range.- Returns:
- the first
OID
that is included in the searchrange
and for which the filter criteria istrue
. Otherwisenull
if no such instances could be found. - Since:
- 3.8.0
-
get
Process a GET request and return the result in the supplied sub-request.- Parameters:
request
- theSubRequest
to process.
-
next
Deprecated.Usenext(SubRequest, Function)
instead to applyVACM
inner ManagedObject OID filtering. This is import especially for multi OID objects like tables and subtrees.Find the successor instance for the object instance ID (OID) given by the supplied sub-request and returns it within the supplied sub-request object.- Parameters:
request
- theSubRequest
to process.- Returns:
true
if the search request found an appropriate instance,false
otherwise.
-
next
Find the successor instance for the object instance ID (OID) given by the supplied sub-request and returns it within the supplied sub-request object.- Parameters:
request
- theSubRequest
to process.filter
- the filter criteria that needs to be true on the OID to be returned. If the filter returnsfalse
onFunction.apply(Object)
then the next OID is being tested that is in the provided request's range.- Returns:
true
if the search request found an appropriate instance,false
otherwise.- Since:
- 3.8.0
-
prepare
Prepare a SET (sub)request. This method represents the first phase of a two phase commit. During preparation all necessary resources should be locked in order to be able to execute the commit without claiming additional resources.- Parameters:
request
- theSubRequest
to process.
-
commit
Commit a previously prepared SET (sub)request. This is the second phase of a two phase commit. The change is committed but the resources locked during prepare not freed yet.- Parameters:
request
- theSubRequest
to process.
-
undo
Compensate (undo) a (sub)request when a commit of another subrequest failed with an error. This also frees any resources locked during the preparation phase.- Parameters:
request
- theSubRequest
to process.
-
cleanup
Cleanup a (sub)request and free all resources locked during the preparation phase.- Parameters:
request
- theSubRequest
to process.
-
next(SubRequest, Function)
instead to applyVACM
inner ManagedObject OID filtering.