public class MOSubtreeProxy extends Object implements ManagedObject
ProxyForwarder
, the MOSubtreeProxy
provides a proxy implementation for a single subtree based on the
configuration provided by the Snmp4jProxyMib
SnmpProxyMIB
and SnmpTargetMIB
.Modifier and Type | Class and Description |
---|---|
class |
MOSubtreeProxy.OIDTranslator |
Constructor and Description |
---|
MOSubtreeProxy(org.snmp4j.Session session,
SnmpTargetMIB targetMIB,
org.snmp4j.smi.OctetString proxyName,
org.snmp4j.smi.OID subtreeOID,
org.snmp4j.smi.OctetString contextEngineID,
org.snmp4j.smi.OctetString contextName,
org.snmp4j.smi.OctetString targetName) |
Modifier and Type | Method and Description |
---|---|
void |
cleanup(SubRequest request)
Cleansup a (sub)request and frees all resources locked during
the preparation phase.
|
void |
commit(SubRequest request)
Commits a previously prepared SET (sub)request.
|
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.
|
MOAccess |
getAccess() |
org.snmp4j.smi.OctetString |
getProxyName() |
MOScope |
getScope()
Returns the scope of object identifiers this managed object is managing.
|
OIDTranslation |
getTranslation() |
boolean |
isUndoEnabled()
Returns whether undo of SET operations should be supported by this sub-tree proxy or not.
|
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)
Prepares a SET (sub)request.
|
void |
setAccess(MOAccess access) |
void |
setTargetSubtree(org.snmp4j.smi.OID remoteSubtree)
Sets the remote sub-tree OID for the translation between local
agent OID and remote agent OID.
|
void |
setTranslation(OIDTranslation translation)
Sets a OID translation.
|
void |
setUndoEnabled(boolean undoEnabled)
Enables or disables undo support for SET operations.
|
String |
toString() |
void |
undo(SubRequest request)
Compensates (undo) a (sub)request when a commit of another subrequest
failed with an error.
|
public MOSubtreeProxy(org.snmp4j.Session session, SnmpTargetMIB targetMIB, org.snmp4j.smi.OctetString proxyName, org.snmp4j.smi.OID subtreeOID, org.snmp4j.smi.OctetString contextEngineID, org.snmp4j.smi.OctetString contextName, org.snmp4j.smi.OctetString targetName)
public MOScope getScope()
ManagedObject
getScope
in interface ManagedObject
MOScope
that defines a range (possibly also a single
or none instance OID) of object IDs managed by this managed object.public org.snmp4j.smi.OID find(MOScope range)
ManagedObject
find
in interface ManagedObject
range
- the MOScope
for the search.OID
that is included in the search range
and null
if no such instances could be found.public void setTargetSubtree(org.snmp4j.smi.OID remoteSubtree)
remoteSubtree
- the OID sub-tree of the target agent to proxy.public void get(SubRequest request)
ManagedObject
get
in interface ManagedObject
request
- the SubRequest
to process.public boolean next(SubRequest request)
ManagedObject
next
in interface ManagedObject
request
- the SubRequest
to process.true
if the search request found an appropriate instance,
false
otherwise.public void prepare(SubRequest request)
ManagedObject
prepare
in interface ManagedObject
request
- the SubRequest
to process.public void commit(SubRequest request)
ManagedObject
commit
in interface ManagedObject
request
- the SubRequest
to process.public void undo(SubRequest request)
ManagedObject
undo
in interface ManagedObject
request
- the SubRequest
to process.public void cleanup(SubRequest request)
ManagedObject
cleanup
in interface ManagedObject
request
- the SubRequest
to process.public boolean isUndoEnabled()
true
is returned, a GET requests will be sent to the target SNMP entity
before the SET operation to retrieve the old (undo) value. If the SET operation fails
because of some error in this sub-request or any other sub-request of the same SNMP PDU,
the already SET value in the target will be reset to the old value.true
if undo values will be retrieved for this sub-tree (default),
false
otherwise (SET requests will be committed directly without previous GET).public void setUndoEnabled(boolean undoEnabled)
true
, a GET requests will be sent to the target SNMP entity
before the SET operation to retrieve the old (undo) value. If the SET operation fails
because of some error in this sub-request or any other sub-request of the same SNMP PDU,
the already SET value in the target will be reset to the old value.undoEnabled
- true
if undo values should be retrieved for this sub-tree (default),
false
otherwise (SET requests will be committed directly without previous GET).public org.snmp4j.smi.OctetString getProxyName()
public MOAccess getAccess()
public void setAccess(MOAccess access)
public OIDTranslation getTranslation()
public void setTranslation(OIDTranslation translation)
translation
- If not null, the OIDTranslation
can be
used to map between local OID and remote OID and vice
versa.Copyright © 2018 SNMP4J.org. All rights reserved.