Capability (SSHAPI Group 1.1.2 API)

java.lang.Object
- net.sf.sshapi.Capability

```
public class Capability
extends java.lang.Object
```
Represents a feature that a provider implementation is capable of. Clients may use this to make more informed choices about which provider to choose. For example, an application may absolutely require SSH1 support. It may examine the capabilities of each provider and stop execution if no provider that supports SSH1 is available.

See Also:

SshProvider.getCapabilities()

Field Summary

Fields
Modifier and Type	Field and Description
`static Capability`	`AGENT` The provider supports a agent for key authentication.
`static Capability`	`CHANNEL_DATA_EVENTS` The provider reports on channel data events.
`static Capability`	`CHANNEL_HANDLERS` The provider supports channel handlers.
`static Capability`	`DATA_TIMEOUTS` Allows setting of timeouts on the connection.
`static Capability`	`FILE_TRANSFER_EVENTS` The provider will fire events when file transfers start, progress, and finished.
`static Capability`	`GSSAPI_AUTHENTICATION` The provider supports GSSAPI authentication.
`static Capability`	`HOST_KEY_MANAGEMENT` The provider supports host key management.
`static Capability`	`HTTP_PROXY` The provider supports HTTP proxy connections.
`static Capability`	`IDENTITY_MANAGEMENT` The provider supports identity management.
`static Capability`	`KEYBOARD_INTERACTIVE_AUTHENTICATION` The provider supports keyboard interactive authentication.
`static Capability`	`OPENSSH_AGENT` The provider supports an SSH agent for key authentication.
`static Capability`	`PASSWORD_AUTHENTICATION` The provider supports password authentication.
`static Capability`	`PER_CONNECTION_CONFIGURATION` The provider fully supports per-connection configuration.
`static Capability`	`PORT_FORWARD_EVENTS` The provider supports port forwarding events.
`static Capability`	`PUBLIC_KEY_AUTHENTICATION` The provider supports public key authentication.
`static Capability`	`PUBLIC_KEY_SUBSYSTEM` The provider supports the public key subsystem.
`static Capability`	`RFC_AGENT` The provider supports an RFC agent for key authentication.
`static Capability`	`SCP` The provider supports SCP.
`static Capability`	`SFTP` The provider supports SFTP.
`static Capability`	`SFTP_OVER_SCP` The provider can fall-back to using SCP if SFTP is not available.
`static Capability`	`SOCKET_FACTORY` The provider supports use of a `SocketFactory` to create connections.
`static Capability`	`SOCKS4_PROXY` The provider supports SOCKS4 proxy connections.
`static Capability`	`SOCKS5_PROXY` The provider supports SOCKS5 proxy connections.
`static Capability`	`SSH1` The provider fully supports SSH1.
`static Capability`	`SSH2` The provider fully supports SSH2.
`static Capability`	`TUNNELED_SOCKET_FACTORY` The provider can create a socket factory that is tunneled to a remote host over SSH.
`static Capability`	`WINDOW_CHANGE` The provider supports changing of terminal window size `SshShell.requestPseudoTerminalChange(int, int, int, int)`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method and Description

java.lang.String getName()
Get the capability name

java.lang.String toString()
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getName()` Get the capability name
`java.lang.String`	`toString()`

- Field Detail
  - PER_CONNECTION_CONFIGURATION
```
public static final Capability PER_CONNECTION_CONFIGURATION
```
    The provider fully supports per-connection configuration.
  - SSH1
```
public static final Capability SSH1
```
    The provider fully supports SSH1.
  - SSH2
```
public static final Capability SSH2
```
    The provider fully supports SSH2.
  - HTTP_PROXY
```
public static final Capability HTTP_PROXY
```
    The provider supports HTTP proxy connections.
  - SOCKS4_PROXY
```
public static final Capability SOCKS4_PROXY
```
    The provider supports SOCKS4 proxy connections.
  - SOCKS5_PROXY
```
public static final Capability SOCKS5_PROXY
```
    The provider supports SOCKS5 proxy connections.
  - PASSWORD_AUTHENTICATION
```
public static final Capability PASSWORD_AUTHENTICATION
```
    The provider supports password authentication. See SshPasswordAuthenticator.
  - PUBLIC_KEY_AUTHENTICATION
```
public static final Capability PUBLIC_KEY_AUTHENTICATION
```
    The provider supports public key authentication. See SshPublicKeyAuthenticator.
  - KEYBOARD_INTERACTIVE_AUTHENTICATION
```
public static final Capability KEYBOARD_INTERACTIVE_AUTHENTICATION
```
    The provider supports keyboard interactive authentication. See SshKeyboardInteractiveAuthenticator.
  - GSSAPI_AUTHENTICATION
```
public static final Capability GSSAPI_AUTHENTICATION
```
    The provider supports GSSAPI authentication. See SshGSSAPIAuthenticator.
  - IDENTITY_MANAGEMENT
```
public static final Capability IDENTITY_MANAGEMENT
```
    The provider supports identity management. See SshProvider.createIdentityManager(SshConfiguration).
  - HOST_KEY_MANAGEMENT
```
public static final Capability HOST_KEY_MANAGEMENT
```
    The provider supports host key management. See SshProvider.createHostKeyManager(SshConfiguration).
  - PORT_FORWARD_EVENTS
```
public static final Capability PORT_FORWARD_EVENTS
```
    The provider supports port forwarding events. See SshClient.addPortForwardListener(net.sf.sshapi.forwarding.SshPortForwardListener)
  - CHANNEL_DATA_EVENTS
```
public static final Capability CHANNEL_DATA_EVENTS
```
    The provider reports on channel data events. See SshDataProducingComponent.addDataListener(SshDataListener).
  - FILE_TRANSFER_EVENTS
```
public static final Capability FILE_TRANSFER_EVENTS
```
    The provider will fire events when file transfers start, progress, and finished.
  - SCP
```
public static final Capability SCP
```
    The provider supports SCP. See SshClient.createSCPClient().
  - SFTP
```
public static final Capability SFTP
```
    The provider supports SFTP. See SshClient.createSftpClient()
  - PUBLIC_KEY_SUBSYSTEM
```
public static final Capability PUBLIC_KEY_SUBSYSTEM
```
    The provider supports the public key subsystem. See SshClient.createPublicKeySubsystem().
  - SOCKET_FACTORY
```
public static final Capability SOCKET_FACTORY
```
    The provider supports use of a SocketFactory to create connections. See SshClient#setSocketFactory(SocketFactory).
  - WINDOW_CHANGE
```
public static final Capability WINDOW_CHANGE
```
    The provider supports changing of terminal window size SshShell.requestPseudoTerminalChange(int, int, int, int).
  - TUNNELED_SOCKET_FACTORY
```
public static final Capability TUNNELED_SOCKET_FACTORY
```
    The provider can create a socket factory that is tunneled to a remote host over SSH. See SshClient.createTunneledSocketFactory().
  - SFTP_OVER_SCP
```
public static final Capability SFTP_OVER_SCP
```
    The provider can fall-back to using SCP if SFTP is not available. This allows you to write you application using the SFTP API, with SCP being used if it is not available.
  - DATA_TIMEOUTS
```
public static final Capability DATA_TIMEOUTS
```
    Allows setting of timeouts on the connection.
  - CHANNEL_HANDLERS
```
public static final Capability CHANNEL_HANDLERS
```
    The provider supports channel handlers. See SshChannelHandler.
  - AGENT
```
public static final Capability AGENT
```
    The provider supports a agent for key authentication. One of the other capabilities RFC_AGENT or OPENSSH_AGENT will also be present.
  - RFC_AGENT
```
public static final Capability RFC_AGENT
```
    The provider supports an RFC agent for key authentication.
  - OPENSSH_AGENT
```
public static final Capability OPENSSH_AGENT
```
    The provider supports an SSH agent for key authentication.
- Method Detail
  - getName
```
public java.lang.String getName()
```
    Get the capability name
    
    Returns:
    
    capability name
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class Capability

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PER_CONNECTION_CONFIGURATION

SSH1

SSH2

HTTP_PROXY

SOCKS4_PROXY

SOCKS5_PROXY

PASSWORD_AUTHENTICATION

PUBLIC_KEY_AUTHENTICATION

KEYBOARD_INTERACTIVE_AUTHENTICATION

GSSAPI_AUTHENTICATION

IDENTITY_MANAGEMENT

HOST_KEY_MANAGEMENT

PORT_FORWARD_EVENTS

CHANNEL_DATA_EVENTS

FILE_TRANSFER_EVENTS

SCP

SFTP

PUBLIC_KEY_SUBSYSTEM

SOCKET_FACTORY

WINDOW_CHANGE

TUNNELED_SOCKET_FACTORY

SFTP_OVER_SCP

DATA_TIMEOUTS

CHANNEL_HANDLERS

AGENT

RFC_AGENT

OPENSSH_AGENT

Method Detail

getName

toString