Package org.snmp4j.model.snmp.proxy.impl

Class SnmpProxyAdapter

java.lang.Object

org.snmp4j.model.snmp.proxy.impl.SnmpProxyAdapter

All Implemented Interfaces:

SnmpProxyCommitter, SnmpProxyReloader, SnmpTransactionStrategy

public class SnmpProxyAdapter
extends Object
implements SnmpProxyCommitter, SnmpProxyReloader, SnmpTransactionStrategy

The SnmpProxyAdapter is the central implementation of the mapping between the SnmpService and a SnmpProxyObject. The adapter is responsible to map changes collection by the proxy objects to change sets queued on the SNMP service. In addition, the adapter provides the mapping of the SNMP values and the corresponding model values. For read operations, this mapping is actually handled by the proxy objects themselves using the {}@link VariableBindingMapper} provided by this adapter.

Author:

Frank Fock

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	SnmpProxyAdapter.CommitListenerProxy
protected class	SnmpProxyAdapter.CommitTask
protected class	SnmpProxyAdapter.ReloadTask

Constructor Summary

Constructors

Constructor	Description
SnmpProxyAdapter(SnmpService snmpService, org.snmp4j.Target target, VariableBindingMapper variableBindingMapper)	Creates a proxy object adapter using a SnmpService, a SNMP Target, and a VariableBindingMapper.

Method Summary

Modifier and Type	Method	Description
void	addChange(SnmpProxyObject proxyObject, SnmpValuesChangeSet change)	Adds a change on the specified proxy object to the queue.
TaskId	commitChanges(SnmpCommitListener commitListener)	Commit the changes in the current queue asynchronously in the background.
SnmpIsolationLevel	getIsolationLevel()	Gets the isolation level for this transaction.
int	getNumberOfPendingChanges()	Gets the total number of changes in the queue (independently of a particular proxy object).
protected List<TaskId>	processReloadQueue(SnmpProxyReloadListener reloadListener)
void	queueReload(SnmpProxyObject proxyObject)	Queue a proxy object for reload.
List<TaskId>	reloadQueued(SnmpProxyReloadListener reloadListener)	Actually reload all queued proxy objects asynchronously in background.
List<SnmpValuesChangeSet>	removeAllChanges(SnmpProxyObject proxyObject)	Remove all changes for a given proxy object.
SnmpValuesChangeSet	removeLastChangeSet(SnmpProxyObject proxyObject)	Remove the last change from the queue for the specified proxy object.
SnmpValuesChangeSet	validateChange(SnmpValuesChangeSet change)	Validate the change set provided.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SnmpProxyAdapter

public SnmpProxyAdapter(SnmpService snmpService,
                        org.snmp4j.Target target,
                        VariableBindingMapper variableBindingMapper)

Creates a proxy object adapter using a SnmpService, a SNMP Target, and a VariableBindingMapper.

Parameters:

snmpService - the SNMP service to use for reloading and updating SNMP values.

target - the target (i.e., address of the SNMP agent) that act as SNMP command responder.

variableBindingMapper - the variable binding mapper that maps between model values and SNMP values and vice versa.

Method Detail

validateChange

public SnmpValuesChangeSet validateChange(SnmpValuesChangeSet change)

Description copied from interface: SnmpProxyCommitter

Validate the change set provided.

Specified by:

validateChange in interface SnmpProxyCommitter

Parameters:

change - a change set.

Returns:

true if the change set is valid that is, if all model values in the change can be mapped (converted) to SNMP values.

addChange

public void addChange(SnmpProxyObject proxyObject,
                      SnmpValuesChangeSet change)

Description copied from interface: SnmpProxyCommitter

Adds a change on the specified proxy object to the queue.

Specified by:

addChange in interface SnmpProxyCommitter

Parameters:

proxyObject - the proxy object that changed.

change - the values change set that describes the changes that should be applied to the proxy and its remote object.

removeLastChangeSet

public SnmpValuesChangeSet removeLastChangeSet(SnmpProxyObject proxyObject)

Description copied from interface: SnmpProxyCommitter

Remove the last change from the queue for the specified proxy object.

Specified by:

removeLastChangeSet in interface SnmpProxyCommitter

Parameters:

proxyObject - the proxy object for which the change to remove was added with SnmpProxyCommitter.addChange(SnmpProxyObject, SnmpValuesChangeSet).

Returns:

the removed change set or null if there is no such change.

removeAllChanges

public List<SnmpValuesChangeSet> removeAllChanges(SnmpProxyObject proxyObject)

Description copied from interface: SnmpProxyCommitter

Remove all changes for a given proxy object.

Specified by:

removeAllChanges in interface SnmpProxyCommitter

Parameters:

proxyObject - the proxy object for which all changes should be removed from the queue.

Returns:

the removed changes (could be an empty list).

commitChanges

public TaskId commitChanges(SnmpCommitListener commitListener)

Description copied from interface: SnmpProxyCommitter

Commit the changes in the current queue asynchronously in the background. Note: changes that are queued after this call returns will not be committed.

Specified by:

commitChanges in interface SnmpProxyCommitter

Parameters:

commitListener - a callback listener for commit status events.

Returns:

the task ID for this commit operation.

getNumberOfPendingChanges

public int getNumberOfPendingChanges()

Description copied from interface: SnmpProxyCommitter

Gets the total number of changes in the queue (independently of a particular proxy object).

Specified by:

getNumberOfPendingChanges in interface SnmpProxyCommitter

Returns:

the number of changes in the queue.

queueReload

public void queueReload(SnmpProxyObject proxyObject)

Description copied from interface: SnmpProxyReloader

Queue a proxy object for reload. No communication with the SNMP target will be performed yet, until SnmpProxyReloader.reloadQueued(SnmpProxyReloadListener) is called.

Specified by:

queueReload in interface SnmpProxyReloader

Parameters:

proxyObject - the proxy object to reload.

reloadQueued

public List<TaskId> reloadQueued(SnmpProxyReloadListener reloadListener)

Description copied from interface: SnmpProxyReloader

Actually reload all queued proxy objects asynchronously in background.

Specified by:

reloadQueued in interface SnmpProxyReloader

Parameters:

reloadListener - the callback listener which receives updates on the reload process.

Returns:

a list of TaskId instances for the each affected proxy object. If a reload for a proxy object failed to start (because of network issues or incorrect target definitions), null is returned for that element.

processReloadQueue

protected List<TaskId> processReloadQueue(SnmpProxyReloadListener reloadListener)

getIsolationLevel

public SnmpIsolationLevel getIsolationLevel()

Description copied from interface: SnmpTransactionStrategy

Gets the isolation level for this transaction. In SNMP isolation of SET requests is managed by TestAndIncr managed objects or not managed at all.

Specified by:

getIsolationLevel in interface SnmpTransactionStrategy

Returns:

the isolation level.