Package org.apache.sshd.contrib.server.subsystem.sftp

Class SimpleAccessControlSftpEventListener

java.lang.Object

org.apache.sshd.common.util.logging.AbstractLoggingBean

org.apache.sshd.sftp.server.AbstractSftpEventListenerAdapter

org.apache.sshd.contrib.server.subsystem.sftp.SimpleAccessControlSftpEventListener

All Implemented Interfaces:

EventListener, SshdEventListener, SftpEventListener

public abstract class SimpleAccessControlSftpEventListener
extends AbstractSftpEventListenerAdapter

Provides a simple access control by making a distinction between methods that provide information - including reading data - and those that modify it

Field Summary

Fields

Modifier and Type	Field	Description
static final SimpleAccessControlSftpEventListener	READ_ONLY_ACCESSOR

Fields inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

log

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SimpleAccessControlSftpEventListener()

Method Summary

Modifier and Type	Method	Description
void	blocking(ServerSession session, String remoteHandle, FileHandle localHandle, long offset, long length, int mask)	Called prior to blocking a file section
void	creating(ServerSession session, Path path, Map<String,?> attrs)	Called prior to creating a directory
protected abstract boolean	isAccessAllowed(ServerSession session, String remoteHandle, Path localPath)
protected boolean	isAccessAllowed(ServerSession session, String remoteHandle, Handle localHandle)
protected abstract boolean	isModificationAllowed(ServerSession session, String remoteHandle, Path localPath)
void	linking(ServerSession session, Path source, Path target, boolean symLink)	Called prior to creating a link
void	modifyingAttributes(ServerSession session, Path path, Map<String,?> attrs)	Called prior to modifying the attributes of a file / directory
void	moving(ServerSession session, Path srcPath, Path dstPath, Collection<CopyOption> opts)	Called prior to renaming a file / directory
void	opening(ServerSession session, String remoteHandle, Handle localHandle)	Specified file / directory is being opened
void	readEntries(ServerSession session, String remoteHandle, DirectoryHandle localHandle, Map<String,Path> entries)	Result of reading entries from a directory - Note: it may be a partial result if the directory contains more entries than can be accommodated in the response
void	reading(ServerSession session, String remoteHandle, FileHandle localHandle, long offset, byte[] data, int dataOffset, int dataLen)	Preparing to read from a file
void	removed(ServerSession session, Path path, boolean isDirectory, Throwable thrown)	Called after a file has been removed
void	removing(ServerSession session, Path path, boolean isDirectory)	Called prior to removing a file
void	unblocking(ServerSession session, String remoteHandle, FileHandle localHandle, long offset, long length)	Called prior to un-blocking a file section
void	writing(ServerSession session, String remoteHandle, FileHandle localHandle, long offset, byte[] data, int dataOffset, int dataLen)	Preparing to write to file

Methods inherited from class org.apache.sshd.sftp.server.AbstractSftpEventListenerAdapter

blocked, closed, closing, created, destroying, exiting, initialized, linked, modifiedAttributes, moved, open, openFailed, read, readingEntries, receivedExtension, unblocked, written

Methods inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

debug, debug, debug, debug, debug, error, error, error, error, error, getSimplifiedLogger, info, info, warn, warn, warn, warn, warn, warn, warn, warn

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.sftp.server.SftpEventListener

received

Field Details

READ_ONLY_ACCESSOR

public static final SimpleAccessControlSftpEventListener READ_ONLY_ACCESSOR

Constructor Details

SimpleAccessControlSftpEventListener

protected SimpleAccessControlSftpEventListener()

Method Details

opening

public void opening(ServerSession session,
 String remoteHandle,
 Handle localHandle)
             throws IOException

Description copied from interface: SftpEventListener

Specified file / directory is being opened

Specified by:

opening in interface SftpEventListener

Overrides:

opening in class AbstractSftpEventListenerAdapter

Parameters:

session - The ServerSession through which the request was handled

remoteHandle - The (opaque) assigned handle for the file / directory

localHandle - The associated file / directory Handle

Throws:

IOException - If failed to handle the call

readEntries

public void readEntries(ServerSession session,
 String remoteHandle,
 DirectoryHandle localHandle,
 Map<String,Path> entries)
                 throws IOException

Description copied from interface: SftpEventListener

Result of reading entries from a directory - Note: it may be a partial result if the directory contains more entries than can be accommodated in the response

Specified by:

readEntries in interface SftpEventListener

Overrides:

readEntries in class AbstractSftpEventListenerAdapter

Parameters:

session - The ServerSession through which the request was handled

remoteHandle - The (opaque) assigned handle for the directory

localHandle - The associated DirectoryHandle

entries - A Map of the listed entries - key = short name, value = Path of the sub-entry

Throws:

IOException - If failed to handle the call

reading

public void reading(ServerSession session,
 String remoteHandle,
 FileHandle localHandle,
 long offset,
 byte[] data,
 int dataOffset,
 int dataLen)
             throws IOException

Description copied from interface: SftpEventListener

Preparing to read from a file

Specified by:

reading in interface SftpEventListener

Overrides:

reading in class AbstractSftpEventListenerAdapter

Parameters:

session - The ServerSession through which the request was handled

remoteHandle - The (opaque) assigned handle for the file

localHandle - The associated FileHandle

offset - Offset in file from which to read

data - Buffer holding the read data

dataOffset - Offset of read data in buffer

dataLen - Requested read length

Throws:

IOException - If failed to handle the call

isAccessAllowed

protected boolean isAccessAllowed(ServerSession session,
 String remoteHandle,
 Handle localHandle)
                           throws IOException

Parameters:

session - The ServerSession throw which the request was made

remoteHandle - The remote handle value

localHandle - The local handle

Returns:

true if allowed to access the handle

Throws:

IOException - If failed to handle the call

isAccessAllowed

protected abstract boolean isAccessAllowed(ServerSession session,
 String remoteHandle,
 Path localPath)
                                    throws IOException

Parameters:

session - The ServerSession throw which the request was made

remoteHandle - The remote handle value

localPath - The local Path

Returns:

true if allowed to access the path

Throws:

IOException - If failed to handle the call

writing

public void writing(ServerSession session,
 String remoteHandle,
 FileHandle localHandle,
 long offset,
 byte[] data,
 int dataOffset,
 int dataLen)
             throws IOException

Description copied from interface: SftpEventListener

Preparing to write to file

Specified by:

writing in interface SftpEventListener

Overrides:

writing in class AbstractSftpEventListenerAdapter

Parameters:

session - The ServerSession through which the request was handled

remoteHandle - The (opaque) assigned handle for the file

localHandle - The associated FileHandle

offset - Offset in file to which to write

data - Buffer holding the written data

dataOffset - Offset of write data in buffer

dataLen - Requested write length

Throws:

IOException - If failed to handle the call

blocking

public void blocking(ServerSession session,
 String remoteHandle,
 FileHandle localHandle,
 long offset,
 long length,
 int mask)
              throws IOException

Description copied from interface: SftpEventListener

Called prior to blocking a file section

Specified by:

blocking in interface SftpEventListener

Overrides:

blocking in class AbstractSftpEventListenerAdapter

Parameters:

session - The ServerSession through which the request was handled

remoteHandle - The (opaque) assigned handle for the file

localHandle - The associated FileHandle

offset - Offset in file for locking

length - Section size for locking

mask - Lock mask flags - see SSH_FXP_BLOCK message

Throws:

IOException - If failed to handle the call

See Also:

• SftpEventListener.blocked(ServerSession, String, FileHandle, long, long, int, Throwable)

unblocking

public void unblocking(ServerSession session,
 String remoteHandle,
 FileHandle localHandle,
 long offset,
 long length)
                throws IOException

Description copied from interface: SftpEventListener

Called prior to un-blocking a file section

Specified by:

unblocking in interface SftpEventListener

Overrides:

unblocking in class AbstractSftpEventListenerAdapter

Parameters:

session - The ServerSession through which the request was handled

remoteHandle - The (opaque) assigned handle for the file

localHandle - The associated FileHandle

offset - Offset in file for un-locking

length - Section size for un-locking

Throws:

IOException - If failed to handle the call

creating

public void creating(ServerSession session,
 Path path,
 Map<String,?> attrs)
              throws IOException

Description copied from interface: SftpEventListener

Called prior to creating a directory

Specified by:

creating in interface SftpEventListener

Overrides:

creating in class AbstractSftpEventListenerAdapter

Parameters:

session - The ServerSession through which the request was handled

path - Directory Path to be created

attrs - Requested associated attributes to set

Throws:

IOException - If failed to handle the call

See Also:

• SftpEventListener.created(ServerSession, Path, Map, Throwable)

moving

public void moving(ServerSession session,
 Path srcPath,
 Path dstPath,
 Collection<CopyOption> opts)
            throws IOException

Description copied from interface: SftpEventListener

Called prior to renaming a file / directory

Specified by:

moving in interface SftpEventListener

Overrides:

moving in class AbstractSftpEventListenerAdapter

Parameters:

session - The ServerSession through which the request was handled

srcPath - The source Path

dstPath - The target Path

opts - The resolved renaming options

Throws:

IOException - If failed to handle the call

See Also:

• SftpEventListener.moved(ServerSession, Path, Path, Collection, Throwable)

removing

public void removing(ServerSession session,
 Path path,
 boolean isDirectory)
              throws IOException

Description copied from interface: SftpEventListener

Called prior to removing a file

Specified by:

removing in interface SftpEventListener

Overrides:

removing in class AbstractSftpEventListenerAdapter

Parameters:

session - The ServerSession through which the request was handled

path - The Path about to be removed

isDirectory - Whether this is a folder or a file

Throws:

IOException - If failed to handle the call

See Also:

• SftpEventListener.removed(ServerSession, Path, boolean, Throwable)

removed

public void removed(ServerSession session,
 Path path,
 boolean isDirectory,
 Throwable thrown)
             throws IOException

Description copied from interface: SftpEventListener

Called after a file has been removed

Specified by:

removed in interface SftpEventListener

Overrides:

removed in class AbstractSftpEventListenerAdapter

Parameters:

session - The ServerSession through which the request was handled

path - The Path to be removed

isDirectory - Whether this was a folder or a file

thrown - If not-null then the reason for the failure to execute

Throws:

IOException - If failed to handle the call

linking

public void linking(ServerSession session,
 Path source,
 Path target,
 boolean symLink)
             throws IOException

Description copied from interface: SftpEventListener

Called prior to creating a link

Specified by:

linking in interface SftpEventListener

Overrides:

linking in class AbstractSftpEventListenerAdapter

Parameters:

session - The ServerSession through which the request was handled

source - The source Path

target - The target Path

symLink - true = symbolic link

Throws:

IOException - If failed to handle the call

See Also:

• SftpEventListener.linked(ServerSession, Path, Path, boolean, Throwable)

modifyingAttributes

public void modifyingAttributes(ServerSession session,
 Path path,
 Map<String,?> attrs)
                         throws IOException

Description copied from interface: SftpEventListener

Called prior to modifying the attributes of a file / directory

Specified by:

modifyingAttributes in interface SftpEventListener

Overrides:

modifyingAttributes in class AbstractSftpEventListenerAdapter

Parameters:

session - The ServerSession through which the request was handled

path - The file / directory Path to be modified

attrs - The attributes Map - names and values depend on the O/S, view, type, etc...

Throws:

IOException - If failed to handle the call

See Also:

• SftpEventListener.modifiedAttributes(ServerSession, Path, Map, Throwable)

isModificationAllowed

protected abstract boolean isModificationAllowed(ServerSession session,
 String remoteHandle,
 Path localPath)
                                          throws IOException

Parameters:

session - The ServerSession throw which the request was made

remoteHandle - The remote handle value

localPath - The local Path

Returns:

true if allowed to modify the path

Throws:

IOException - If failed to handle the call