Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	SftpSubsystemFactory.Builder

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

Constructor Summary

Access	Constructor and Description
public	SftpSubsystemFactory()

Modifier and Type	Method and Description
public Command	createSubsystem(ChannelSession The `ChannelSession` through which the command has been received channel) Implements org.apache.sshd.server.subsystem.SubsystemFactory.createSubsystem.
public ChannelDataReceiver	getErrorChannelDataReceiver() Implements org.apache.sshd.sftp.server.SftpErrorDataChannelReceiverProvider.getErrorChannelDataReceiver.
public SftpErrorStatusDataHandler	getErrorStatusDataHandler() Implements org.apache.sshd.sftp.server.SftpErrorStatusDataHandlerProvider.getErrorStatusDataHandler.
public CloseableExecutorService	getExecutorService() Implements org.apache.sshd.common.util.threads.ExecutorServiceCarrier.getExecutorService.
public Supplier<? extends CloseableExecutorService>	getExecutorServiceProvider() Implements org.apache.sshd.common.util.threads.ExecutorServiceProvider.getExecutorServiceProvider.
public SftpFileSystemAccessor	getFileSystemAccessor() Implements org.apache.sshd.sftp.server.SftpFileSystemAccessorProvider.getFileSystemAccessor.
public String	getName() Implements org.apache.sshd.common.NamedResource.getName.
public UnsupportedAttributePolicy	getUnsupportedAttributePolicy() Implements org.apache.sshd.sftp.server.SftpUnsupportedAttributePolicyProvider.getUnsupportedAttributePolicy.
public void	setErrorChannelDataReceiver(ChannelDataReceiver errorChannelDataReceiver)
public void	setErrorStatusDataHandler(SftpErrorStatusDataHandler handler)
public void	setExecutorServiceProvider(Supplier<? extends CloseableExecutorService> The `Supplier` of `CloseableExecutorService`-s to be used when asynchronous execution is required. If `null` then a single-threaded ad-hoc service is used. provider) Implements org.apache.sshd.common.util.threads.ManagedExecutorServiceSupplier.setExecutorServiceProvider.
public void	setFileSystemAccessor(SftpFileSystemAccessor accessor) Implements org.apache.sshd.sftp.server.SftpFileSystemAccessorManager.setFileSystemAccessor.
public void	setUnsupportedAttributePolicy(UnsupportedAttributePolicy The `UnsupportedAttributePolicy` to use if failed to access some local file attributes - never `null` p)

Field Detail

DEFAULT_POLICY	back to summary
public static final UnsupportedAttributePolicy DEFAULT_POLICY

errorChannelDataReceiver	back to summary
private ChannelDataReceiver errorChannelDataReceiver

errorStatusDataHandler	back to summary
private SftpErrorStatusDataHandler errorStatusDataHandler

executorsProvider	back to summary
private Supplier<? extends CloseableExecutorService> executorsProvider

fileSystemAccessor	back to summary
private SftpFileSystemAccessor fileSystemAccessor

NAME	back to summary
public static final String NAME

policy	back to summary
private UnsupportedAttributePolicy policy

Constructor Detail

SftpSubsystemFactory	back to summary
public SftpSubsystemFactory()

Method Detail

createSubsystem back to summary

createSubsystem	back to summary
public Command createSubsystem(ChannelSession channel) throws IOException Implements org.apache.sshd.server.subsystem.SubsystemFactory.createSubsystem. Parameters channel:ChannelSession Doc from org.apache.sshd.server.subsystem.SubsystemFactory.createSubsystem. The `ChannelSession` through which the command has been received Returns:Command Doc from org.apache.sshd.server.subsystem.SubsystemFactory.createSubsystem. a non `null` `Command` instance representing the subsystem to be run Annotations @Override Exceptions IOException: Doc from org.apache.sshd.server.subsystem.SubsystemFactory.createSubsystem. if failed to create the instance

public Command createSubsystem(ChannelSession channel) throws IOException

Implements org.apache.sshd.server.subsystem.SubsystemFactory.createSubsystem.

Parameters

channel:ChannelSession

Doc from org.apache.sshd.server.subsystem.SubsystemFactory.createSubsystem.

The ChannelSession through which the command has been received

Returns:Command

Doc from org.apache.sshd.server.subsystem.SubsystemFactory.createSubsystem.

a non null Command instance representing the subsystem to be run

Annotations

@Override

Exceptions

IOException:

Doc from org.apache.sshd.server.subsystem.SubsystemFactory.createSubsystem.

if failed to create the instance

getErrorChannelDataReceiver back to summary

getErrorChannelDataReceiver	back to summary
public ChannelDataReceiver getErrorChannelDataReceiver() Implements org.apache.sshd.sftp.server.SftpErrorDataChannelReceiverProvider.getErrorChannelDataReceiver. Returns:ChannelDataReceiver Doc from org.apache.sshd.sftp.server.SftpErrorDataChannelReceiverProvider.getErrorChannelDataReceiver. A `ChannelDataReceiver` to handle optional STDERR data received during SFTP session. If `null` then any received such data is ignored. Annotations @Override

public ChannelDataReceiver getErrorChannelDataReceiver()

Implements org.apache.sshd.sftp.server.SftpErrorDataChannelReceiverProvider.getErrorChannelDataReceiver.

Returns:ChannelDataReceiver

Doc from org.apache.sshd.sftp.server.SftpErrorDataChannelReceiverProvider.getErrorChannelDataReceiver.

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

Annotations

@Override

getErrorStatusDataHandler back to summary

getErrorStatusDataHandler	back to summary
public SftpErrorStatusDataHandler getErrorStatusDataHandler() Implements org.apache.sshd.sftp.server.SftpErrorStatusDataHandlerProvider.getErrorStatusDataHandler. Returns:SftpErrorStatusDataHandler Doc from org.apache.sshd.sftp.server.SftpErrorStatusDataHandlerProvider.getErrorStatusDataHandler. The (never `null`) `SftpErrorStatusDataHandler` to use when generating failed commands error messages Annotations @Override

public SftpErrorStatusDataHandler getErrorStatusDataHandler()

Implements org.apache.sshd.sftp.server.SftpErrorStatusDataHandlerProvider.getErrorStatusDataHandler.

Returns:SftpErrorStatusDataHandler

Doc from org.apache.sshd.sftp.server.SftpErrorStatusDataHandlerProvider.getErrorStatusDataHandler.

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

Annotations

@Override

getExecutorService back to summary

getExecutorService	back to summary
public CloseableExecutorService getExecutorService() Implements org.apache.sshd.common.util.threads.ExecutorServiceCarrier.getExecutorService. Returns:CloseableExecutorService Doc from org.apache.sshd.common.util.threads.ExecutorServiceCarrier.getExecutorService. The `CloseableExecutorService` to use Annotations @Override

public CloseableExecutorService getExecutorService()

Implements org.apache.sshd.common.util.threads.ExecutorServiceCarrier.getExecutorService.

Returns:CloseableExecutorService

Doc from org.apache.sshd.common.util.threads.ExecutorServiceCarrier.getExecutorService.

The CloseableExecutorService to use

Annotations

@Override

getExecutorServiceProvider back to summary

getExecutorServiceProvider	back to summary
public Supplier<? extends CloseableExecutorService> getExecutorServiceProvider() Implements org.apache.sshd.common.util.threads.ExecutorServiceProvider.getExecutorServiceProvider. Returns:Supplier<? extends CloseableExecutorService> Doc from org.apache.sshd.common.util.threads.ExecutorServiceProvider.getExecutorServiceProvider. A `Supplier` of `CloseableExecutorService` to be used when asynchronous execution required. If `null` then a single-threaded ad-hoc service is used. Annotations @Override

public Supplier<? extends CloseableExecutorService> getExecutorServiceProvider()

Implements org.apache.sshd.common.util.threads.ExecutorServiceProvider.getExecutorServiceProvider.

Returns:Supplier<? extends CloseableExecutorService>

Doc from org.apache.sshd.common.util.threads.ExecutorServiceProvider.getExecutorServiceProvider.

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

Annotations

@Override

getFileSystemAccessor back to summary

getFileSystemAccessor	back to summary
public SftpFileSystemAccessor getFileSystemAccessor() Implements org.apache.sshd.sftp.server.SftpFileSystemAccessorProvider.getFileSystemAccessor. Returns:SftpFileSystemAccessor Doc from org.apache.sshd.sftp.server.SftpFileSystemAccessorProvider.getFileSystemAccessor. The `SftpFileSystemAccessor` to use for accessing files and directories Annotations @Override

public SftpFileSystemAccessor getFileSystemAccessor()

Implements org.apache.sshd.sftp.server.SftpFileSystemAccessorProvider.getFileSystemAccessor.

Returns:SftpFileSystemAccessor

Doc from org.apache.sshd.sftp.server.SftpFileSystemAccessorProvider.getFileSystemAccessor.

The SftpFileSystemAccessor to use for accessing files and directories

Annotations

@Override

getName	back to summary
public String getName() Implements org.apache.sshd.common.NamedResource.getName. Returns:String Doc from org.apache.sshd.common.NamedResource.getName. The resource name Annotations @Override

getName

back to summary

public String getName()

Implements org.apache.sshd.common.NamedResource.getName.

Returns:String

Doc from org.apache.sshd.common.NamedResource.getName.

The resource name

Annotations

@Override

getUnsupportedAttributePolicy back to summary

getUnsupportedAttributePolicy	back to summary
public UnsupportedAttributePolicy getUnsupportedAttributePolicy() Implements org.apache.sshd.sftp.server.SftpUnsupportedAttributePolicyProvider.getUnsupportedAttributePolicy. Returns:UnsupportedAttributePolicy Doc from org.apache.sshd.sftp.server.SftpUnsupportedAttributePolicyProvider.getUnsupportedAttributePolicy. The `UnsupportedAttributePolicy` to use if failed to access some local file attributes Annotations @Override

public UnsupportedAttributePolicy getUnsupportedAttributePolicy()

Implements org.apache.sshd.sftp.server.SftpUnsupportedAttributePolicyProvider.getUnsupportedAttributePolicy.

Returns:UnsupportedAttributePolicy

Doc from org.apache.sshd.sftp.server.SftpUnsupportedAttributePolicyProvider.getUnsupportedAttributePolicy.

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

Annotations

@Override

setErrorChannelDataReceiver	back to summary
public void setErrorChannelDataReceiver(ChannelDataReceiver errorChannelDataReceiver)

setErrorStatusDataHandler	back to summary
public void setErrorStatusDataHandler(SftpErrorStatusDataHandler handler)

setExecutorServiceProvider back to summary

setExecutorServiceProvider	back to summary
public void setExecutorServiceProvider(Supplier<? extends CloseableExecutorService> provider) Implements org.apache.sshd.common.util.threads.ManagedExecutorServiceSupplier.setExecutorServiceProvider. Parameters provider:Supplier<? extends CloseableExecutorService> Doc from org.apache.sshd.common.util.threads.ManagedExecutorServiceSupplier.setExecutorServiceProvider. The `Supplier` of `CloseableExecutorService`-s to be used when asynchronous execution is required. If `null` then a single-threaded ad-hoc service is used. Annotations @Override

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

Implements org.apache.sshd.common.util.threads.ManagedExecutorServiceSupplier.setExecutorServiceProvider.

Parameters

provider:Supplier<? extends CloseableExecutorService>

Doc from org.apache.sshd.common.util.threads.ManagedExecutorServiceSupplier.setExecutorServiceProvider.

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

Annotations

@Override

setFileSystemAccessor	back to summary
public void setFileSystemAccessor(SftpFileSystemAccessor accessor) Implements org.apache.sshd.sftp.server.SftpFileSystemAccessorManager.setFileSystemAccessor. Annotations @Override

setFileSystemAccessor

back to summary

public void setFileSystemAccessor(SftpFileSystemAccessor accessor)

Implements org.apache.sshd.sftp.server.SftpFileSystemAccessorManager.setFileSystemAccessor.

Annotations

@Override

setUnsupportedAttributePolicy	back to summary
public void setUnsupportedAttributePolicy(UnsupportedAttributePolicy p) Parameters p:UnsupportedAttributePolicy The `UnsupportedAttributePolicy` to use if failed to access some local file attributes - never `null`

org.apache.sshd.sftp.server back to summary

public Class SftpSubsystemFactory.Builder

Class Inheritance

extends AbstractSftpEventListenerManager
implements ObjectBuilder<SftpSubsystemFactory>

java.lang.Object
org.apache.sshd.sftp.server.AbstractSftpEventListenerManager
org.apache.sshd.sftp.server.SftpSubsystemFactory.Builder

All Implemented Interfaces

org.apache.sshd.common.util.ObjectBuilder, java.util.function.Supplier

Field Summary

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

Constructor Summary

Access	Constructor and Description
public	Builder()

Method Summary

Modifier and Type	Method and Description
public SftpSubsystemFactory	build() Implements org.apache.sshd.common.util.ObjectBuilder.build.
public SftpSubsystemFactory.Builder	withErrorChannelDataReceiver(ChannelDataReceiver receiver)
public SftpSubsystemFactory.Builder	withExecutorServiceProvider(Supplier<? extends CloseableExecutorService> provider)
public SftpSubsystemFactory.Builder	withFileSystemAccessor(SftpFileSystemAccessor accessor)
public SftpSubsystemFactory.Builder	withSftpErrorStatusDataHandler(SftpErrorStatusDataHandler handler)
public SftpSubsystemFactory.Builder	withUnsupportedAttributePolicy(UnsupportedAttributePolicy p)

Inherited from org.apache.sshd.sftp.server.AbstractSftpEventListenerManager:: addSftpEventListener getRegisteredListeners getSftpEventListenerProxy removeSftpEventListener

Field Detail

errorChannelDataReceiver	back to summary
private ChannelDataReceiver errorChannelDataReceiver

errorStatusDataHandler	back to summary
private SftpErrorStatusDataHandler errorStatusDataHandler

executorsProvider	back to summary
private Supplier<? extends CloseableExecutorService> executorsProvider

fileSystemAccessor	back to summary
private SftpFileSystemAccessor fileSystemAccessor

policy	back to summary
private UnsupportedAttributePolicy policy

Constructor Detail

Builder	back to summary
public Builder()

Method Detail

build	back to summary
public SftpSubsystemFactory build() Implements org.apache.sshd.common.util.ObjectBuilder.build. Annotations @Override

build

back to summary

public SftpSubsystemFactory build()

Implements org.apache.sshd.common.util.ObjectBuilder.build.

Annotations

@Override

withErrorChannelDataReceiver	back to summary
public SftpSubsystemFactory.Builder withErrorChannelDataReceiver(ChannelDataReceiver receiver)

withExecutorServiceProvider	back to summary
public SftpSubsystemFactory.Builder withExecutorServiceProvider(Supplier<? extends CloseableExecutorService> provider)

withFileSystemAccessor	back to summary
public SftpSubsystemFactory.Builder withFileSystemAccessor(SftpFileSystemAccessor accessor)

withSftpErrorStatusDataHandler	back to summary
public SftpSubsystemFactory.Builder withSftpErrorStatusDataHandler(SftpErrorStatusDataHandler handler)

withUnsupportedAttributePolicy	back to summary
public SftpSubsystemFactory.Builder withUnsupportedAttributePolicy(UnsupportedAttributePolicy p)