ClientSession (Apache Mina SSHD 0.8.0 API)

All Known Implementing Classes:

ClientSessionImpl
```
public interface ClientSession
```
An authenticated session to a given SSH server A client session is established using the SshClient. Once the session has been created, the user has to authenticate using either authPassword(String, String) or authPublicKey(String, java.security.KeyPair). From this session, channels can be created using the createChannel(String) method. Multiple channels can be created on a given session concurrently. When using the client in an interactive mode, the waitFor(int, long) method can be used to listen to specific events such as the session being established, authenticated or closed. When a given session is no longer used, it must be closed using the close(boolean) method.

Author:

Apache MINA SSHD Project

Field Summary

Fields
Modifier and Type Field and Description

static int AUTHED

static int CLOSED

static int TIMEOUT

static int WAIT_AUTH

Fields
Modifier and Type	Field and Description
`static int`	`AUTHED`
`static int`	`CLOSED`
`static int`	`TIMEOUT`
`static int`	`WAIT_AUTH`

Method Summary

Methods
Modifier and Type	Method and Description
`AuthFuture`	`authAgent(String username)` Authenticate the session with the given username using an ssh agent.
`AuthFuture`	`authPassword(String username, String password)` Authenticate the session with the given username and password.
`AuthFuture`	`authPublicKey(String username, KeyPair key)` Authenticate the session with the gien username and public key.
`CloseFuture`	`close(boolean immediately)` Close this session.
`ClientChannel`	`createChannel(String type)` Create a channel of the given type.
`ClientChannel`	`createChannel(String type, String subType)` Create a channel of the given type and subtype.
`ChannelDirectTcpip`	`createDirectTcpipChannel(SshdSocketAddress local, SshdSocketAddress remote)` Create a direct tcp-ip channel which can be used to stream data to a remote port from the server.
`ChannelExec`	`createExecChannel(String command)` Create a channel to execute a command.
`ChannelShell`	`createShellChannel()` Create a channel to start a shell.
`ChannelSubsystem`	`createSubsystemChannel(String subsystem)` Create a subsystem channel.
`Map<Object,Object>`	`getMetadataMap()` Access to the metadata.
`void`	`startLocalPortForwarding(SshdSocketAddress local, SshdSocketAddress remote)` Start forwarding the given local address on the client to the given address on the server.
`void`	`startRemotePortForwarding(SshdSocketAddress remote, SshdSocketAddress local)` Start forwarding tcpip from the given address on the server to the given address on the client.
`void`	`stopLocalPortForwarding(SshdSocketAddress local)` Stop forwarding the given local address.
`void`	`stopRemotePortForwarding(SshdSocketAddress remote)` Stop forwarding of the given remote address.
`int`	`waitFor(int mask, long timeout)` Wait for a specific state.

- Field Detail
  - TIMEOUT
```
static final int TIMEOUT
```
    See Also:
    Constant Field Values
  - CLOSED
```
static final int CLOSED
```
    See Also:
    Constant Field Values
  - WAIT_AUTH
```
static final int WAIT_AUTH
```
    See Also:
    Constant Field Values
  - AUTHED
```
static final int AUTHED
```
    See Also:
    Constant Field Values
- Method Detail
  - authAgent
```
AuthFuture authAgent(String username)
                     throws IOException
```
    Authenticate the session with the given username using an ssh agent.
    
    Throws:
    
    IOException
  - authPassword
```
AuthFuture authPassword(String username,
                      String password)
                        throws IOException
```
    Authenticate the session with the given username and password.
    
    Throws:
    
    IOException
  - authPublicKey
```
AuthFuture authPublicKey(String username,
                       KeyPair key)
                         throws IOException
```
    Authenticate the session with the gien username and public key.
    
    Throws:
    
    IOException
  - createChannel
```
ClientChannel createChannel(String type)
                            throws Exception
```
    Create a channel of the given type. Same as calling createChannel(type, null).
    
    Throws:
    
    Exception
  - createChannel
```
ClientChannel createChannel(String type,
                          String subType)
                            throws Exception
```
    Create a channel of the given type and subtype.
    
    Throws:
    
    Exception
  - createShellChannel
```
ChannelShell createShellChannel()
                                throws Exception
```
    Create a channel to start a shell.
    
    Throws:
    
    Exception
  - createExecChannel
```
ChannelExec createExecChannel(String command)
                              throws Exception
```
    Create a channel to execute a command.
    
    Throws:
    
    Exception
  - createSubsystemChannel
```
ChannelSubsystem createSubsystemChannel(String subsystem)
                                        throws Exception
```
    Create a subsystem channel.
    
    Throws:
    
    Exception
  - createDirectTcpipChannel
```
ChannelDirectTcpip createDirectTcpipChannel(SshdSocketAddress local,
                                          SshdSocketAddress remote)
                                            throws Exception
```
    Create a direct tcp-ip channel which can be used to stream data to a remote port from the server.
    
    Throws:
    
    Exception
  - startLocalPortForwarding
```
void startLocalPortForwarding(SshdSocketAddress local,
                            SshdSocketAddress remote)
                              throws Exception
```
    Start forwarding the given local address on the client to the given address on the server.
    
    Throws:
    
    Exception
  - stopLocalPortForwarding
```
void stopLocalPortForwarding(SshdSocketAddress local)
                             throws Exception
```
    Stop forwarding the given local address.
    
    Throws:
    
    Exception
  - startRemotePortForwarding
```
void startRemotePortForwarding(SshdSocketAddress remote,
                             SshdSocketAddress local)
                               throws Exception
```
    Start forwarding tcpip from the given address on the server to the given address on the client. The remote host name is the address to bind to on the server:
    - "" means that connections are to be accepted on all protocol families supported by the SSH implementation
    - "0.0.0.0" means to listen on all IPv4 addresses
    - "::" means to listen on all IPv6 addresses
    - "localhost" means to listen on all protocol families supported by the SSH implementation on loopback addresses only, [RFC3330] and RFC3513]
    - "127.0.0.1" and "::1" indicate listening on the loopback interfaces for IPv4 and IPv6 respectively
    Throws:
    
    Exception
  - stopRemotePortForwarding
```
void stopRemotePortForwarding(SshdSocketAddress remote)
                              throws Exception
```
    Stop forwarding of the given remote address.
    
    Throws:
    
    Exception
  - waitFor
```
int waitFor(int mask,
          long timeout)
```
    Wait for a specific state.
  - close
```
CloseFuture close(boolean immediately)
```
    Close this session.
  - getMetadataMap
```
Map<Object,Object> getMetadataMap()
```
    Access to the metadata.

Interface ClientSession

Field Summary

Method Summary

Field Detail

TIMEOUT

CLOSED

WAIT_AUTH

AUTHED

Method Detail

authAgent

authPassword

authPublicKey

createChannel

createChannel

createShellChannel

createExecChannel

createSubsystemChannel

createDirectTcpipChannel

startLocalPortForwarding

stopLocalPortForwarding

startRemotePortForwarding

stopRemotePortForwarding

waitFor

close

getMetadataMap