org.apache.sshd.server.subsystem.sftp

Class SftpSubsystemFactory

java.lang.Object

org.apache.sshd.server.subsystem.sftp.AbstractSftpEventListenerManager

org.apache.sshd.server.subsystem.sftp.SftpSubsystemFactory

All Implemented Interfaces:

Supplier<Command>, Factory<Command>, NamedFactory<Command>, NamedResource, ExecutorServiceCarrier, ExecutorServiceConfigurer, SftpEventListenerManager, SftpFileSystemAccessorManager, SubsystemFactory

public class SftpSubsystemFactory
extends AbstractSftpEventListenerManager
implements SubsystemFactory, ExecutorServiceConfigurer, SftpEventListenerManager, SftpFileSystemAccessorManager

Author:

Apache MINA SSHD Project

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SftpSubsystemFactory.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static UnsupportedAttributePolicy	DEFAULT_POLICY
static String	NAME

Fields inherited from interface org.apache.sshd.common.NamedResource

BY_NAME_COMPARATOR, NAME_EXTRACTOR

Constructor Summary

Constructors

Constructor and Description
SftpSubsystemFactory()

Method Summary

Modifier and Type	Method and Description
Command	create()
ExecutorService	getExecutorService()
SftpFileSystemAccessor	getFileSystemAccessor()
String	getName()
UnsupportedAttributePolicy	getUnsupportedAttributePolicy()
boolean	isShutdownOnExit()
void	setExecutorService(ExecutorService service)
void	setFileSystemAccessor(SftpFileSystemAccessor accessor)
void	setShutdownOnExit(boolean shutdownOnExit)
void	setUnsupportedAttributePolicy(UnsupportedAttributePolicy p)

Methods inherited from class org.apache.sshd.server.subsystem.sftp.AbstractSftpEventListenerManager

addSftpEventListener, getRegisteredListeners, getSftpEventListenerProxy, removeSftpEventListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.sshd.common.NamedFactory

create, setUpBuiltinFactories, setUpTransformedFactories

Methods inherited from interface org.apache.sshd.common.Factory

get

Methods inherited from interface org.apache.sshd.common.NamedResource

findByName, getNameList, getNames, removeByName

Methods inherited from interface org.apache.sshd.server.subsystem.sftp.SftpEventListenerManager

addSftpEventListener, getSftpEventListenerProxy, removeSftpEventListener

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

DEFAULT_POLICY

public static final UnsupportedAttributePolicy DEFAULT_POLICY

Constructor Detail

SftpSubsystemFactory

public SftpSubsystemFactory()

Method Detail

getName

public String getName()

Specified by:

getName in interface NamedResource

Returns:

The resource name

getExecutorService

public ExecutorService getExecutorService()

Specified by:

getExecutorService in interface ExecutorServiceCarrier

Returns:

The ExecutorService to use

setExecutorService

public void setExecutorService(ExecutorService service)

Specified by:

setExecutorService in interface ExecutorServiceConfigurer

Parameters:

service - The ExecutorService to be used by the SftpSubsystem command when starting execution. If null then a single-threaded ad-hoc service is used.

isShutdownOnExit

public boolean isShutdownOnExit()

Specified by:

isShutdownOnExit in interface ExecutorServiceCarrier

Returns:

If true then the ExecutorService.shutdownNow() will be called (unless it is an internally allocated service which is always closed)

setShutdownOnExit

public void setShutdownOnExit(boolean shutdownOnExit)

Specified by:

setShutdownOnExit in interface ExecutorServiceConfigurer

Parameters:

shutdownOnExit - If true the ExecutorService.shutdownNow() will be called when subsystem terminates - unless it is the ad-hoc service, which will be shutdown regardless

getUnsupportedAttributePolicy

public UnsupportedAttributePolicy getUnsupportedAttributePolicy()

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 SftpFileSystemAccessorManager

setFileSystemAccessor

public void setFileSystemAccessor(SftpFileSystemAccessor accessor)

Specified by:

setFileSystemAccessor in interface SftpFileSystemAccessorManager

create

public Command create()

Specified by:

create in interface Factory<Command>

Returns:

A new instance