Apache Mina SSHD 2.15.0 · org.apache.sshd.client.session.ClientSession

Modifier and Type	Class and Description
public static enum	ClientSession.ClientSessionEvent

Modifier and Type	Field and Description
public static final Set<ClientChannelEvent>	REMOTE_COMMAND_WAIT_EVENTS

Method Summary

Modifier and Type	Method and Description
public AuthFuture	Returns: the authentication future auth() Starts the authentication process.
public ClientChannel	Returns: The created `ClientChannel` createChannel(String The channel type type) Create a channel of the given type.
public ClientChannel	Returns: The created `ClientChannel` createChannel(String The channel type type, String The channel sub-type subType) Create a channel of the given type and sub-type.
public ChannelDirectTcpip	Returns: The created `ChannelDirectTcpip` createDirectTcpipChannel(SshdSocketAddress The local address local, SshdSocketAddress The remote address remote) Create a direct tcp-ip channel which can be used to stream data to a remote port from the server.
public default DynamicPortForwardingTracker	Returns: The tracker instance createDynamicPortForwardingTracker(SshdSocketAddress The local address local) Starts a dynamic port forwarding and returns a tracker that stops the forwarding when the `close()` method is called.
public default ChannelExec	Returns: The created `ChannelExec` createExecChannel(String The command to execute command) Create a channel to execute a command using default PTY settings and environment.
public default ChannelExec	Returns: The created `ChannelExec` createExecChannel(String The command to execute command, PtyChannelConfigurationHolder The PTY configuration to use - if `null` then internal defaults are used ptyConfig, Map<String, ?> Extra environment configuration to be transmitted to the server - ignored if `null`/empty. env) Create a channel to execute a command using specific PTY settings and/or environment.
public ChannelExec	Returns: The created `ChannelExec` createExecChannel(String The command to execute command, Charset The `Charset` to use for sending the command string charset, PtyChannelConfigurationHolder The PTY configuration to use - if `null` then internal defaults are used ptyConfig, Map<String, ?> Extra environment configuration to be transmitted to the server - ignored if `null`/empty. env) Create a channel to execute a command using specific PTY settings and/or environment.
public ChannelExec	Returns: The created `ChannelExec` createExecChannel(byte[] The command to execute command, PtyChannelConfigurationHolder The PTY configuration to use - if `null` then internal defaults are used ptyConfig, Map<String, ?> Extra environment configuration to be transmitted to the server - ignored if `null`/empty. env) Create a channel to execute a command using specific PTY settings and/or environment.
public default ExplicitPortForwardingTracker	Returns: The tracker instance createLocalPortForwardingTracker(int The local port - if zero one is allocated localPort, SshdSocketAddress The remote address remote) Starts a local port forwarding and returns a tracker that stops the forwarding when the `close()` method is called.
public default ExplicitPortForwardingTracker	Returns: The tracker instance createLocalPortForwardingTracker(SshdSocketAddress The local address local, SshdSocketAddress The remote address remote) Starts a local port forwarding and returns a tracker that stops the forwarding when the `close()` method is called.
public default ExplicitPortForwardingTracker	Returns: The tracker instance createRemotePortForwardingTracker(SshdSocketAddress The remote address remote, SshdSocketAddress The local address local) Starts a remote port forwarding and returns a tracker that stops the forwarding when the `close()` method is called.
public default ChannelShell	Returns: The created `ChannelShell` createShellChannel() Create a channel to start a shell using default PTY settings and environment.
public ChannelShell	Returns: The created `ChannelShell` createShellChannel(PtyChannelConfigurationHolder The PTY configuration to use - if `null` then internal defaults are used ptyConfig, Map<String, ?> Extra environment configuration to be transmitted to the server - ignored if `null`/empty. env) Create a channel to start a shell using specific PTY settings and/or environment.
public ChannelSubsystem	Returns: The created `ChannelSubsystem` createSubsystemChannel(String The subsystem name subsystem) Create a subsystem channel.
public default String	Returns: The command's standard output result (assumed to be in US-ASCII) executeRemoteCommand(String The command to execute command) Execute a command that requires no input and returns its output
public default String	Returns: The command's standard output result executeRemoteCommand(String The command to execute - without a terminating LF command, OutputStream Standard error output stream - if `null` then error stream data is ignored Note if the stream is not `null` then it will be left open when this method returns or exception is thrown stderr, Charset The command `Charset` for input/output/error - if `null` then US_ASCII is assumed charset) Execute a command that requires no input and returns its output
public default void	executeRemoteCommand(String The command to execute - without a terminating LF command, OutputStream Standard output stream - if `null` then stream data is ignored Note if the stream is not `null` then it will be left open when this method returns or exception is thrown stdout, OutputStream Error output stream - if `null` then stream data is ignored Note if the stream is not `null` then it will be left open when this method returns or exception is thrown stderr, Charset The command `Charset` for output/error - if `null` then US_ASCII is assumed charset) Execute a command that requires no input and redirects its STDOUT/STDERR streams to the user-provided ones
public SocketAddress	Returns: The original requested address getConnectAddress() Returns the original address (after having been translated through host configuration entries if any) that was request to connect.
public AttributeRepository	Returns: The "context" data provided when session connection was established - `null` if none. getConnectionContext()
public ClientFactoryManager	Returns: The ClientFactoryManager for this session. getFactoryManager() Redeclares org.apache.sshd.common.FactoryManagerHolder.getFactoryManager.
public Map<Object, Object>	Returns: The metadata `Map` - Note: access to the map is not `synchronized` in any way - up to the user to take care of mutual exclusion if necessary getMetadataMap() Access to the metadata.
public PublicKey	Returns: The server's `PublicKey` - `null` if KEX not started or not completed getServerKey() Retrieves the server's key
public Set<ClientSession.ClientSessionEvent>	Returns: A snapshot of the current session state getSessionState()
public static Iterator<String>	Returns: The wrapping iterator passwordIteratorOf(ClientSession The `ClientSession` - ignored if `null` (i.e., empty iterator returned) session) Creates a "unified" `Iterator` of passwords out of the registered passwords and the extra available ones as a single iterator of passwords
public static KeyIdentityProvider	Returns: The wrapping KeyIdentityProvider providerOf(ClientSession The `ClientSession` - ignored if `null` (i.e., empty iterator returned) session) Creates a "unified" `KeyIdentityProvider` of key pairs out of the registered `KeyPair` identities and the extra available ones as a single iterator of key pairs
public KeyExchangeFuture	Returns: an `KeyExchangeFuture` that can be used to wait for the exchange to be finished switchToNoneCipher() Switch to a none cipher for performance.
public Set<ClientSession.ClientSessionEvent>	Returns: The actual state that was detected either due to the mask yielding one of the states or due to timeout (in which case the `ClientSessionEvent#TIMEOUT` value is set) waitFor(Collection<ClientSession.ClientSessionEvent> The request `ClientSessionEvent`s mask mask, long Wait time in milliseconds - non-positive means forever timeout) Wait for any one of a specific state to be signaled.
public default Set<ClientSession.ClientSessionEvent>	Returns: The actual state that was detected either due to the mask yielding one of the states or due to timeout (in which case the `ClientSessionEvent#TIMEOUT` value is set) waitFor(Collection<ClientSession.ClientSessionEvent> The request `ClientSessionEvent`s mask mask, Duration Wait time - null means forever timeout) Wait for any one of a specific state to be signaled.

Inherited from org.apache.sshd.client.ClientAuthenticationManager:: addPasswordIdentity addPublicKeyIdentity getHostBasedAuthenticationReporter getPasswordAuthenticationReporter getPasswordIdentityProvider getPublicKeyAuthenticationReporter getRegisteredIdentities getServerKeyVerifier getUserInteraction removePasswordIdentity removePublicKeyIdentity setHostBasedAuthenticationReporter setPasswordAuthenticationReporter setPasswordIdentityProvider setPublicKeyAuthenticationReporter setServerKeyVerifier setUserAuthFactoriesNames setUserInteraction
Inherited from org.apache.sshd.client.session.ClientProxyConnectorHolder:: getClientProxyConnector setClientProxyConnector
Inherited from org.apache.sshd.common.forward.PortForwardingManager:: startDynamicPortForwarding startLocalPortForwarding startLocalPortForwarding startRemotePortForwarding stopDynamicPortForwarding stopLocalPortForwarding stopRemotePortForwarding
Inherited from org.apache.sshd.common.session.Session:: createBuffer createBuffer disconnect exceptionCaught getAuthTimeout getAuthTimeoutStart getIdleTimeout getIdleTimeoutStart getIoSession getKex getLocalAddress getRemoteAddress getService getTimeoutStatus prepareBuffer reExchangeKeys request request request request resetAuthTimeout resetIdleTimeout resolveAttribute resolveAttribute sendDebugMessage sendIgnoreMessage setAuthenticated startService writePacket writePacket writePacket writePacket

REMOTE_COMMAND_WAIT_EVENTS	back to summary
public static final Set<ClientChannelEvent> REMOTE_COMMAND_WAIT_EVENTS

Method Detail

auth back to summary

auth	back to summary
public AuthFuture auth() throws IOException Starts the authentication process. User identities will be tried until the server successfully authenticate the user. User identities must be provided before calling this method using `addPasswordIdentity(String)` or `addPublicKeyIdentity(java.security.KeyPair)`. Returns:AuthFuture the authentication future Exceptions IOException: if failed to generate the future See Also `addPasswordIdentity(String)`, `addPublicKeyIdentity(java.security.KeyPair)`

public AuthFuture auth() throws IOException

Starts the authentication process. User identities will be tried until the server successfully authenticate the user. User identities must be provided before calling this method using addPasswordIdentity(String) or addPublicKeyIdentity(java.security.KeyPair).

Returns:AuthFuture

the authentication future

Exceptions

IOException:: if failed to generate the future

createChannel back to summary

createChannel	back to summary
public ClientChannel createChannel(String type) throws IOException Create a channel of the given type. Same as calling `createChannel(type, null)`. Parameters type:String The channel type Returns:ClientChannel The created `ClientChannel` Exceptions IOException: If failed to create the requested channel

public ClientChannel createChannel(String type) throws IOException

Create a channel of the given type. Same as calling createChannel(type, null).

Parameters

type:String: The channel type

Returns:ClientChannel

The created ClientChannel

Exceptions

IOException:: If failed to create the requested channel

createChannel back to summary

createChannel	back to summary
public ClientChannel createChannel(String type, String subType) throws IOException Create a channel of the given type and sub-type. Parameters type:String The channel type subType:String The channel sub-type Returns:ClientChannel The created `ClientChannel` Exceptions IOException: If failed to create the requested channel

public ClientChannel createChannel(String type, String subType) throws IOException

Create a channel of the given type and sub-type.

Parameters

type:String: The channel type
subType:String: The channel sub-type

Returns:ClientChannel

The created ClientChannel

Exceptions

IOException:: If failed to create the requested channel

createDirectTcpipChannel back to summary

createDirectTcpipChannel	back to summary
public ChannelDirectTcpip createDirectTcpipChannel(SshdSocketAddress local, SshdSocketAddress remote) throws IOException Create a direct tcp-ip channel which can be used to stream data to a remote port from the server. Parameters local:SshdSocketAddress The local address remote:SshdSocketAddress The remote address Returns:ChannelDirectTcpip The created `ChannelDirectTcpip` Exceptions IOException: If failed to create the requested channel

public ChannelDirectTcpip createDirectTcpipChannel(SshdSocketAddress local, SshdSocketAddress remote) throws IOException

Create a direct tcp-ip channel which can be used to stream data to a remote port from the server.

Parameters

local:SshdSocketAddress: The local address
remote:SshdSocketAddress: The remote address

Returns:ChannelDirectTcpip

The created ChannelDirectTcpip

Exceptions

IOException:: If failed to create the requested channel

createDynamicPortForwardingTracker back to summary

createDynamicPortForwardingTracker	back to summary
public default DynamicPortForwardingTracker createDynamicPortForwardingTracker(SshdSocketAddress local) throws IOException Starts a dynamic port forwarding and returns a tracker that stops the forwarding when the `close()` method is called. This tracker can be used in a `try-with-resource` block to ensure cleanup of the set up forwarding. Parameters local:SshdSocketAddress The local address Returns:DynamicPortForwardingTracker The tracker instance Exceptions IOException: If failed to set up the requested forwarding See Also `startDynamicPortForwarding(SshdSocketAddress)`

public default DynamicPortForwardingTracker createDynamicPortForwardingTracker(SshdSocketAddress local) throws IOException

Starts a dynamic port forwarding and returns a tracker that stops the forwarding when the close() method is called. This tracker can be used in a try-with-resource block to ensure cleanup of the set up forwarding.

Parameters

local:SshdSocketAddress: The local address

Returns:DynamicPortForwardingTracker

The tracker instance

Exceptions

IOException:: If failed to set up the requested forwarding

createExecChannel back to summary

createExecChannel	back to summary
public default ChannelExec createExecChannel(String command) throws IOException Create a channel to execute a command using default PTY settings and environment. Parameters command:String The command to execute Returns:ChannelExec The created `ChannelExec` Exceptions IOException: If failed to create the requested channel

public default ChannelExec createExecChannel(String command) throws IOException

Create a channel to execute a command using default PTY settings and environment.

Parameters

command:String: The command to execute

Returns:ChannelExec

The created ChannelExec

Exceptions

IOException:: If failed to create the requested channel

createExecChannel back to summary

createExecChannel	back to summary
public default ChannelExec createExecChannel(String command, PtyChannelConfigurationHolder ptyConfig, Map<String, ?> env) throws IOException Create a channel to execute a command using specific PTY settings and/or environment. Parameters command:String The command to execute ptyConfig:PtyChannelConfigurationHolder The PTY configuration to use - if `null` then internal defaults are used env:Map<String, ?> Extra environment configuration to be transmitted to the server - ignored if `null`/empty. Returns:ChannelExec The created `ChannelExec` Exceptions IOException: If failed to create the requested channel

public default ChannelExec createExecChannel(String command, PtyChannelConfigurationHolder ptyConfig, Map<String, ?> env) throws IOException

Create a channel to execute a command using specific PTY settings and/or environment.

Parameters

command:String: The command to execute
ptyConfig:PtyChannelConfigurationHolder: The PTY configuration to use - if null then internal defaults are used
env:Map<String, ?>: Extra environment configuration to be transmitted to the server - ignored if null/empty.

Returns:ChannelExec

The created ChannelExec

Exceptions

IOException:: If failed to create the requested channel

createExecChannel back to summary

createExecChannel	back to summary
public ChannelExec createExecChannel(String command, Charset charset, PtyChannelConfigurationHolder ptyConfig, Map<String, ?> env) throws IOException Create a channel to execute a command using specific PTY settings and/or environment. Parameters command:String The command to execute charset:Charset The `Charset` to use for sending the command string ptyConfig:PtyChannelConfigurationHolder The PTY configuration to use - if `null` then internal defaults are used env:Map<String, ?> Extra environment configuration to be transmitted to the server - ignored if `null`/empty. Returns:ChannelExec The created `ChannelExec` Exceptions IOException: If failed to create the requested channel

public ChannelExec createExecChannel(String command, Charset charset, PtyChannelConfigurationHolder ptyConfig, Map<String, ?> env) throws IOException

Create a channel to execute a command using specific PTY settings and/or environment.

Parameters

command:String: The command to execute
charset:Charset: The Charset to use for sending the command string
ptyConfig:PtyChannelConfigurationHolder: The PTY configuration to use - if null then internal defaults are used
env:Map<String, ?>: Extra environment configuration to be transmitted to the server - ignored if null/empty.

Returns:ChannelExec

The created ChannelExec

Exceptions

IOException:: If failed to create the requested channel

createExecChannel back to summary

createExecChannel	back to summary
public ChannelExec createExecChannel(byte[] command, PtyChannelConfigurationHolder ptyConfig, Map<String, ?> env) throws IOException Create a channel to execute a command using specific PTY settings and/or environment. Parameters command:byte[] The command to execute ptyConfig:PtyChannelConfigurationHolder The PTY configuration to use - if `null` then internal defaults are used env:Map<String, ?> Extra environment configuration to be transmitted to the server - ignored if `null`/empty. Returns:ChannelExec The created `ChannelExec` Exceptions IOException: If failed to create the requested channel

public ChannelExec createExecChannel(byte[] command, PtyChannelConfigurationHolder ptyConfig, Map<String, ?> env) throws IOException

Create a channel to execute a command using specific PTY settings and/or environment.

Parameters

command:byte[]: The command to execute
ptyConfig:PtyChannelConfigurationHolder: The PTY configuration to use - if null then internal defaults are used
env:Map<String, ?>: Extra environment configuration to be transmitted to the server - ignored if null/empty.

Returns:ChannelExec

The created ChannelExec

Exceptions

IOException:: If failed to create the requested channel

createLocalPortForwardingTracker back to summary

createLocalPortForwardingTracker	back to summary
public default ExplicitPortForwardingTracker createLocalPortForwardingTracker(int localPort, SshdSocketAddress remote) throws IOException Starts a local port forwarding and returns a tracker that stops the forwarding when the `close()` method is called. This tracker can be used in a `try-with-resource` block to ensure cleanup of the set up forwarding. Parameters localPort:int The local port - if zero one is allocated remote:SshdSocketAddress The remote address Returns:ExplicitPortForwardingTracker The tracker instance Exceptions IOException: If failed to set up the requested forwarding See Also `startLocalPortForwarding(SshdSocketAddress, SshdSocketAddress)`

public default ExplicitPortForwardingTracker createLocalPortForwardingTracker(int localPort, SshdSocketAddress remote) throws IOException

Starts a local port forwarding and returns a tracker that stops the forwarding when the close() method is called. This tracker can be used in a try-with-resource block to ensure cleanup of the set up forwarding.

Parameters

localPort:int: The local port - if zero one is allocated
remote:SshdSocketAddress: The remote address

Returns:ExplicitPortForwardingTracker

The tracker instance

Exceptions

IOException:: If failed to set up the requested forwarding

createLocalPortForwardingTracker back to summary

createLocalPortForwardingTracker	back to summary
public default ExplicitPortForwardingTracker createLocalPortForwardingTracker(SshdSocketAddress local, SshdSocketAddress remote) throws IOException Starts a local port forwarding and returns a tracker that stops the forwarding when the `close()` method is called. This tracker can be used in a `try-with-resource` block to ensure cleanup of the set up forwarding. Parameters local:SshdSocketAddress The local address remote:SshdSocketAddress The remote address Returns:ExplicitPortForwardingTracker The tracker instance Exceptions IOException: If failed to set up the requested forwarding See Also `startLocalPortForwarding(SshdSocketAddress, SshdSocketAddress)`

public default ExplicitPortForwardingTracker createLocalPortForwardingTracker(SshdSocketAddress local, SshdSocketAddress remote) throws IOException

Parameters

local:SshdSocketAddress: The local address
remote:SshdSocketAddress: The remote address

Returns:ExplicitPortForwardingTracker

The tracker instance

Exceptions

IOException:: If failed to set up the requested forwarding

createRemotePortForwardingTracker back to summary

createRemotePortForwardingTracker	back to summary
public default ExplicitPortForwardingTracker createRemotePortForwardingTracker(SshdSocketAddress remote, SshdSocketAddress local) throws IOException Starts a remote port forwarding and returns a tracker that stops the forwarding when the `close()` method is called. This tracker can be used in a `try-with-resource` block to ensure cleanup of the set up forwarding. Parameters remote:SshdSocketAddress The remote address local:SshdSocketAddress The local address Returns:ExplicitPortForwardingTracker The tracker instance Exceptions IOException: If failed to set up the requested forwarding See Also `startRemotePortForwarding(SshdSocketAddress, SshdSocketAddress)`

public default ExplicitPortForwardingTracker createRemotePortForwardingTracker(SshdSocketAddress remote, SshdSocketAddress local) throws IOException

Starts a remote port forwarding and returns a tracker that stops the forwarding when the close() method is called. This tracker can be used in a try-with-resource block to ensure cleanup of the set up forwarding.

Parameters

remote:SshdSocketAddress: The remote address
local:SshdSocketAddress: The local address

Returns:ExplicitPortForwardingTracker

The tracker instance

Exceptions

IOException:: If failed to set up the requested forwarding

createShellChannel back to summary

createShellChannel	back to summary
public default ChannelShell createShellChannel() throws IOException Create a channel to start a shell using default PTY settings and environment. Returns:ChannelShell The created `ChannelShell` Exceptions IOException: If failed to create the requested channel

public default ChannelShell createShellChannel() throws IOException

Create a channel to start a shell using default PTY settings and environment.

Returns:ChannelShell

The created ChannelShell

Exceptions

IOException:: If failed to create the requested channel

createShellChannel back to summary

createShellChannel	back to summary
public ChannelShell createShellChannel(PtyChannelConfigurationHolder ptyConfig, Map<String, ?> env) throws IOException Create a channel to start a shell using specific PTY settings and/or environment. Parameters ptyConfig:PtyChannelConfigurationHolder The PTY configuration to use - if `null` then internal defaults are used env:Map<String, ?> Extra environment configuration to be transmitted to the server - ignored if `null`/empty. Returns:ChannelShell The created `ChannelShell` Exceptions IOException: If failed to create the requested channel

public ChannelShell createShellChannel(PtyChannelConfigurationHolder ptyConfig, Map<String, ?> env) throws IOException

Create a channel to start a shell using specific PTY settings and/or environment.

Parameters

ptyConfig:PtyChannelConfigurationHolder: The PTY configuration to use - if null then internal defaults are used
env:Map<String, ?>: Extra environment configuration to be transmitted to the server - ignored if null/empty.

Returns:ChannelShell

The created ChannelShell

Exceptions

IOException:: If failed to create the requested channel

createSubsystemChannel back to summary

createSubsystemChannel	back to summary
public ChannelSubsystem createSubsystemChannel(String subsystem) throws IOException Create a subsystem channel. Parameters subsystem:String The subsystem name Returns:ChannelSubsystem The created `ChannelSubsystem` Exceptions IOException: If failed to create the requested channel

public ChannelSubsystem createSubsystemChannel(String subsystem) throws IOException

Create a subsystem channel.

Parameters

subsystem:String: The subsystem name

Returns:ChannelSubsystem

The created ChannelSubsystem

Exceptions

IOException:: If failed to create the requested channel

executeRemoteCommand back to summary

executeRemoteCommand	back to summary
public default String executeRemoteCommand(String command) throws IOException Execute a command that requires no input and returns its output Parameters command:String The command to execute Returns:String The command's standard output result (assumed to be in US-ASCII) Exceptions IOException: If failed to execute the command - including if anything was written to the standard error or a non-zero exit status was received. If this happens, then a `RemoteException` is thrown with a cause of `ServerException` containing the remote captured standard error - including CR/LF(s) See Also `executeRemoteCommand(String, OutputStream, Charset)`

public default String executeRemoteCommand(String command) throws IOException

Execute a command that requires no input and returns its output

Parameters

command:String: The command to execute

Returns:String

The command's standard output result (assumed to be in US-ASCII)

Exceptions

IOException:: If failed to execute the command - including if anything was written to the standard error or a non-zero exit status was received. If this happens, then a RemoteException is thrown with a cause of ServerException containing the remote captured standard error - including CR/LF(s)

executeRemoteCommand back to summary

executeRemoteCommand	back to summary
public default String executeRemoteCommand(String command, OutputStream stderr, Charset charset) throws IOException Execute a command that requires no input and returns its output Parameters command:String The command to execute - without a terminating LF stderr:OutputStream Standard error output stream - if `null` then error stream data is ignored Note if the stream is not `null` then it will be left open when this method returns or exception is thrown charset:Charset The command `Charset` for input/output/error - if `null` then US_ASCII is assumed Returns:String The command's standard output result Exceptions IOException: If failed to manage the command channel - Note: the code does not check if anything was output to the standard error stream, but does check the reported exit status (if any) for non-zero value. If non-zero exit status received then a `RemoteException` is thrown with' a `ServerException` cause containing the exits value See Also `executeRemoteCommand(String, OutputStream, OutputStream, Charset)`

public default String executeRemoteCommand(String command, OutputStream stderr, Charset charset) throws IOException

Execute a command that requires no input and returns its output

Parameters

command:String: The command to execute - without a terminating LF
stderr:OutputStream: Standard error output stream - if null then error stream data is ignored
Note
if the stream is not null then it will be left open when this method returns or exception is thrown
charset:Charset: The command Charset for input/output/error - if null then US_ASCII is assumed

Returns:String

The command's standard output result

Exceptions

IOException:: If failed to manage the command channel - Note: the code does not check if anything was output to the standard error stream, but does check the reported exit status (if any) for non-zero value. If non-zero exit status received then a RemoteException is thrown with' a ServerException cause containing the exits value

executeRemoteCommand back to summary

executeRemoteCommand	back to summary
public default void executeRemoteCommand(String command, OutputStream stdout, OutputStream stderr, Charset charset) throws IOException Execute a command that requires no input and redirects its STDOUT/STDERR streams to the user-provided ones Parameters command:String The command to execute - without a terminating LF stdout:OutputStream Standard output stream - if `null` then stream data is ignored Note if the stream is not `null` then it will be left open when this method returns or exception is thrown stderr:OutputStream Error output stream - if `null` then stream data is ignored Note if the stream is not `null` then it will be left open when this method returns or exception is thrown charset:Charset The command `Charset` for output/error - if `null` then US_ASCII is assumed Exceptions IOException: If failed to execute the command or got a non-zero exit status See Also `validateCommandExitStatusCode`

public default void executeRemoteCommand(String command, OutputStream stdout, OutputStream stderr, Charset charset) throws IOException

Execute a command that requires no input and redirects its STDOUT/STDERR streams to the user-provided ones

Parameters

command:String: The command to execute - without a terminating LF
stdout:OutputStream: Standard output stream - if null then stream data is ignored
Note
if the stream is not null then it will be left open when this method returns or exception is thrown
stderr:OutputStream: Error output stream - if null then stream data is ignored
Note
if the stream is not null then it will be left open when this method returns or exception is thrown
charset:Charset: The command Charset for output/error - if null then US_ASCII is assumed

Exceptions

IOException:: If failed to execute the command or got a non-zero exit status

See Also

validateCommandExitStatusCode

getConnectAddress back to summary

getConnectAddress	back to summary
public SocketAddress getConnectAddress() Returns the original address (after having been translated through host configuration entries if any) that was request to connect. It contains the original host or address string that was used Note this may be different than the result of the `getIoSession()` report of the remote peer Returns:SocketAddress The original requested address

public SocketAddress getConnectAddress()

Returns the original address (after having been translated through host configuration entries if any) that was request to connect. It contains the original host or address string that was used

Note

this may be different than the result of the getIoSession() report of the remote peer

Returns:SocketAddress: The original requested address

getConnectionContext	back to summary
public AttributeRepository getConnectionContext() Returns:AttributeRepository The "context" data provided when session connection was established - `null` if none.

getFactoryManager	back to summary
public ClientFactoryManager getFactoryManager() Redeclares org.apache.sshd.common.FactoryManagerHolder.getFactoryManager. Returns:ClientFactoryManager The ClientFactoryManager for this session. Annotations @Override

getFactoryManager

back to summary

public ClientFactoryManager getFactoryManager()

Redeclares org.apache.sshd.common.FactoryManagerHolder.getFactoryManager.

Returns:ClientFactoryManager

The ClientFactoryManager for this session.

Annotations

@Override

getMetadataMap back to summary

public Map<Object, Object> getMetadataMap()

Access to the metadata.

Returns:Map<Object, Object>: The metadata Map - Note: access to the map is not synchronized in any way - up to the user to take care of mutual exclusion if necessary

getServerKey back to summary

getServerKey	back to summary
public PublicKey getServerKey() Retrieves the server's key Returns:PublicKey The server's `PublicKey` - `null` if KEX not started or not completed

public PublicKey getServerKey()

Retrieves the server's key

Returns:PublicKey: The server's PublicKey - null if KEX not started or not completed

getSessionState	back to summary
public Set<ClientSession.ClientSessionEvent> getSessionState() Returns:Set<ClientSession.ClientSessionEvent> A snapshot of the current session state See Also `waitFor(Collection, long)`

passwordIteratorOf back to summary

passwordIteratorOf	back to summary
public static Iterator<String> passwordIteratorOf(ClientSession session) throws IOException, GeneralSecurityException Creates a "unified" `Iterator` of passwords out of the registered passwords and the extra available ones as a single iterator of passwords Parameters session:ClientSession The `ClientSession` - ignored if `null` (i.e., empty iterator returned) Returns:Iterator<String> The wrapping iterator Exceptions IOException: If failed to load the passwords GeneralSecurityException: If some security issue with the passwords See Also `ClientSession#getRegisteredIdentities()`, `ClientSession#getPasswordIdentityProvider()`

public static Iterator<String> passwordIteratorOf(ClientSession session) throws IOException, GeneralSecurityException

Creates a "unified" Iterator of passwords out of the registered passwords and the extra available ones as a single iterator of passwords

Parameters

session:ClientSession: The ClientSession - ignored if null (i.e., empty iterator returned)

Returns:Iterator<String>

The wrapping iterator

Exceptions

IOException:: If failed to load the passwords
GeneralSecurityException:: If some security issue with the passwords

providerOf back to summary

providerOf	back to summary
public static KeyIdentityProvider providerOf(ClientSession session) Creates a "unified" `KeyIdentityProvider` of key pairs out of the registered `KeyPair` identities and the extra available ones as a single iterator of key pairs Parameters session:ClientSession The `ClientSession` - ignored if `null` (i.e., empty iterator returned) Returns:KeyIdentityProvider The wrapping KeyIdentityProvider See Also `ClientSession#getRegisteredIdentities()`, `ClientSession#getKeyIdentityProvider()`

public static KeyIdentityProvider providerOf(ClientSession session)

Creates a "unified" KeyIdentityProvider of key pairs out of the registered KeyPair identities and the extra available ones as a single iterator of key pairs

Parameters

session:ClientSession: The ClientSession - ignored if null (i.e., empty iterator returned)

Returns:KeyIdentityProvider

The wrapping KeyIdentityProvider

switchToNoneCipher back to summary

switchToNoneCipher	back to summary
public KeyExchangeFuture switchToNoneCipher() throws IOException Switch to a none cipher for performance. This should be done after the authentication phase has been performed. After such a switch, interactive channels are not allowed anymore. Both client and server must have been configured to support the none cipher. If that's not the case, the returned future will be set with an exception. Returns:KeyExchangeFuture an `KeyExchangeFuture` that can be used to wait for the exchange to be finished Exceptions IOException: if a key exchange is already running

public KeyExchangeFuture switchToNoneCipher() throws IOException

Switch to a none cipher for performance. This should be done after the authentication phase has been performed. After such a switch, interactive channels are not allowed anymore. Both client and server must have been configured to support the none cipher. If that's not the case, the returned future will be set with an exception.

Returns:KeyExchangeFuture

an KeyExchangeFuture that can be used to wait for the exchange to be finished

Exceptions

IOException:: if a key exchange is already running

waitFor back to summary

waitFor	back to summary
public Set<ClientSession.ClientSessionEvent> waitFor(Collection<ClientSession.ClientSessionEvent> mask, long timeout) Wait for any one of a specific state to be signaled. Parameters mask:Collection<ClientSession.ClientSessionEvent> The request `ClientSessionEvent`s mask timeout:long Wait time in milliseconds - non-positive means forever Returns:Set<ClientSession.ClientSessionEvent> The actual state that was detected either due to the mask yielding one of the states or due to timeout (in which case the `ClientSessionEvent#TIMEOUT` value is set)

public Set<ClientSession.ClientSessionEvent> waitFor(Collection<ClientSession.ClientSessionEvent> mask, long timeout)

Wait for any one of a specific state to be signaled.

Parameters

mask:Collection<ClientSession.ClientSessionEvent>: The request ClientSessionEvents mask
timeout:long: Wait time in milliseconds - non-positive means forever

Returns:Set<ClientSession.ClientSessionEvent>

The actual state that was detected either due to the mask yielding one of the states or due to timeout (in which case the ClientSessionEvent#TIMEOUT value is set)

waitFor back to summary

waitFor	back to summary
public default Set<ClientSession.ClientSessionEvent> waitFor(Collection<ClientSession.ClientSessionEvent> mask, Duration timeout) Wait for any one of a specific state to be signaled. Parameters mask:Collection<ClientSession.ClientSessionEvent> The request `ClientSessionEvent`s mask timeout:Duration Wait time - null means forever Returns:Set<ClientSession.ClientSessionEvent> The actual state that was detected either due to the mask yielding one of the states or due to timeout (in which case the `ClientSessionEvent#TIMEOUT` value is set)

public default Set<ClientSession.ClientSessionEvent> waitFor(Collection<ClientSession.ClientSessionEvent> mask, Duration timeout)

Wait for any one of a specific state to be signaled.

Parameters

mask:Collection<ClientSession.ClientSessionEvent>: The request ClientSessionEvents mask
timeout:Duration: Wait time - null means forever

Returns:Set<ClientSession.ClientSessionEvent>

The actual state that was detected either due to the mask yielding one of the states or due to timeout (in which case the ClientSessionEvent#TIMEOUT value is set)

Modifier and Type	Field and Description
public static final ClientSession.ClientSessionEvent	AUTHED
public static final ClientSession.ClientSessionEvent	CLOSED
public static final ClientSession.ClientSessionEvent	TIMEOUT
public static final ClientSession.ClientSessionEvent	WAIT_AUTH

Modifier and Type	Method and Description
public static ClientSession.ClientSessionEvent	valueOf(String name)
public static ClientSession.ClientSessionEvent[]	values()

public Interface ClientSession

Nested and Inner Type Summary

Field Summary

Method Summary

Field Detail

Method Detail

public final Enum ClientSession.ClientSessionEvent

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail