Package org.snmp4j.transport
Class DefaultSshTransportMapping
java.lang.Object
org.snmp4j.transport.AbstractTransportMapping<SshAddress>
org.snmp4j.transport.DefaultSshTransportMapping
- All Implemented Interfaces:
TransportMapping<SshAddress>
The
DefaultSshTransportMapping
implements a TCP transport
mapping with TLS according to RFC 5592 (named SSHTM therein).- Since:
- 2.0
- Version:
- 2.0
- Author:
- Frank Fock
-
Nested Class Summary
-
Field Summary
Fields inherited from class org.snmp4j.transport.AbstractTransportMapping
asyncMsgProcessingSupported, maxInboundMessageSize, maxOutboundMessageSize, transportListener
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
close()
Closes the transport an releases all bound resources synchronously.protected void
Returns the address that represents the actual incoming address this transport mapping uses to listen for incoming packets.Gets theAddress
class that is supported by this transport mapping.boolean
Returnstrue
if the transport mapping is listening for incoming messages.void
listen()
Listen for incoming messages.protected SshSession
openSession
(SshAddress address, TransportStateReference tmStateReference, int maxMessageSize) void
sendMessage
(SshAddress address, byte[] message, TransportStateReference tmStateReference) Sends a message to the supplied address using this transport.Methods inherited from class org.snmp4j.transport.AbstractTransportMapping
addTransportListener, fireProcessMessage, getMaxInboundMessageSize, getMaxOutboundMessageSize, isAsyncMsgProcessingSupported, removeAllTransportListeners, removeTransportListener, setAsyncMsgProcessingSupported
-
Constructor Details
-
DefaultSshTransportMapping
-
-
Method Details
-
getSupportedAddressClass
Description copied from interface:TransportMapping
Gets theAddress
class that is supported by this transport mapping.- Specified by:
getSupportedAddressClass
in interfaceTransportMapping<SshAddress>
- Specified by:
getSupportedAddressClass
in classAbstractTransportMapping<SshAddress>
- Returns:
- a subclass of
Address
.
-
getListenAddress
Description copied from interface:TransportMapping
Returns the address that represents the actual incoming address this transport mapping uses to listen for incoming packets.- Returns:
- the address for incoming packets or
null
this transport mapping is not configured to listen for incoming packets.
-
sendMessage
public void sendMessage(SshAddress address, byte[] message, TransportStateReference tmStateReference) throws IOException Description copied from interface:TransportMapping
Sends a message to the supplied address using this transport.- Specified by:
sendMessage
in interfaceTransportMapping<SshAddress>
- Specified by:
sendMessage
in classAbstractTransportMapping<SshAddress>
- Parameters:
address
- anAddress
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.- Throws:
IOException
- if any underlying IO operation fails.
-
openSession
protected SshSession openSession(SshAddress address, TransportStateReference tmStateReference, int maxMessageSize) -
close
Description copied from interface:TransportMapping
Closes the transport an releases all bound resources synchronously.- Specified by:
close
in interfaceTransportMapping<SshAddress>
- Specified by:
close
in classAbstractTransportMapping<SshAddress>
- Throws:
IOException
- if any IO operation for the close fails.
-
listen
Description copied from interface:TransportMapping
Listen for incoming messages. For connection oriented transports, this method needs to be called beforeTransportMapping.sendMessage(A, byte[], org.snmp4j.TransportStateReference)
is called for the first time.- Specified by:
listen
in interfaceTransportMapping<SshAddress>
- Specified by:
listen
in classAbstractTransportMapping<SshAddress>
- Throws:
IOException
- if an IO operation exception occurs while starting the listener.
-
isListening
public boolean isListening()Description copied from interface:TransportMapping
Returnstrue
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.- Returns:
true
if this transport mapping is listening for messages.
-
fireIncrementCounter
-