Module org.snmp4j

Package org.snmp4j.transport

Class DummyTransport<A extends IpAddress>

java.lang.Object

org.snmp4j.transport.AbstractTransportMapping<A>

org.snmp4j.transport.DummyTransport<A>

All Implemented Interfaces:

Closeable, AutoCloseable, TransportMapping<A>

public class DummyTransport<A extends IpAddress>
extends AbstractTransportMapping<A>

The DummyTransport is a test TransportMapping for Command Generators which actually does not sent messages over the network. Instead it provides the message transparently as incoming message over the DummyTransport<A extends IpAddress>.DummyTransportResponder on a virtual listen address, regardless to which outbound address the message was sent. The messages are returned even if the listenAddress is left null.

Since:

2.0

Author:

Frank Fock

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	DummyTransport.DummyTransportResponder

Field Summary

Fields inherited from class org.snmp4j.transport.AbstractTransportMapping

asyncMsgProcessingSupported, connectionTimeout, listenWorkerTask, maxInboundMessageSize, socketCleaner, suspendedAddresses, transportListener, transportStateListeners

Constructor Summary

Constructors

Constructor	Description
DummyTransport()
DummyTransport(A senderAddress)
DummyTransport(A senderAddress, A receiverAddress)

Method Summary

Modifier and Type	Method	Description
void	close()	Closes the transport an releases all bound resources synchronously.
A	getListenAddress()	Returns the address that represents the actual incoming address this transport mapping uses to listen for incoming packets.
WorkerTask	getListenWorkerTask()	Gets the WorkerTask that is responsible for receiving new messages.
AbstractTransportMapping<A>	getResponder(A receiverAddress)
Class<? extends Address>	getSupportedAddressClass()	Gets the primary Address class that is supported by this transport mapping.
boolean	isListening()	Returns true if the transport mapping is listening for incoming messages.
void	listen()	Listen for incoming messages.
void	sendMessage(A address, byte[] message, TransportStateReference tmStateReference, long timeoutMillis, int retries)	Sends a message to the supplied address using this transport.
void	setListenAddress(A listenAddress)
String	toString()

Methods inherited from class org.snmp4j.transport.AbstractTransportMapping

addTransportListener, addTransportStateListener, fireConnectionStateChanged, fireProcessMessage, getMaxInboundMessageSize, getPriority, getSocketCleaner, getSuspendedAddresses, getThreadName, handleDroppedMessageToSend, isAsyncMsgProcessingSupported, removeAllTransportListeners, removeTransportListener, removeTransportStateListener, resumeAddress, setAsyncMsgProcessingSupported, setPriority, setThreadName, suspendAddress

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.snmp4j.TransportMapping

getMaxOutboundMessageSize, getSupportedAddressClasses, getSupportedTransportType, isAddressSupported, isAddressSupported

Constructor Details

DummyTransport

public DummyTransport()

DummyTransport

public DummyTransport(A senderAddress)

DummyTransport

public DummyTransport(A senderAddress,
 A receiverAddress)

Method Details

getSupportedAddressClass

public Class<? extends Address> getSupportedAddressClass()

Description copied from interface: TransportMapping

Gets the primary Address class that is supported by this transport mapping.

Specified by:

getSupportedAddressClass in interface TransportMapping<A extends IpAddress>

Specified by:

getSupportedAddressClass in class AbstractTransportMapping<A extends IpAddress>

Returns:

a subclass of Address.

getListenAddress

public A getListenAddress()

Description copied from interface: TransportMapping

Returns the address that represents the actual incoming address this transport mapping uses to listen for incoming packets.

Specified by:

getListenAddress in interface TransportMapping<A extends IpAddress>

Specified by:

getListenAddress in class AbstractTransportMapping<A extends IpAddress>

Returns:

the address for incoming packets or null this transport mapping is not configured to listen for incoming packets.

setListenAddress

public void setListenAddress(A listenAddress)

sendMessage

public void sendMessage(A address,
 byte[] message,
 TransportStateReference tmStateReference,
 long timeoutMillis,
 int retries)
                 throws IOException

Description copied from class: AbstractTransportMapping

Sends a message to the supplied address using this transport. If the target address has been suspended, then instead actually sending the message on the wire, the method AbstractTransportMapping.handleDroppedMessageToSend(Address, byte[], TransportStateReference, long, int) will be called. To stop suspending of a target address, call AbstractTransportMapping.resumeAddress(Address) for that address.

Specified by:

sendMessage in interface TransportMapping<A extends IpAddress>

Specified by:

sendMessage in class AbstractTransportMapping<A extends IpAddress>

Parameters:

address - an Address instance denoting the target address.

message - the whole message as an array of bytes.

tmStateReference - the (optional) transport model state reference as defined by RFC 5590 section 6.1.

timeoutMillis - maximum number of milliseconds the connection creation might take (if connection based).

retries - maximum retries during connection creation.

Throws:

IOException - if any underlying IO operation fails.

close

public void close()
           throws IOException

Description copied from interface: TransportMapping

Closes the transport an releases all bound resources synchronously.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface TransportMapping<A extends IpAddress>

Specified by:

close in class AbstractTransportMapping<A extends IpAddress>

Throws:

IOException - if any IO operation for the close fails.

listen

public void listen()
            throws IOException

Description copied from interface: TransportMapping

Listen for incoming messages. For connection oriented transports, this method needs to be called before TransportMapping.sendMessage(A, byte[], org.snmp4j.TransportStateReference, long, int) is called for the first time.

Specified by:

listen in interface TransportMapping<A extends IpAddress>

Specified by:

listen in class AbstractTransportMapping<A extends IpAddress>

Throws:

IOException - if an IO operation exception occurs while starting the listener.

isListening

public boolean isListening()

Description copied from interface: TransportMapping

Returns true if the transport mapping is listening for incoming messages. For connection oriented transport mappings this is a prerequisite to be able to send SNMP messages. For connectionless transport mappings it is a prerequisite to be able to receive responses.

Specified by:

isListening in interface TransportMapping<A extends IpAddress>

Overrides:

isListening in class AbstractTransportMapping<A extends IpAddress>

Returns:

true if this transport mapping is listening for messages.

getResponder

public AbstractTransportMapping<A> getResponder(A receiverAddress)

toString

public String toString()

Overrides:

toString in class Object

getListenWorkerTask

public WorkerTask getListenWorkerTask()

Description copied from class: AbstractTransportMapping

Gets the WorkerTask that is responsible for receiving new messages.

Overrides:

getListenWorkerTask in class AbstractTransportMapping<A extends IpAddress>

Returns:

a WorkerTask instance which is most likely a DefaultThreadFactory.WorkerThread.