Class SftpSubsystemFactory

java.lang.Object

org.apache.sshd.sftp.server.AbstractSftpEventListenerManager

org.apache.sshd.sftp.server.SftpSubsystemFactory

All Implemented Interfaces:

NamedResource, ExecutorServiceCarrier, ExecutorServiceProvider, ManagedExecutorServiceSupplier, SubsystemFactory, SftpErrorDataChannelReceiverProvider, SftpErrorStatusDataHandlerProvider, SftpEventListenerManager, SftpFileSystemAccessorManager, SftpFileSystemAccessorProvider, SftpSubsystemConfigurator, SftpUnsupportedAttributePolicyProvider

public class SftpSubsystemFactory
extends AbstractSftpEventListenerManager
implements ManagedExecutorServiceSupplier, SubsystemFactory, SftpFileSystemAccessorManager, SftpSubsystemConfigurator

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SftpSubsystemFactory.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static final UnsupportedAttributePolicy	DEFAULT_POLICY
private ChannelDataReceiver	errorChannelDataReceiver
private SftpErrorStatusDataHandler	errorStatusDataHandler
private Supplier<? extends CloseableExecutorService>	executorsProvider
private SftpFileSystemAccessor	fileSystemAccessor
static final String	NAME
private UnsupportedAttributePolicy	policy

Fields inherited from interface NamedResource

BY_NAME_COMPARATOR, NAME_EXTRACTOR

Constructor Summary

Constructors

Constructor	Description
SftpSubsystemFactory()

Method Summary

Modifier and Type	Method	Description
Command	createSubsystem(ChannelSession channel)
ChannelDataReceiver	getErrorChannelDataReceiver()
SftpErrorStatusDataHandler	getErrorStatusDataHandler()
CloseableExecutorService	getExecutorService()
Supplier<? extends CloseableExecutorService>	getExecutorServiceProvider()
SftpFileSystemAccessor	getFileSystemAccessor()
String	getName()
UnsupportedAttributePolicy	getUnsupportedAttributePolicy()
void	setErrorChannelDataReceiver(ChannelDataReceiver errorChannelDataReceiver)
void	setErrorStatusDataHandler(SftpErrorStatusDataHandler handler)
void	setExecutorServiceProvider(Supplier<? extends CloseableExecutorService> provider)
void	setFileSystemAccessor(SftpFileSystemAccessor accessor)
void	setUnsupportedAttributePolicy(UnsupportedAttributePolicy p)

Methods inherited from class AbstractSftpEventListenerManager

addSftpEventListener, getRegisteredListeners, getSftpEventListenerProxy, removeSftpEventListener

Methods inherited from class Object

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

Methods inherited from interface ExecutorServiceProvider

resolveExecutorService

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

DEFAULT_POLICY

public static final UnsupportedAttributePolicy DEFAULT_POLICY

executorsProvider

private Supplier<? extends CloseableExecutorService> executorsProvider

policy

private UnsupportedAttributePolicy policy

fileSystemAccessor

private SftpFileSystemAccessor fileSystemAccessor

errorStatusDataHandler

private SftpErrorStatusDataHandler errorStatusDataHandler

errorChannelDataReceiver

private ChannelDataReceiver errorChannelDataReceiver

Constructor Details

SftpSubsystemFactory

public SftpSubsystemFactory()

Method Details

getName

public String getName()

Specified by:

getName in interface NamedResource

Returns:

The resource name

getExecutorServiceProvider

public Supplier<? extends CloseableExecutorService> getExecutorServiceProvider()

Specified by:

getExecutorServiceProvider in interface ExecutorServiceProvider

Returns:

A Supplier of CloseableExecutorService to be used when asynchronous execution required. If null then a single-threaded ad-hoc service is used.

setExecutorServiceProvider

public void setExecutorServiceProvider(Supplier<? extends CloseableExecutorService> provider)

Specified by:

setExecutorServiceProvider in interface ManagedExecutorServiceSupplier

Parameters:

provider - The Supplier of CloseableExecutorService-s to be used when asynchronous execution is required. If null then a single-threaded ad-hoc service is used.

getUnsupportedAttributePolicy

public UnsupportedAttributePolicy getUnsupportedAttributePolicy()

Specified by:

getUnsupportedAttributePolicy in interface SftpUnsupportedAttributePolicyProvider

Returns:

The UnsupportedAttributePolicy to use if failed to access some local file attributes

setUnsupportedAttributePolicy

public void setUnsupportedAttributePolicy(UnsupportedAttributePolicy p)

Parameters:

p - The UnsupportedAttributePolicy to use if failed to access some local file attributes - never null

getFileSystemAccessor

public SftpFileSystemAccessor getFileSystemAccessor()

Specified by:

getFileSystemAccessor in interface SftpFileSystemAccessorProvider

Returns:

The SftpFileSystemAccessor to use for accessing files and directories

setFileSystemAccessor

public void setFileSystemAccessor(SftpFileSystemAccessor accessor)

Specified by:

setFileSystemAccessor in interface SftpFileSystemAccessorManager

getErrorStatusDataHandler

public SftpErrorStatusDataHandler getErrorStatusDataHandler()

Specified by:

getErrorStatusDataHandler in interface SftpErrorStatusDataHandlerProvider

Returns:

The (never null) SftpErrorStatusDataHandler to use when generating failed commands error messages

setErrorStatusDataHandler

public void setErrorStatusDataHandler(SftpErrorStatusDataHandler handler)

getExecutorService

public CloseableExecutorService getExecutorService()

Specified by:

getExecutorService in interface ExecutorServiceCarrier

Returns:

The CloseableExecutorService to use

getErrorChannelDataReceiver

public ChannelDataReceiver getErrorChannelDataReceiver()

Specified by:

getErrorChannelDataReceiver in interface SftpErrorDataChannelReceiverProvider

Returns:

A ChannelDataReceiver to handle optional STDERR data received during SFTP session. If null then any received such data is ignored.

setErrorChannelDataReceiver

public void setErrorChannelDataReceiver(ChannelDataReceiver errorChannelDataReceiver)

createSubsystem

public Command createSubsystem(ChannelSession channel)
                        throws IOException

Specified by:

createSubsystem in interface SubsystemFactory

Parameters:

channel - The ChannelSession through which the command has been received

Returns:

a non null Command instance representing the subsystem to be run

Throws:

IOException - if failed to create the instance