Package org.snmp4j.model.snmp.proxy
Interface SnmpProxyObject
- All Known Subinterfaces:
SnmpScalar<T>
,SnmpScalarGroup
,SnmpScalarGroupRO
,SnmpScalarRO<T>
,SnmpSubTreeRO<T>
,SnmpTable<C,
,IC, IT, T, R> SnmpTableRO<IC,
C, IT, T, R>
- All Known Implementing Classes:
SnmpGroupImplRO
,SnmpProxyObjectImpl
,SnmpScalarImpl
,SnmpScalarImplRO
,SnmpSubTreeImplRO
,SnmpTableImpl
,SnmpTableImplRO
public interface SnmpProxyObject
The
SnmpProxyObject
interface provides the basic characteristics for a proxy object for some
SNMP entity data.- Author:
- Frank Fock
-
Method Summary
Modifier and TypeMethodDescriptionorg.snmp4j.smi.OctetString
Get the context of the proxy object.org.snmp4j.smi.OID
getOID()
Gets the unique identifier of this proxy object.reload
(SnmpService snmpService, org.snmp4j.Target target, VariableBindingMapper variableBindingMapper, SnmpProxyReloadListener reloadListener) Reload the model content of the proxy object from the target SNMP entity asynchronously in the background.boolean
waitForTask
(TaskId taskId, long timeout) Wait until the specified background task terminates.
-
Method Details
-
getOID
org.snmp4j.smi.OID getOID()Gets the unique identifier of this proxy object. Typically this is the root OID of the MIB objects managed by this proxy. If the proxy manages a single instance only, this should be the instance identifier.- Returns:
- the OID for this proxy object.
-
reload
TaskId reload(SnmpService snmpService, org.snmp4j.Target target, VariableBindingMapper variableBindingMapper, SnmpProxyReloadListener reloadListener) Reload the model content of the proxy object from the target SNMP entity asynchronously in the background.- Parameters:
snmpService
- the SNMP service to use.target
- the SNMP target (i.e., address, timeouts, etc.) to use.variableBindingMapper
- the variable binding mapper that maps the retrieved SNMP values to model values (based on SNMP types or specific OID based mappings).reloadListener
- a callback listener that is informed about the reloading status.- Returns:
- the task ID for the background task.
-
waitForTask
Wait until the specified background task terminates.- Parameters:
taskId
- the task ID of the task to wait for.timeout
- the maximum time to wait in millis.- Returns:
true
if the task has terminated,false
otherwise.
-
getContext
org.snmp4j.smi.OctetString getContext()Get the context of the proxy object.- Returns:
- the context associated with this proxy object.
-