public abstract class AbstractSftpSubsystemHelper extends AbstractLoggingBean implements SftpSubsystemProxy
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ACL_SUPPORTED_MASK_PROP
Comma separate list of
SSH_ACL_CAP_xxx names - where name can be without the prefix. |
static java.lang.String |
AUTO_FOLLOW_LINKS
Whether to automatically follow symbolic links when resolving paths
|
static java.lang.String |
CLIENT_EXTENSIONS_PROP
Allows controlling reports of which client extensions are supported (and reported via "support" and
"support2" server extensions) as a comma-separate list of names.
|
static java.util.Set<java.lang.Integer> |
DEFAULT_ACL_SUPPORTED_MASK |
static boolean |
DEFAULT_AUTO_FOLLOW_LINKS
Default value of "sftp-auto-follow-links"
|
static int |
DEFAULT_MAX_READDATA_PACKET_LENGTH |
static java.util.List<AbstractOpenSSHExtensionParser.OpenSSHExtension> |
DEFAULT_OPEN_SSH_EXTENSIONS |
static java.util.List<java.lang.String> |
DEFAULT_OPEN_SSH_EXTENSIONS_NAMES |
static java.util.NavigableMap<java.lang.String,OptionalFeature> |
DEFAULT_SUPPORTED_CLIENT_EXTENSIONS
The default reported supported client extensions (case insensitive)
|
private SftpErrorStatusDataHandler |
errorStatusDataHandler |
private SftpFileSystemAccessor |
fileSystemAccessor |
static java.lang.String |
MAX_READDATA_PACKET_LENGTH_PROP
Force the use of a max.
|
static java.lang.String |
NEWLINE_VALUE
Property that can be used to set the reported NL value.
|
static java.lang.String |
OPENSSH_EXTENSIONS_PROP
Comma-separated list of which
OpenSSH extensions are reported and what version is reported for each -
format: name=version . |
private SftpEventListener |
sftpEventListenerProxy |
private java.util.Collection<SftpEventListener> |
sftpEventListeners |
private UnsupportedAttributePolicy |
unsupportedAttributePolicy |
log
ALL_SFTP_IMPL, HIGHER_SFTP_IMPL, LOWER_SFTP_IMPL, SFTP_VERSION, SUPPORTED_SFTP_VERSIONS
Modifier | Constructor and Description |
---|---|
protected |
AbstractSftpSubsystemHelper(UnsupportedAttributePolicy policy,
SftpFileSystemAccessor accessor,
SftpErrorStatusDataHandler handler) |
Modifier and Type | Method and Description |
---|---|
protected java.util.NavigableMap<java.lang.String,java.lang.Object> |
addMissingAttribute(java.nio.file.Path file,
java.util.NavigableMap<java.lang.String,java.lang.Object> current,
java.lang.String name,
FileInfoExtractor<?> x,
java.nio.file.LinkOption... options) |
boolean |
addSftpEventListener(SftpEventListener listener)
Register a listener instance
|
protected int |
appendAclSupportedExtension(Buffer buffer,
ServerSession session) |
protected void |
appendExtensions(Buffer buffer,
java.lang.String supportedVersions) |
protected void |
appendNewlineExtension(Buffer buffer,
ServerSession session)
Appends the "newline" extension to the buffer.
|
protected java.util.List<AbstractOpenSSHExtensionParser.OpenSSHExtension> |
appendOpenSSHExtensions(Buffer buffer,
ServerSession session) |
protected void |
appendSupported2Extension(Buffer buffer,
java.util.Collection<java.lang.String> extras)
Appends the "supported2" extension to the buffer.
|
protected void |
appendSupportedExtension(Buffer buffer,
java.util.Collection<java.lang.String> extras)
Appends the "supported" extension to the buffer.
|
protected void |
appendVendorIdExtension(Buffer buffer,
java.util.Map<java.lang.String,?> versionProperties,
ServerSession session)
Appends the "vendor-id" extension to the buffer.
|
protected void |
appendVersionsExtension(Buffer buffer,
java.lang.String value,
ServerSession session)
Appends the "versions" extension to the buffer.
|
protected java.util.Map.Entry<java.lang.Integer,java.lang.String> |
checkVersionCompatibility(Buffer buffer,
int id,
int proposed,
int failureOpcode)
Checks if a proposed version is within supported range.
|
protected abstract void |
createLink(int id,
java.lang.String existingPath,
java.lang.String linkPath,
boolean symLink) |
protected void |
doBlock(Buffer buffer,
int id) |
protected abstract void |
doBlock(int id,
java.lang.String handle,
long offset,
long length,
int mask) |
protected void |
doCheckFileHash(Buffer buffer,
int id,
java.lang.String targetType) |
protected void |
doCheckFileHash(int id,
java.nio.file.Path file,
NamedFactory<? extends Digest> factory,
long startOffset,
long length,
int blockSize,
Buffer buffer) |
protected abstract void |
doCheckFileHash(int id,
java.lang.String targetType,
java.lang.String target,
java.util.Collection<java.lang.String> algos,
long startOffset,
long length,
int blockSize,
Buffer buffer) |
protected void |
doClose(Buffer buffer,
int id) |
protected abstract void |
doClose(int id,
java.lang.String handle) |
protected void |
doCopyData(Buffer buffer,
int id) |
protected abstract void |
doCopyData(int id,
java.lang.String readHandle,
long readOffset,
long readLength,
java.lang.String writeHandle,
long writeOffset) |
protected void |
doCopyFile(Buffer buffer,
int id) |
protected void |
doCopyFile(int id,
java.lang.String srcFile,
java.lang.String dstFile,
boolean overwriteDestination) |
protected void |
doCopyFile(int id,
java.lang.String srcFile,
java.lang.String dstFile,
java.util.Collection<java.nio.file.CopyOption> opts) |
protected void |
doExtended(Buffer buffer,
int id) |
protected void |
doFSetStat(Buffer buffer,
int id) |
protected abstract void |
doFSetStat(int id,
java.lang.String handle,
java.util.Map<java.lang.String,?> attrs) |
protected void |
doFStat(Buffer buffer,
int id) |
protected abstract java.util.Map<java.lang.String,java.lang.Object> |
doFStat(int id,
java.lang.String handle,
int flags) |
protected abstract void |
doInit(Buffer buffer,
int id) |
protected void |
doLink(Buffer buffer,
int id) |
protected void |
doLink(int id,
java.lang.String targetPath,
java.lang.String linkPath,
boolean symLink) |
protected void |
doLStat(Buffer buffer,
int id) |
protected java.util.Map<java.lang.String,java.lang.Object> |
doLStat(int id,
java.lang.String path,
int flags) |
protected void |
doMakeDirectory(Buffer buffer,
int id) |
protected void |
doMakeDirectory(int id,
java.lang.String path,
java.util.Map<java.lang.String,?> attrs,
java.nio.file.LinkOption... options) |
protected void |
doMD5Hash(Buffer buffer,
int id,
java.lang.String targetType) |
protected byte[] |
doMD5Hash(int id,
java.nio.file.Path path,
long startOffset,
long length,
byte[] quickCheckHash) |
protected abstract byte[] |
doMD5Hash(int id,
java.lang.String targetType,
java.lang.String target,
long startOffset,
long length,
byte[] quickCheckHash) |
protected void |
doOpen(Buffer buffer,
int id) |
protected abstract java.lang.String |
doOpen(int id,
java.lang.String path,
int pflags,
int access,
java.util.Map<java.lang.String,java.lang.Object> attrs) |
protected void |
doOpenDir(Buffer buffer,
int id) |
protected abstract java.lang.String |
doOpenDir(int id,
java.lang.String path,
java.nio.file.Path p,
java.nio.file.LinkOption... options) |
protected void |
doOpenSSHFsync(Buffer buffer,
int id) |
protected abstract void |
doOpenSSHFsync(int id,
java.lang.String handle) |
protected void |
doOpenSSHHardLink(Buffer buffer,
int id) |
protected void |
doOpenSSHHardLink(int id,
java.lang.String srcFile,
java.lang.String dstFile) |
protected void |
doProcess(Buffer buffer,
int length,
int type,
int id) |
protected void |
doRead(Buffer buffer,
int id) |
protected abstract int |
doRead(int id,
java.lang.String handle,
long offset,
int length,
byte[] data,
int doff) |
protected abstract void |
doReadDir(Buffer buffer,
int id) |
protected int |
doReadDir(int id,
java.lang.String handle,
DirectoryHandle dir,
Buffer buffer,
int maxSize,
java.nio.file.LinkOption... options) |
protected void |
doReadLink(Buffer buffer,
int id) |
protected java.lang.String |
doReadLink(int id,
java.lang.String path) |
protected void |
doRealPath(Buffer buffer,
int id) |
protected java.util.AbstractMap.SimpleImmutableEntry<java.nio.file.Path,java.lang.Boolean> |
doRealPathV345(int id,
java.lang.String path,
java.nio.file.Path p,
java.nio.file.LinkOption... options) |
protected java.util.AbstractMap.SimpleImmutableEntry<java.nio.file.Path,java.lang.Boolean> |
doRealPathV6(int id,
java.lang.String path,
java.util.Collection<java.lang.String> extraPaths,
java.nio.file.Path p,
java.nio.file.LinkOption... options) |
protected void |
doRemove(Buffer buffer,
int id) |
protected void |
doRemove(int id,
java.nio.file.Path p,
boolean isDirectory)
Called when need to delete a file / directory - also informs the
SftpEventListener |
protected void |
doRemove(int id,
java.lang.String path,
java.nio.file.LinkOption... options) |
protected void |
doRemoveDirectory(Buffer buffer,
int id) |
protected void |
doRemoveDirectory(int id,
java.lang.String path,
java.nio.file.LinkOption... options) |
protected void |
doRename(Buffer buffer,
int id) |
protected void |
doRename(int id,
java.lang.String oldPath,
java.lang.String newPath,
java.util.Collection<java.nio.file.CopyOption> opts) |
protected void |
doRename(int id,
java.lang.String oldPath,
java.lang.String newPath,
int flags) |
protected void |
doSetAttributes(java.nio.file.Path file,
java.util.Map<java.lang.String,?> attributes,
boolean followLinks) |
protected void |
doSetStat(Buffer buffer,
int id,
java.lang.String extension,
int cmd,
java.lang.Boolean followLinks) |
protected void |
doSetStat(int id,
java.lang.String path,
int cmd,
java.lang.String extension,
java.util.Map<java.lang.String,?> attrs,
java.lang.Boolean followLinks) |
protected void |
doSpaceAvailable(Buffer buffer,
int id) |
protected SpaceAvailableExtensionInfo |
doSpaceAvailable(int id,
java.lang.String path) |
protected void |
doStat(Buffer buffer,
int id) |
protected java.util.Map<java.lang.String,java.lang.Object> |
doStat(int id,
java.lang.String path,
int flags) |
protected void |
doSymLink(Buffer buffer,
int id) |
protected void |
doSymLink(int id,
java.lang.String targetPath,
java.lang.String linkPath) |
protected void |
doTextSeek(Buffer buffer,
int id) |
protected abstract void |
doTextSeek(int id,
java.lang.String handle,
long line) |
protected void |
doUnblock(Buffer buffer,
int id) |
protected abstract void |
doUnblock(int id,
java.lang.String handle,
long offset,
long length) |
protected void |
doUnsupported(Buffer buffer,
int length,
int type,
int id) |
protected void |
doUnsupportedExtension(Buffer buffer,
int id,
java.lang.String extension) |
protected void |
doVersionSelect(Buffer buffer,
int id) |
protected abstract void |
doVersionSelect(Buffer buffer,
int id,
java.lang.String proposed) |
protected void |
doWrite(Buffer buffer,
int id) |
protected abstract void |
doWrite(int id,
java.lang.String handle,
long offset,
int length,
byte[] data,
int doff,
int remaining) |
protected void |
executeExtendedCommand(Buffer buffer,
int id,
java.lang.String extension) |
protected java.util.NavigableMap<java.lang.String,java.lang.Object> |
getAttributes(java.nio.file.Path file,
int flags,
java.nio.file.LinkOption... options) |
protected java.util.NavigableMap<java.lang.String,java.lang.Object> |
getAttributes(java.nio.file.Path file,
java.nio.file.LinkOption... options) |
SftpErrorStatusDataHandler |
getErrorStatusDataHandler() |
SftpFileSystemAccessor |
getFileSystemAccessor() |
protected java.lang.String |
getLongName(java.nio.file.Path f,
java.lang.String shortName,
boolean sendAttrs,
java.nio.file.LinkOption... options) |
protected java.lang.String |
getLongName(java.nio.file.Path f,
java.lang.String shortName,
java.nio.file.LinkOption... options) |
protected java.lang.String |
getLongName(java.nio.file.Path f,
java.lang.String shortName,
java.util.Map<java.lang.String,?> attributes) |
protected java.nio.file.LinkOption[] |
getPathResolutionLinkOption(int cmd,
java.lang.String extension,
java.nio.file.Path path) |
SftpEventListener |
getSftpEventListenerProxy() |
protected java.lang.String |
getShortName(java.nio.file.Path f) |
protected java.util.Map<java.lang.String,OptionalFeature> |
getSupportedClientExtensions(ServerSession session) |
UnsupportedAttributePolicy |
getUnsupportedAttributePolicy() |
protected java.util.NavigableMap<java.lang.String,java.lang.Object> |
handleReadFileAttributesException(java.nio.file.Path file,
java.lang.String view,
java.nio.file.LinkOption[] options,
java.io.IOException e) |
protected void |
handleSetFileAttributeFailure(java.nio.file.Path file,
java.lang.String view,
java.lang.String attribute,
java.lang.Object value,
java.util.Collection<java.lang.String> unsupported,
java.lang.Exception e) |
protected java.util.NavigableMap<java.lang.String,java.lang.Object> |
handleUnknownStatusFileAttributes(java.nio.file.Path file,
int flags,
java.nio.file.LinkOption... options) |
protected void |
handleUnsupportedAttributes(java.util.Collection<java.lang.String> attributes) |
protected void |
handleUserPrincipalLookupServiceException(java.lang.Class<? extends java.security.Principal> principalType,
java.lang.String name,
java.io.IOException e) |
protected java.nio.file.Path |
normalize(java.nio.file.Path f) |
protected abstract Buffer |
prepareReply(Buffer buffer) |
protected void |
process(Buffer buffer)
Process an SFTP command.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
readAttrs(Buffer buffer) |
protected java.util.NavigableMap<java.lang.String,java.lang.Object> |
readFileAttributes(java.nio.file.Path file,
java.lang.String view,
java.nio.file.LinkOption... options) |
boolean |
removeSftpEventListener(SftpEventListener listener)
Remove a listener instance
|
protected java.util.Collection<java.lang.Integer> |
resolveAclSupportedCapabilities(ServerSession session) |
protected java.nio.file.Path |
resolveFile(java.lang.String remotePath) |
protected java.util.NavigableMap<java.lang.String,java.lang.Object> |
resolveFileAttributes(java.nio.file.Path file,
int flags,
java.nio.file.LinkOption... options) |
protected java.util.NavigableMap<java.lang.String,java.lang.Object> |
resolveMissingFileAttributes(java.nio.file.Path file,
int flags,
java.util.Map<java.lang.String,java.lang.Object> current,
java.nio.file.LinkOption... options)
Called by
getAttributes(Path, int, LinkOption...) in order to complete any attributes that could not be
retrieved via the supported file system views. |
protected java.lang.Object |
resolveMissingFileAttributeValue(java.nio.file.Path file,
java.lang.String name,
java.lang.Object value,
FileInfoExtractor<?> x,
java.nio.file.LinkOption... options) |
protected java.lang.String |
resolveNewlineValue(ServerSession session) |
protected java.nio.file.Path |
resolveNormalizedLocation(java.lang.String remotePath) |
protected java.util.List<AbstractOpenSSHExtensionParser.OpenSSHExtension> |
resolveOpenSSHExtensions(ServerSession session) |
protected boolean |
resolvePathResolutionFollowLinks(int cmd,
java.lang.String extension,
java.nio.file.Path path) |
protected abstract void |
send(Buffer buffer) |
protected void |
sendAttrs(Buffer buffer,
int id,
java.util.Map<java.lang.String,?> attributes) |
protected void |
sendHandle(Buffer buffer,
int id,
java.lang.String handle) |
protected void |
sendLink(Buffer buffer,
int id,
java.lang.String link) |
protected void |
sendPath(Buffer buffer,
int id,
java.nio.file.Path f,
java.util.Map<java.lang.String,?> attrs) |
protected void |
sendStatus(Buffer buffer,
int id,
int substatus,
java.lang.String msg) |
protected void |
sendStatus(Buffer buffer,
int id,
int substatus,
java.lang.String msg,
java.lang.String lang) |
protected void |
sendStatus(Buffer buffer,
int id,
java.lang.Throwable e,
int cmd,
java.lang.Object... args)
Invoked when an exception was thrown due to the execution of some SFTP command
|
protected void |
setFileAccessControl(java.nio.file.Path file,
java.util.List<java.nio.file.attribute.AclEntry> acl,
java.nio.file.LinkOption... options) |
protected void |
setFileAttribute(java.nio.file.Path file,
java.lang.String view,
java.lang.String attribute,
java.lang.Object value,
java.nio.file.LinkOption... options) |
protected void |
setFileAttributes(java.nio.file.Path file,
java.util.Map<java.lang.String,?> attributes,
java.nio.file.LinkOption... options) |
protected void |
setFileExtensions(java.nio.file.Path file,
java.util.Map<java.lang.String,byte[]> extensions,
java.nio.file.LinkOption... options) |
protected void |
setFileOwnership(java.nio.file.Path file,
java.lang.String attribute,
java.security.Principal value,
java.nio.file.LinkOption... options) |
protected void |
setFilePermissions(java.nio.file.Path file,
java.util.Set<java.nio.file.attribute.PosixFilePermission> perms,
java.nio.file.LinkOption... options) |
protected void |
setFileRawViewAttribute(java.nio.file.Path file,
java.lang.String view,
java.lang.String attribute,
java.lang.Object value,
java.nio.file.LinkOption... options) |
protected void |
setFileTime(java.nio.file.Path file,
java.lang.String view,
java.lang.String attribute,
java.nio.file.attribute.FileTime value,
java.nio.file.LinkOption... options) |
protected <E extends java.io.IOException> |
signalOpenFailure(int id,
java.lang.String pathValue,
java.nio.file.Path path,
boolean isDir,
E thrown) |
protected <E extends java.io.IOException> |
signalRemovalPreConditionFailure(int id,
java.lang.String pathValue,
java.nio.file.Path path,
E thrown,
boolean isRemoveDirectory) |
protected java.nio.file.attribute.GroupPrincipal |
toGroup(java.nio.file.Path file,
java.nio.file.attribute.GroupPrincipal name) |
protected java.nio.file.attribute.UserPrincipal |
toUser(java.nio.file.Path file,
java.nio.file.attribute.UserPrincipal name) |
protected <H extends Handle> |
validateHandle(java.lang.String handle,
Handle h,
java.lang.Class<H> type)
Makes sure that the local handle is not null and of the specified type
|
protected java.lang.Boolean |
validateProposedVersion(Buffer buffer,
int id,
java.lang.String proposal) |
protected java.util.AbstractMap.SimpleImmutableEntry<java.nio.file.Path,java.lang.Boolean> |
validateRealPath(int id,
java.lang.String path,
java.nio.file.Path f,
java.nio.file.LinkOption... options) |
protected void |
writeAttrs(Buffer buffer,
java.util.Map<java.lang.String,?> attributes) |
protected void |
writeDirEntry(int id,
DirectoryHandle dir,
java.util.Map<java.lang.String,java.nio.file.Path> entries,
Buffer buffer,
int index,
java.nio.file.Path f,
java.lang.String shortName,
java.nio.file.LinkOption... options) |
getSimplifiedLogger
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getDefaultDirectory, getSession, getVersion
getSessionContext
getServerSession
public static final java.lang.String AUTO_FOLLOW_LINKS
DEFAULT_AUTO_FOLLOW_LINKS
,
Constant Field Valuespublic static final boolean DEFAULT_AUTO_FOLLOW_LINKS
public static final java.lang.String CLIENT_EXTENSIONS_PROP
executeExtendedCommand(Buffer, int, String)
command accordingly. If empty string is set then no server
extensions are reportedpublic static final java.util.NavigableMap<java.lang.String,OptionalFeature> DEFAULT_SUPPORTED_CLIENT_EXTENSIONS
public static final java.lang.String OPENSSH_EXTENSIONS_PROP
OpenSSH
extensions are reported and what version is reported for each -
format: name=version
. If empty value set, then no such extensions are reported. Otherwise, the
DEFAULT_OPEN_SSH_EXTENSIONS
are usedpublic static final java.util.List<AbstractOpenSSHExtensionParser.OpenSSHExtension> DEFAULT_OPEN_SSH_EXTENSIONS
public static final java.util.List<java.lang.String> DEFAULT_OPEN_SSH_EXTENSIONS_NAMES
public static final java.lang.String ACL_SUPPORTED_MASK_PROP
SSH_ACL_CAP_xxx
names - where name can be without the prefix. If not defined then
DEFAULT_ACL_SUPPORTED_MASK
is usedpublic static final java.util.Set<java.lang.Integer> DEFAULT_ACL_SUPPORTED_MASK
public static final java.lang.String NEWLINE_VALUE
IoUtils.EOL
is usedpublic static final java.lang.String MAX_READDATA_PACKET_LENGTH_PROP
doRead(Buffer, int)
protection against malicious packetspublic static final int DEFAULT_MAX_READDATA_PACKET_LENGTH
private final UnsupportedAttributePolicy unsupportedAttributePolicy
private final java.util.Collection<SftpEventListener> sftpEventListeners
private final SftpEventListener sftpEventListenerProxy
private final SftpFileSystemAccessor fileSystemAccessor
private final SftpErrorStatusDataHandler errorStatusDataHandler
protected AbstractSftpSubsystemHelper(UnsupportedAttributePolicy policy, SftpFileSystemAccessor accessor, SftpErrorStatusDataHandler handler)
public UnsupportedAttributePolicy getUnsupportedAttributePolicy()
getUnsupportedAttributePolicy
in interface SftpSubsystemEnvironment
public SftpFileSystemAccessor getFileSystemAccessor()
getFileSystemAccessor
in interface SftpSubsystemEnvironment
SftpFileSystemAccessor
used to access effective server-side pathspublic SftpEventListener getSftpEventListenerProxy()
getSftpEventListenerProxy
in interface SftpEventListenerManager
public boolean addSftpEventListener(SftpEventListener listener)
SftpEventListenerManager
addSftpEventListener
in interface SftpEventListenerManager
listener
- The SftpEventListener
instance to add - never null
true
if listener is a previously un-registered onepublic boolean removeSftpEventListener(SftpEventListener listener)
SftpEventListenerManager
removeSftpEventListener
in interface SftpEventListenerManager
listener
- The SftpEventListener
instance to remove - never null
true
if listener is a (removed) registered onepublic SftpErrorStatusDataHandler getErrorStatusDataHandler()
protected java.lang.Boolean validateProposedVersion(Buffer buffer, int id, java.lang.String proposal) throws java.io.IOException
buffer
- The Buffer
holding the requestid
- The request idproposal
- The proposed valueBoolean
indicating whether to accept/reject the proposal. If null
then
rejection response has been sent, otherwise and appropriate response is generatedjava.io.IOException
- If failed send an independent rejection responseprotected java.util.Map.Entry<java.lang.Integer,java.lang.String> checkVersionCompatibility(Buffer buffer, int id, int proposed, int failureOpcode) throws java.io.IOException
SftpSubsystemEnvironment.SFTP_VERSION
property, then it is used to validate the proposed valuebuffer
- The Buffer
containing the requestid
- The SSH message ID to be used to send the failure message if requiredproposed
- The proposed version valuefailureOpcode
- The failure opcode to send if validation failsString
of comma
separated values representing all the supported versions. null
if validation failed
and an appropriate status message was sentjava.io.IOException
- If failed to send the failure status messageprotected void process(Buffer buffer) throws java.io.IOException
buffer
- the buffer to processjava.io.IOException
- if anything wrong happensprotected void doProcess(Buffer buffer, int length, int type, int id) throws java.io.IOException
java.io.IOException
protected void doUnsupported(Buffer buffer, int length, int type, int id) throws java.io.IOException
java.io.IOException
protected abstract void doInit(Buffer buffer, int id) throws java.io.IOException
java.io.IOException
protected void doVersionSelect(Buffer buffer, int id) throws java.io.IOException
java.io.IOException
protected abstract void doVersionSelect(Buffer buffer, int id, java.lang.String proposed) throws java.io.IOException
java.io.IOException
protected void doOpen(Buffer buffer, int id) throws java.io.IOException
java.io.IOException
protected abstract java.lang.String doOpen(int id, java.lang.String path, int pflags, int access, java.util.Map<java.lang.String,java.lang.Object> attrs) throws java.io.IOException
id
- Request idpath
- Pathpflags
- Open mode flags - see SSH_FXF_XXX
flagsaccess
- Access mode flags - see ACE4_XXX
flagsattrs
- Requested attributesjava.io.IOException
- if failed to executeprotected <E extends java.io.IOException> E signalOpenFailure(int id, java.lang.String pathValue, java.nio.file.Path path, boolean isDir, E thrown) throws java.io.IOException
java.io.IOException
protected void doClose(Buffer buffer, int id) throws java.io.IOException
java.io.IOException
protected abstract void doClose(int id, java.lang.String handle) throws java.io.IOException
java.io.IOException
protected void doRead(Buffer buffer, int id) throws java.io.IOException
java.io.IOException
protected abstract int doRead(int id, java.lang.String handle, long offset, int length, byte[] data, int doff) throws java.io.IOException
java.io.IOException
protected void doWrite(Buffer buffer, int id) throws java.io.IOException
java.io.IOException
protected abstract void doWrite(int id, java.lang.String handle, long offset, int length, byte[] data, int doff, int remaining) throws java.io.IOException
java.io.IOException
protected void doLStat(Buffer buffer, int id) throws java.io.IOException
java.io.IOException
protected java.util.Map<java.lang.String,java.lang.Object> doLStat(int id, java.lang.String path, int flags) throws java.io.IOException
java.io.IOException
protected void doSetStat(Buffer buffer, int id, java.lang.String extension, int cmd, java.lang.Boolean followLinks) throws java.io.IOException
java.io.IOException
protected void doSetStat(int id, java.lang.String path, int cmd, java.lang.String extension, java.util.Map<java.lang.String,?> attrs, java.lang.Boolean followLinks) throws java.io.IOException
java.io.IOException
protected void doFStat(Buffer buffer, int id) throws java.io.IOException
java.io.IOException
protected abstract java.util.Map<java.lang.String,java.lang.Object> doFStat(int id, java.lang.String handle, int flags) throws java.io.IOException
java.io.IOException
protected void doFSetStat(Buffer buffer, int id) throws java.io.IOException
java.io.IOException
protected abstract void doFSetStat(int id, java.lang.String handle, java.util.Map<java.lang.String,?> attrs) throws java.io.IOException
java.io.IOException
protected void doOpenDir(Buffer buffer, int id) throws java.io.IOException
java.io.IOException
protected abstract java.lang.String doOpenDir(int id, java.lang.String path, java.nio.file.Path p, java.nio.file.LinkOption... options) throws java.io.IOException
java.io.IOException
protected abstract void doReadDir(Buffer buffer, int id) throws java.io.IOException
java.io.IOException
protected void doLink(Buffer buffer, int id) throws java.io.IOException
java.io.IOException
protected void doLink(int id, java.lang.String targetPath, java.lang.String linkPath, boolean symLink) throws java.io.IOException
java.io.IOException
protected void doSymLink(Buffer buffer, int id) throws java.io.IOException
java.io.IOException
protected void doSymLink(int id, java.lang.String targetPath, java.lang.String linkPath) throws java.io.IOException
java.io.IOException
protected abstract void createLink(int id, java.lang.String existingPath, java.lang.String linkPath, boolean symLink) throws java.io.IOException
java.io.IOException
protected void doOpenSSHHardLink(Buffer buffer, int id) throws java.io.IOException
java.io.IOException
protected void doOpenSSHHardLink(int id, java.lang.String srcFile, java.lang.String dstFile) throws java.io.IOException
java.io.IOException
protected void doSpaceAvailable(Buffer buffer, int id) throws java.io.IOException
java.io.IOException
protected SpaceAvailableExtensionInfo doSpaceAvailable(int id, java.lang.String path) throws java.io.IOException
java.io.IOException
protected void doTextSeek(Buffer buffer, int id) throws java.io.IOException
java.io.IOException
protected abstract void doTextSeek(int id, java.lang.String handle, long line) throws java.io.IOException
java.io.IOException
protected void doOpenSSHFsync(Buffer buffer, int id) throws java.io.IOException
java.io.IOException
protected abstract void doOpenSSHFsync(int id, java.lang.String handle) throws java.io.IOException
java.io.IOException
protected void doCheckFileHash(Buffer buffer, int id, java.lang.String targetType) throws java.io.IOException
java.io.IOException
protected void doCheckFileHash(int id, java.nio.file.Path file, NamedFactory<? extends Digest> factory, long startOffset, long length, int blockSize, Buffer buffer) throws java.lang.Exception
java.lang.Exception
protected void doMD5Hash(Buffer buffer, int id, java.lang.String targetType) throws java.io.IOException
java.io.IOException
protected abstract byte[] doMD5Hash(int id, java.lang.String targetType, java.lang.String target, long startOffset, long length, byte[] quickCheckHash) throws java.lang.Exception
java.lang.Exception
protected byte[] doMD5Hash(int id, java.nio.file.Path path, long startOffset, long length, byte[] quickCheckHash) throws java.lang.Exception
java.lang.Exception
protected abstract void doCheckFileHash(int id, java.lang.String targetType, java.lang.String target, java.util.Collection<java.lang.String> algos, long startOffset, long length, int blockSize, Buffer buffer) throws java.lang.Exception
java.lang.Exception
protected void doReadLink(Buffer buffer, int id) throws java.io.IOException
java.io.IOException
protected java.lang.String doReadLink(int id, java.lang.String path) throws java.io.IOException
java.io.IOException
protected void doRename(Buffer buffer, int id) throws java.io.IOException
java.io.IOException
protected void doRename(int id, java.lang.String oldPath, java.lang.String newPath, int flags) throws java.io.IOException
java.io.IOException
protected void doRename(int id, java.lang.String oldPath, java.lang.String newPath, java.util.Collection<java.nio.file.CopyOption> opts) throws java.io.IOException
java.io.IOException
protected void doCopyData(Buffer buffer, int id) throws java.io.IOException
java.io.IOException
protected abstract void doCopyData(int id, java.lang.String readHandle, long readOffset, long readLength, java.lang.String writeHandle, long writeOffset) throws java.io.IOException
java.io.IOException
protected void doCopyFile(Buffer buffer, int id) throws java.io.IOException
java.io.IOException
protected void doCopyFile(int id, java.lang.String srcFile, java.lang.String dstFile, boolean overwriteDestination) throws java.io.IOException
java.io.IOException
protected void doCopyFile(int id, java.lang.String srcFile, java.lang.String dstFile, java.util.Collection<java.nio.file.CopyOption> opts) throws java.io.IOException
java.io.IOException
protected void doBlock(Buffer buffer, int id) throws java.io.IOException
java.io.IOException
protected abstract void doBlock(int id, java.lang.String handle, long offset, long length, int mask) throws java.io.IOException
java.io.IOException
protected void doUnblock(Buffer buffer, int id) throws java.io.IOException
java.io.IOException
protected abstract void doUnblock(int id, java.lang.String handle, long offset, long length) throws java.io.IOException
java.io.IOException
protected void doStat(Buffer buffer, int id) throws java.io.IOException
java.io.IOException
protected java.util.Map<java.lang.String,java.lang.Object> doStat(int id, java.lang.String path, int flags) throws java.io.IOException
java.io.IOException
protected void doRealPath(Buffer buffer, int id) throws java.io.IOException
java.io.IOException
protected java.util.AbstractMap.SimpleImmutableEntry<java.nio.file.Path,java.lang.Boolean> doRealPathV6(int id, java.lang.String path, java.util.Collection<java.lang.String> extraPaths, java.nio.file.Path p, java.nio.file.LinkOption... options) throws java.io.IOException
java.io.IOException
protected java.util.AbstractMap.SimpleImmutableEntry<java.nio.file.Path,java.lang.Boolean> doRealPathV345(int id, java.lang.String path, java.nio.file.Path p, java.nio.file.LinkOption... options) throws java.io.IOException
java.io.IOException
protected java.util.AbstractMap.SimpleImmutableEntry<java.nio.file.Path,java.lang.Boolean> validateRealPath(int id, java.lang.String path, java.nio.file.Path f, java.nio.file.LinkOption... options) throws java.io.IOException
id
- The request identifierpath
- The original pathf
- The resolve Path
options
- The LinkOption
s to use to verify file existence and accessAbstractMap.SimpleImmutableEntry
whose key is the absolute normalized
Path
and value is a Boolean
indicating its statusjava.io.IOException
- If failed to validate the fileIoUtils.checkFileExists(Path, LinkOption...)
protected void doRemoveDirectory(Buffer buffer, int id) throws java.io.IOException
java.io.IOException
protected void doRemoveDirectory(int id, java.lang.String path, java.nio.file.LinkOption... options) throws java.io.IOException
java.io.IOException
protected void doRemove(int id, java.nio.file.Path p, boolean isDirectory) throws java.io.IOException
SftpEventListener
id
- Deletion request IDp
- Path
to deleteisDirectory
- Whether the requested path represents a directory or a regular filejava.io.IOException
- If failed to deleteprotected void doMakeDirectory(Buffer buffer, int id) throws java.io.IOException
java.io.IOException
protected void doMakeDirectory(int id, java.lang.String path, java.util.Map<java.lang.String,?> attrs, java.nio.file.LinkOption... options) throws java.io.IOException
java.io.IOException
protected void doRemove(Buffer buffer, int id) throws java.io.IOException
java.io.IOException
protected void doRemove(int id, java.lang.String path, java.nio.file.LinkOption... options) throws java.io.IOException
java.io.IOException
protected <E extends java.io.IOException> E signalRemovalPreConditionFailure(int id, java.lang.String pathValue, java.nio.file.Path path, E thrown, boolean isRemoveDirectory) throws java.io.IOException
java.io.IOException
protected void doExtended(Buffer buffer, int id) throws java.io.IOException
java.io.IOException
protected void executeExtendedCommand(Buffer buffer, int id, java.lang.String extension) throws java.io.IOException
buffer
- The command Buffer
id
- The request idextension
- The extension namejava.io.IOException
- If failed to execute the extensionprotected void doUnsupportedExtension(Buffer buffer, int id, java.lang.String extension) throws java.io.IOException
java.io.IOException
protected void appendExtensions(Buffer buffer, java.lang.String supportedVersions)
protected int appendAclSupportedExtension(Buffer buffer, ServerSession session)
protected java.util.Collection<java.lang.Integer> resolveAclSupportedCapabilities(ServerSession session)
protected java.util.List<AbstractOpenSSHExtensionParser.OpenSSHExtension> appendOpenSSHExtensions(Buffer buffer, ServerSession session)
protected java.util.List<AbstractOpenSSHExtensionParser.OpenSSHExtension> resolveOpenSSHExtensions(ServerSession session)
protected java.util.Map<java.lang.String,OptionalFeature> getSupportedClientExtensions(ServerSession session)
protected void appendVersionsExtension(Buffer buffer, java.lang.String value, ServerSession session)
buffer
- The Buffer
to append tovalue
- The recommended value - ignored if null
/emptysession
- The ServerSession
for which this extension is addedSftpConstants.EXT_VERSIONS
protected void appendNewlineExtension(Buffer buffer, ServerSession session)
buffer
- The Buffer
to append tosession
- The ServerSession
for which this extension is addedSftpConstants.EXT_NEWLINE
,
resolveNewlineValue(ServerSession)
protected java.lang.String resolveNewlineValue(ServerSession session)
protected void appendVendorIdExtension(Buffer buffer, java.util.Map<java.lang.String,?> versionProperties, ServerSession session)
buffer
- The Buffer
to append toversionProperties
- The currently available version properties - ignored if null
/empty. The code
expects the following values:
groupId
- as the vendor nameartifactId
- as the product nameversion
- as the product versionsession
- The ServerSession
for which these properties are addedSftpConstants.EXT_VENDOR_ID
,
DRAFT
09 - section 4.4protected void appendSupportedExtension(Buffer buffer, java.util.Collection<java.lang.String> extras)
buffer
- The Buffer
to append toextras
- The extra extensions that are available and can be reported - may be null
/emptyprotected void appendSupported2Extension(Buffer buffer, java.util.Collection<java.lang.String> extras)
buffer
- The Buffer
to append toextras
- The extra extensions that are available and can be reported - may be null
/emptySftpConstants.EXT_SUPPORTED
,
DRAFT 13 section 5.4protected void sendHandle(Buffer buffer, int id, java.lang.String handle) throws java.io.IOException
java.io.IOException
protected void sendAttrs(Buffer buffer, int id, java.util.Map<java.lang.String,?> attributes) throws java.io.IOException
java.io.IOException
protected void sendLink(Buffer buffer, int id, java.lang.String link) throws java.io.IOException
java.io.IOException
protected void sendPath(Buffer buffer, int id, java.nio.file.Path f, java.util.Map<java.lang.String,?> attrs) throws java.io.IOException
java.io.IOException
protected int doReadDir(int id, java.lang.String handle, DirectoryHandle dir, Buffer buffer, int maxSize, java.nio.file.LinkOption... options) throws java.io.IOException
id
- Request idhandle
- The (opaque) handle assigned to this directorydir
- The DirectoryHandle
buffer
- The Buffer
to write the resultsmaxSize
- Max. buffer sizeoptions
- The LinkOption
-s to use when querying the directory contentsjava.io.IOException
- If failed to generate an entryprotected void writeDirEntry(int id, DirectoryHandle dir, java.util.Map<java.lang.String,java.nio.file.Path> entries, Buffer buffer, int index, java.nio.file.Path f, java.lang.String shortName, java.nio.file.LinkOption... options) throws java.io.IOException
id
- Request iddir
- The DirectoryHandle
entries
- An in / out Map
for updating the written entry - key = short name, value = entry
Path
buffer
- The Buffer
to write the resultsindex
- Zero-based index of the entry to be writtenf
- The entry Path
shortName
- The entry short nameoptions
- The LinkOption
s to use for querying the entry-s attributesjava.io.IOException
- If failed to generate the entry dataprotected java.lang.String getLongName(java.nio.file.Path f, java.lang.String shortName, java.nio.file.LinkOption... options) throws java.io.IOException
java.io.IOException
protected java.lang.String getLongName(java.nio.file.Path f, java.lang.String shortName, boolean sendAttrs, java.nio.file.LinkOption... options) throws java.io.IOException
java.io.IOException
protected java.lang.String getLongName(java.nio.file.Path f, java.lang.String shortName, java.util.Map<java.lang.String,?> attributes) throws java.io.IOException
java.io.IOException
protected java.lang.String getShortName(java.nio.file.Path f) throws java.io.IOException
java.io.IOException
protected java.util.NavigableMap<java.lang.String,java.lang.Object> resolveFileAttributes(java.nio.file.Path file, int flags, java.nio.file.LinkOption... options) throws java.io.IOException
java.io.IOException
protected void writeAttrs(Buffer buffer, java.util.Map<java.lang.String,?> attributes) throws java.io.IOException
java.io.IOException
protected java.util.NavigableMap<java.lang.String,java.lang.Object> getAttributes(java.nio.file.Path file, java.nio.file.LinkOption... options) throws java.io.IOException
java.io.IOException
protected java.util.NavigableMap<java.lang.String,java.lang.Object> handleUnknownStatusFileAttributes(java.nio.file.Path file, int flags, java.nio.file.LinkOption... options) throws java.io.IOException
java.io.IOException
protected java.util.NavigableMap<java.lang.String,java.lang.Object> getAttributes(java.nio.file.Path file, int flags, java.nio.file.LinkOption... options) throws java.io.IOException
file
- The Path
location for the required attributesflags
- A mask of the original required attributes - ignored by the default implementationoptions
- The LinkOption
s to use in order to access the file if necessaryMap
of the retrieved attributesjava.io.IOException
- If failed to access the fileresolveMissingFileAttributes(Path, int, Map, LinkOption...)
protected java.util.NavigableMap<java.lang.String,java.lang.Object> resolveMissingFileAttributes(java.nio.file.Path file, int flags, java.util.Map<java.lang.String,java.lang.Object> current, java.nio.file.LinkOption... options) throws java.io.IOException
getAttributes(Path, int, LinkOption...)
in order to complete any attributes that could not be
retrieved via the supported file system views. These attributes are deemed important so an extra effort is made
to provide a value for themfile
- The Path
location for the required attributesflags
- A mask of the original required attributes - ignored by the default implementationcurrent
- The Map
of attributes already retrieved - may be null
/empty and/or
unmodifiableoptions
- The LinkOption
s to use in order to access the file if necessaryMap
of the extra attributes whose values need to be updated in the original map.
Note: it is allowed to specify values which override existing ones - the
default implementation does not override values that have a non-null
valuejava.io.IOException
- If failed to access the attributes - in which case an error is returned to the SFTP
clientSftpFileSystemAccessor.FILEATTRS_RESOLVERS
protected java.lang.Object resolveMissingFileAttributeValue(java.nio.file.Path file, java.lang.String name, java.lang.Object value, FileInfoExtractor<?> x, java.nio.file.LinkOption... options) throws java.io.IOException
java.io.IOException
protected java.util.NavigableMap<java.lang.String,java.lang.Object> addMissingAttribute(java.nio.file.Path file, java.util.NavigableMap<java.lang.String,java.lang.Object> current, java.lang.String name, FileInfoExtractor<?> x, java.nio.file.LinkOption... options) throws java.io.IOException
java.io.IOException
protected java.util.NavigableMap<java.lang.String,java.lang.Object> readFileAttributes(java.nio.file.Path file, java.lang.String view, java.nio.file.LinkOption... options) throws java.io.IOException
java.io.IOException
protected java.util.NavigableMap<java.lang.String,java.lang.Object> handleReadFileAttributesException(java.nio.file.Path file, java.lang.String view, java.nio.file.LinkOption[] options, java.io.IOException e) throws java.io.IOException
java.io.IOException
protected void doSetAttributes(java.nio.file.Path file, java.util.Map<java.lang.String,?> attributes, boolean followLinks) throws java.io.IOException
java.io.IOException
protected java.nio.file.LinkOption[] getPathResolutionLinkOption(int cmd, java.lang.String extension, java.nio.file.Path path) throws java.io.IOException
java.io.IOException
protected boolean resolvePathResolutionFollowLinks(int cmd, java.lang.String extension, java.nio.file.Path path) throws java.io.IOException
java.io.IOException
protected void setFileAttributes(java.nio.file.Path file, java.util.Map<java.lang.String,?> attributes, java.nio.file.LinkOption... options) throws java.io.IOException
java.io.IOException
protected void handleSetFileAttributeFailure(java.nio.file.Path file, java.lang.String view, java.lang.String attribute, java.lang.Object value, java.util.Collection<java.lang.String> unsupported, java.lang.Exception e) throws java.io.IOException
java.io.IOException
protected void setFileAttribute(java.nio.file.Path file, java.lang.String view, java.lang.String attribute, java.lang.Object value, java.nio.file.LinkOption... options) throws java.io.IOException
java.io.IOException
protected void setFileTime(java.nio.file.Path file, java.lang.String view, java.lang.String attribute, java.nio.file.attribute.FileTime value, java.nio.file.LinkOption... options) throws java.io.IOException
java.io.IOException
protected void setFileRawViewAttribute(java.nio.file.Path file, java.lang.String view, java.lang.String attribute, java.lang.Object value, java.nio.file.LinkOption... options) throws java.io.IOException
java.io.IOException
protected void setFileOwnership(java.nio.file.Path file, java.lang.String attribute, java.security.Principal value, java.nio.file.LinkOption... options) throws java.io.IOException
java.io.IOException
protected void setFileExtensions(java.nio.file.Path file, java.util.Map<java.lang.String,byte[]> extensions, java.nio.file.LinkOption... options) throws java.io.IOException
java.io.IOException
protected void setFilePermissions(java.nio.file.Path file, java.util.Set<java.nio.file.attribute.PosixFilePermission> perms, java.nio.file.LinkOption... options) throws java.io.IOException
java.io.IOException
protected void setFileAccessControl(java.nio.file.Path file, java.util.List<java.nio.file.attribute.AclEntry> acl, java.nio.file.LinkOption... options) throws java.io.IOException
java.io.IOException
protected void handleUnsupportedAttributes(java.util.Collection<java.lang.String> attributes)
protected java.nio.file.attribute.GroupPrincipal toGroup(java.nio.file.Path file, java.nio.file.attribute.GroupPrincipal name) throws java.io.IOException
java.io.IOException
protected java.nio.file.attribute.UserPrincipal toUser(java.nio.file.Path file, java.nio.file.attribute.UserPrincipal name) throws java.io.IOException
java.io.IOException
protected void handleUserPrincipalLookupServiceException(java.lang.Class<? extends java.security.Principal> principalType, java.lang.String name, java.io.IOException e) throws java.io.IOException
java.io.IOException
protected java.util.Map<java.lang.String,java.lang.Object> readAttrs(Buffer buffer) throws java.io.IOException
java.io.IOException
protected <H extends Handle> H validateHandle(java.lang.String handle, Handle h, java.lang.Class<H> type) throws java.io.IOException
H
- The generic handle typehandle
- The original handle idh
- The resolved Handle
instancetype
- The expected handle typejava.io.IOException
- If a generic exception occurredjava.io.FileNotFoundException
- If the handle instance is null
InvalidHandleException
- If the handle instance is not of the expected typeprotected void sendStatus(Buffer buffer, int id, java.lang.Throwable e, int cmd, java.lang.Object... args) throws java.io.IOException
buffer
- A Buffer
to be used to build the status replyid
- Command identifiere
- Thrown exceptioncmd
- The command that was attemptedargs
- The relevant command arguments - Note: provided only for logging purposes and
subject to type and/or order change at any versionjava.io.IOException
- If failed to build and send the status bufferprotected void sendStatus(Buffer buffer, int id, int substatus, java.lang.String msg) throws java.io.IOException
java.io.IOException
protected void sendStatus(Buffer buffer, int id, int substatus, java.lang.String msg, java.lang.String lang) throws java.io.IOException
java.io.IOException
protected abstract void send(Buffer buffer) throws java.io.IOException
java.io.IOException
protected java.nio.file.Path resolveNormalizedLocation(java.lang.String remotePath) throws java.io.IOException, java.nio.file.InvalidPathException
java.io.IOException
java.nio.file.InvalidPathException
protected java.nio.file.Path normalize(java.nio.file.Path f)
protected java.nio.file.Path resolveFile(java.lang.String remotePath) throws java.io.IOException, java.nio.file.InvalidPathException
remotePath
- The remote path - separated by '/'Path
java.io.IOException
- If failed to resolve the local pathjava.nio.file.InvalidPathException
- If bad local path specification