nl.esciencecenter.xenon.adaptors.filesystems.sftp

Class SftpFileAdaptor

java.lang.Object

nl.esciencecenter.xenon.adaptors.Adaptor

nl.esciencecenter.xenon.adaptors.filesystems.FileAdaptor

nl.esciencecenter.xenon.adaptors.filesystems.sftp.SftpFileAdaptor

All Implemented Interfaces:

AdaptorDescription, FileSystemAdaptorDescription

public class SftpFileAdaptor
extends FileAdaptor

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ADAPTOR_DESCRIPTION A description of this adaptor
private static java.lang.String[]	ADAPTOR_LOCATIONS The locations supported by this adaptor
static java.lang.String	ADAPTOR_NAME The name of this adaptor
static java.lang.String	AGENT Enable the use of an ssh-agent
static java.lang.String	AGENT_FORWARDING Enable the use of ssh-agent-forwarding
static java.lang.String	AUTOMATICALLY_ADD_HOST_KEY Enable strict host key checking.
static java.lang.String	BUFFER_SIZE The buffer size to use when copying data.
static java.lang.String	CONNECTION_TIMEOUT Property for maximum history length for finished jobs
static int	DEFAULT_PORT The default SSH port
static java.lang.String	GATEWAY Add gateway to access machine.
static java.lang.String	LOAD_SSH_CONFIG Load the OpenSSH config file by default.
static java.lang.String	LOAD_STANDARD_KNOWN_HOSTS Load the known_hosts file by default.
private static org.slf4j.Logger	LOGGER
static java.lang.String	PREFIX All our own properties start with this prefix.
static java.lang.String	SSH_CONFIG_FILE OpenSSH config filename.
static java.lang.String	STRICT_HOST_KEY_CHECKING Enable strict host key checking.
private static XenonPropertyDescription[]	VALID_PROPERTIES List of properties supported by this SSH adaptor

Fields inherited from class nl.esciencecenter.xenon.adaptors.filesystems.FileAdaptor

ADAPTORS_PREFIX

Constructor Summary

Constructors

Constructor and Description
SftpFileAdaptor()

Method Summary

Modifier and Type	Method and Description
boolean	canCreateSymboliclinks() Can this adaptor create symbolic links ? In third party copy, a file is copied between two remote locations, without passing through the local machine first.
FileSystem	createFileSystem(java.lang.String location, Credential credential, java.util.Map<java.lang.String,java.lang.String> properties)
private java.lang.String	getCurrentWorkingDirectory(org.apache.sshd.client.subsystem.sftp.SftpClient sftpClient, java.lang.String location)
java.lang.Class[]	getSupportedCredentials() Get the supported credential types for this adaptor.
boolean	supportsReadingPosixPermissions()
boolean	supportsSettingPosixPermissions()

Methods inherited from class nl.esciencecenter.xenon.adaptors.filesystems.FileAdaptor

canAppend, canReadSymboliclinks, isConnectionless, needsSizeBeforehand, supportsRename, supportsThirdPartyCopy

Methods inherited from class nl.esciencecenter.xenon.adaptors.Adaptor

getDescription, getName, getNewUniqueID, getSupportedLocations, getSupportedProperties

Methods inherited from class java.lang.Object

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

Methods inherited from interface nl.esciencecenter.xenon.AdaptorDescription

getDescription, getName, getSupportedLocations, getSupportedProperties

Field Detail

LOGGER

private static final org.slf4j.Logger LOGGER

ADAPTOR_NAME

public static final java.lang.String ADAPTOR_NAME

The name of this adaptor

See Also:

Constant Field Values

DEFAULT_PORT

public static final int DEFAULT_PORT

The default SSH port

See Also:

Constant Field Values

ADAPTOR_DESCRIPTION

public static final java.lang.String ADAPTOR_DESCRIPTION

A description of this adaptor

See Also:

Constant Field Values

PREFIX

public static final java.lang.String PREFIX

All our own properties start with this prefix.

See Also:

Constant Field Values

STRICT_HOST_KEY_CHECKING

public static final java.lang.String STRICT_HOST_KEY_CHECKING

Enable strict host key checking.

See Also:

Constant Field Values

AGENT

public static final java.lang.String AGENT

Enable the use of an ssh-agent

See Also:

Constant Field Values

AGENT_FORWARDING

public static final java.lang.String AGENT_FORWARDING

Enable the use of ssh-agent-forwarding

See Also:

Constant Field Values

LOAD_STANDARD_KNOWN_HOSTS

public static final java.lang.String LOAD_STANDARD_KNOWN_HOSTS

Load the known_hosts file by default.

See Also:

Constant Field Values

LOAD_SSH_CONFIG

public static final java.lang.String LOAD_SSH_CONFIG

Load the OpenSSH config file by default.

See Also:

Constant Field Values

SSH_CONFIG_FILE

public static final java.lang.String SSH_CONFIG_FILE

OpenSSH config filename.

See Also:

Constant Field Values

AUTOMATICALLY_ADD_HOST_KEY

public static final java.lang.String AUTOMATICALLY_ADD_HOST_KEY

Enable strict host key checking.

See Also:

Constant Field Values

GATEWAY

public static final java.lang.String GATEWAY

Add gateway to access machine.

See Also:

Constant Field Values

CONNECTION_TIMEOUT

public static final java.lang.String CONNECTION_TIMEOUT

Property for maximum history length for finished jobs

See Also:

Constant Field Values

BUFFER_SIZE

public static final java.lang.String BUFFER_SIZE

The buffer size to use when copying data.

See Also:

Constant Field Values

ADAPTOR_LOCATIONS

private static final java.lang.String[] ADAPTOR_LOCATIONS

The locations supported by this adaptor

VALID_PROPERTIES

private static final XenonPropertyDescription[] VALID_PROPERTIES

List of properties supported by this SSH adaptor

Constructor Detail

SftpFileAdaptor

public SftpFileAdaptor()

Method Detail

canCreateSymboliclinks

public boolean canCreateSymboliclinks()

Description copied from interface: FileSystemAdaptorDescription

Can this adaptor create symbolic links ? In third party copy, a file is copied between two remote locations, without passing through the local machine first.

Specified by:

canCreateSymboliclinks in interface FileSystemAdaptorDescription

Overrides:

canCreateSymboliclinks in class FileAdaptor

Returns:

if this adaptor can create symbolic links.

createFileSystem

public FileSystem createFileSystem(java.lang.String location,
                                   Credential credential,
                                   java.util.Map<java.lang.String,java.lang.String> properties)
                            throws XenonException

Specified by:

createFileSystem in class FileAdaptor

Throws:

XenonException

getCurrentWorkingDirectory

private java.lang.String getCurrentWorkingDirectory(org.apache.sshd.client.subsystem.sftp.SftpClient sftpClient,
                                                    java.lang.String location)
                                             throws XenonException

Throws:

XenonException

supportsReadingPosixPermissions

public boolean supportsReadingPosixPermissions()

Specified by:

supportsReadingPosixPermissions in interface FileSystemAdaptorDescription

Overrides:

supportsReadingPosixPermissions in class FileAdaptor

supportsSettingPosixPermissions

public boolean supportsSettingPosixPermissions()

Specified by:

supportsSettingPosixPermissions in interface FileSystemAdaptorDescription

Overrides:

supportsSettingPosixPermissions in class FileAdaptor

getSupportedCredentials

public java.lang.Class[] getSupportedCredentials()

Description copied from interface: AdaptorDescription

Get the supported credential types for this adaptor.

Returns:

the credential types supported by this adaptor.