Package org.apache.sshd.sftp.client.impl
Class AbstractSftpClient
java.lang.Object
org.apache.sshd.common.util.logging.AbstractLoggingBean
org.apache.sshd.client.subsystem.AbstractSubsystemClient
org.apache.sshd.sftp.client.impl.AbstractSftpClient
- All Implemented Interfaces:
Closeable,AutoCloseable,Channel,ClientChannelHolder,ClientSessionHolder,SubsystemClient,ChannelHolder,NamedResource,SessionContextHolder,SessionHolder<ClientSession>,FullAccessSftpClient,RawSftpClient,SftpClient,SftpErrorDataHandler
- Direct Known Subclasses:
DefaultSftpClient,SftpFileSystem.Wrapper
public abstract class AbstractSftpClient
extends AbstractSubsystemClient
implements FullAccessSftpClient, SftpErrorDataHandler
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.apache.sshd.sftp.client.SftpClient
SftpClient.Attribute, SftpClient.Attributes, SftpClient.CloseableHandle, SftpClient.CopyMode, SftpClient.DirEntry, SftpClient.Handle, SftpClient.OpenMode -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected final SftpErrorDataHandlerprivate final SftpClient.Attributesstatic final intprivate final AtomicReference<Map<String, Object>> Property that can be used on theFactoryManagerto control the internal timeout used by the client to complete the buffer sending inRawSftpClient.send(int, Buffer).Fields inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean
logFields inherited from interface org.apache.sshd.common.NamedResource
BY_NAME_COMPARATOR, NAME_EXTRACTORFields inherited from interface org.apache.sshd.sftp.client.SftpClient
DEFAULT_CHANNEL_MODES, EMPTY_DIR_ENTRIES, IO_BUFFER_SIZE, MIN_BUFFER_SIZE, MIN_READ_BUFFER_SIZE, MIN_WRITE_BUFFER_SIZEFields inherited from interface org.apache.sshd.sftp.client.SftpErrorDataHandler
EMPTY -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncanonicalPath(String path) The effective "normalized" remote pathprotected SftpClient.AttributescheckAttributes(int cmd, Buffer request) protected SftpClient.AttributescheckAttributesResponse(SftpResponse response) protected voidcheckCommandStatus(int cmd, Buffer request) Sends the specified command, waits for the response and then invokescheckResponseStatus(SftpResponse)protected intcheckData(int cmd, Buffer request, int dstOffset, byte[] dst, AtomicReference<Boolean> eofSignalled) protected intcheckDataResponse(SftpResponse response, int dstoff, byte[] dst, AtomicReference<Boolean> eofSignalled) protected List<SftpClient.DirEntry> checkDirResponse(SftpResponse response, AtomicReference<Boolean> eolIndicator) protected byte[]checkHandle(int cmd, Buffer request) protected byte[]checkHandleResponse(SftpResponse response) protected StringcheckOneName(int cmd, Buffer request) protected StringcheckOneNameResponse(SftpResponse response) protected voidcheckResponseStatus(int cmd, int id, SftpStatus status) protected voidcheckResponseStatus(SftpResponse response) Checks if the incoming response is anSSH_FXP_STATUSone, and if so whether the substatus isSSH_FX_OK.voidclose(SftpClient.Handle handle) Close the handle obtained from one of theopenmethodsvoiderrorData(byte[] buf, int start, int len) Receive binary data from server error stream<E extends SftpClientExtension>
EgetExtension(Class<? extends E> extensionType) getExtension(SftpClientExtensionFactory factory) getParsedServerExtensions(Map<String, byte[]> extensions) protected intprotected StringgetReferencedName(int cmd, Buffer buf, int nameIndex) protected intprotected SftpClient.AttributeshandleUnexpectedAttributesPacket(SftpResponse response) protected byte[]handleUnexpectedHandlePacket(SftpResponse response) protected IOExceptionhandleUnexpectedPacket(int expected, SftpResponse response) protected inthandleUnknownDataPacket(SftpResponse response) protected List<SftpClient.DirEntry> handleUnknownDirListingPacket(SftpResponse response) protected StringhandleUnknownOneNamePacket(SftpResponse response) voidCreate a linklistDir(SftpClient.Handle handle) voidlock(SftpClient.Handle handle, long offset, long length, int mask) Retrieve remote path meta-data - do not follow symbolic linksvoidCreate remote directoryopen(String path, Collection<SftpClient.OpenMode> options) Opens a remote file with the specified mode(s)Obtain a handle for a directoryopenRemoteFileChannel(String path, Collection<SftpClient.OpenMode> modes) Opens anFileChannelon the specified remote pathprotected <B extends Buffer>
BputReferencedName(int cmd, B buf, String name, int nameIndex) read(String path, int bufferSize, Collection<SftpClient.OpenMode> mode) Read a remote file's data via an input streamintread(SftpClient.Handle handle, long fileOffset, byte[] dst, int dstOffset, int len, AtomicReference<Boolean> eofSignalled) Reads data from the open (file) handleprotected SftpClient.AttributesreadAttributes(int cmd, Buffer buffer, AtomicInteger nameIndex) readDir(SftpClient.Handle handle, AtomicReference<Boolean> eolIndicator) Retrieve target of a linkvoidvoidrename(String oldPath, String newPath, Collection<SftpClient.CopyMode> options) protected SftpResponseresponse(int cmd, int requestId) Receives a response buffer, validates and returns it as aSftpResponse.voidRemove remote directoryprotected SftpResponsePerform an SFTP request and wait until the response has been received.voidsetStat(String path, SftpClient.Attributes attributes) Update remote node meta-datavoidsetStat(SftpClient.Handle handle, SftpClient.Attributes attributes) Update remote node meta-dataRetrieve remote path meta-data - follow symbolic links if encounteredstat(SftpClient.Handle handle) Retrieve file/directory handle meta-dataprotected voidthrowStatusException(int cmd, int id, SftpStatus status) voidunlock(SftpClient.Handle handle, long offset, long length) write(String path, int bufferSize, Collection<SftpClient.OpenMode> mode) Write to a remote file via an output streamvoidwrite(SftpClient.Handle handle, long fileOffset, byte[] src, int srcOffset, int len) Write data to (open) file handleprotected <B extends Buffer>
BwriteAttributes(int cmd, B buffer, SftpClient.Attributes attributes) Methods inherited from class org.apache.sshd.client.subsystem.AbstractSubsystemClient
toStringMethods 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, warnMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface org.apache.sshd.client.channel.ClientChannelHolder
getClientChannelMethods inherited from interface org.apache.sshd.client.session.ClientSessionHolder
getClientSessionMethods inherited from interface org.apache.sshd.sftp.client.RawSftpClient
receive, receive, receive, sendMethods inherited from interface org.apache.sshd.common.session.SessionHolder
getSessionContextMethods inherited from interface org.apache.sshd.sftp.client.SftpClient
getExtension, getName, getNameDecodingCharset, getServerExtensions, getVersion, isClosing, open, open, openRemoteFileChannel, openRemotePathChannel, openRemotePathChannel, read, read, read, read, read, read, read, read, readDir, readEntries, rename, rename, setNameDecodingCharset, singleSessionInstance, symLink, write, write, write, write, write, writeMethods inherited from interface org.apache.sshd.client.subsystem.SubsystemClient
getSession
-
Field Details
-
INIT_COMMAND_SIZE
public static final int INIT_COMMAND_SIZE- See Also:
-
SFTP_CLIENT_CMD_TIMEOUT
Property that can be used on theFactoryManagerto control the internal timeout used by the client to complete the buffer sending inRawSftpClient.send(int, Buffer). -
errorDataHandler
-
fileOpenAttributes
-
parsedExtensionsHolder
-
-
Constructor Details
-
AbstractSftpClient
-
-
Method Details
-
getChannel
- Specified by:
getChannelin interfaceChannelHolder- Specified by:
getChannelin interfaceClientChannelHolder- Returns:
- The associated
Channelinstance
-
getExtension
- Specified by:
getExtensionin interfaceSftpClient- Type Parameters:
E- The generic extension type- Parameters:
extensionType- The extension type- Returns:
- The extension instance - Note: it is up to the caller to invoke
OptionalFeature.isSupported()-nullif this extension type is not implemented by the client - See Also:
-
getExtension
- Specified by:
getExtensionin interfaceSftpClient- Parameters:
factory- TheSftpClientExtensionFactoryinstance to use - ignored ifnull- Returns:
- The extension instance - Note: it is up to the caller to invoke
OptionalFeature.isSupported()-nullif this extension type is not implemented by the client
-
getParsedServerExtensions
-
getParsedServerExtensions
-
getReferencedName
- Parameters:
cmd- The command that was sent whose response contains the name to be decodedbuf- TheBuffercontaining the encoded namenameIndex- The zero-based order of the requested names for the command - e.g.,- When listing a directory's contents each successive name will have an increasing index.
- For SFTP version 3, when retrieving a single name, short name will have index=0 and the long one index=1.
- Returns:
- The decoded referenced name
-
putReferencedName
- Type Parameters:
B- Type ofBufferbeing updated- Parameters:
cmd- The command for which this name is being addedbuf- The buffer instance to updatename- The name to place in the buffernameIndex- The zero-based order of the name for the specific command if more than one name required - e.g., rename, link/symbolic link- Returns:
- The updated buffer
-
rpc
Perform an SFTP request and wait until the response has been received.- Parameters:
cmd- the SFTP command coderequest- aBuffercontaining the request data- Returns:
- the
SftpResponsefor the request - Throws:
IOException- if an error occurs
-
response
Receives a response buffer, validates and returns it as aSftpResponse.- Parameters:
cmd- the command of the request the response is forrequestId- the id of the request- Returns:
- the
SftpResponse - Throws:
IOException- if the received buffer is malformed
-
checkCommandStatus
Sends the specified command, waits for the response and then invokescheckResponseStatus(SftpResponse)- Parameters:
cmd- The command to sendrequest- The requestBuffer- Throws:
IOException- If failed to send, receive or check the returned status- See Also:
-
checkResponseStatus
Checks if the incoming response is anSSH_FXP_STATUSone, and if so whether the substatus isSSH_FX_OK.- Parameters:
response- The receivedSftpResponse- Throws:
IOException- If response does not carry a status or carries a bad status code- See Also:
-
checkResponseStatus
- Parameters:
cmd- The sent command opcodeid- The request idstatus- TheSftpStatus- Throws:
IOException- if!status.isOk()- See Also:
-
throwStatusException
- Throws:
IOException
-
checkHandle
- Parameters:
cmd- Command to be sentrequest- TheBuffercontaining the request- Returns:
- The received handle identifier
- Throws:
IOException- If failed to send/receive or process the response- See Also:
-
checkHandleResponse
- Throws:
IOException
-
handleUnexpectedHandlePacket
- Throws:
IOException
-
checkAttributes
- Parameters:
cmd- Command to be sentrequest- RequestBuffer- Returns:
- The decoded response
Attributes - Throws:
IOException- If failed to send/receive or process the response- See Also:
-
checkAttributesResponse
- Throws:
IOException
-
handleUnexpectedAttributesPacket
protected SftpClient.Attributes handleUnexpectedAttributesPacket(SftpResponse response) throws IOException - Throws:
IOException
-
checkOneName
- Parameters:
cmd- Command to be sentrequest- The requestBuffer- Returns:
- The retrieved name
- Throws:
IOException- If failed to send/receive or process the response- See Also:
-
checkOneNameResponse
- Throws:
IOException
-
handleUnknownOneNamePacket
- Throws:
IOException
-
readAttributes
protected SftpClient.Attributes readAttributes(int cmd, Buffer buffer, AtomicInteger nameIndex) throws IOException - Throws:
IOException
-
writeAttributes
-
open
public SftpClient.CloseableHandle open(String path, Collection<SftpClient.OpenMode> options) throws IOException Description copied from interface:SftpClientOpens a remote file with the specified mode(s)- Specified by:
openin interfaceSftpClient- Parameters:
path- The remote pathoptions- The desired mode - if none specified thenSftpClient.OpenMode.Readis assumed- Returns:
- The file's
SftpClient.CloseableHandle - Throws:
IOException- If failed to open the remote file
-
close
Description copied from interface:SftpClientClose the handle obtained from one of theopenmethods- Specified by:
closein interfaceSftpClient- Parameters:
handle- TheHandleto close- Throws:
IOException- If failed to execute
-
remove
- Specified by:
removein interfaceSftpClient- Parameters:
path- The remote path to remove- Throws:
IOException- If failed to execute
-
rename
public void rename(String oldPath, String newPath, Collection<SftpClient.CopyMode> options) throws IOException - Specified by:
renamein interfaceSftpClient- Throws:
IOException
-
read
public int read(SftpClient.Handle handle, long fileOffset, byte[] dst, int dstOffset, int len, AtomicReference<Boolean> eofSignalled) throws IOException Description copied from interface:SftpClientReads data from the open (file) handle- Specified by:
readin interfaceSftpClient- Parameters:
handle- The fileSftpClient.Handleto read fromfileOffset- The file offset to read fromdst- The destination bufferdstOffset- Offset in destination buffer to place the read datalen- Available destination buffer size to readeofSignalled- If notnullthen upon return holds a value indicating whether EOF was reached due to the read. Ifnullindicator value then this indication is not available- Returns:
- Number of read bytes -
-1if EOF reached - Throws:
IOException- If failed to read the data- See Also:
-
checkData
protected int checkData(int cmd, Buffer request, int dstOffset, byte[] dst, AtomicReference<Boolean> eofSignalled) throws IOException - Throws:
IOException
-
checkDataResponse
protected int checkDataResponse(SftpResponse response, int dstoff, byte[] dst, AtomicReference<Boolean> eofSignalled) throws IOException - Throws:
IOException
-
handleUnknownDataPacket
- Throws:
IOException
-
errorData
Description copied from interface:SftpErrorDataHandlerReceive binary data from server error stream- Specified by:
errorDatain interfaceSftpErrorDataHandler- Parameters:
buf- The buffer of the incoming datastart- Offset in buffer to read the datalen- Available data in buffer- Throws:
IOException- If failed to receive incoming data
-
write
public void write(SftpClient.Handle handle, long fileOffset, byte[] src, int srcOffset, int len) throws IOException Description copied from interface:SftpClientWrite data to (open) file handle- Specified by:
writein interfaceSftpClient- Parameters:
handle- The fileSftpClient.HandlefileOffset- Zero-based offset to write in filesrc- Data buffersrcOffset- Offset of valid data in bufferlen- Number of bytes to write- Throws:
IOException- If failed to write the data
-
mkdir
Description copied from interface:SftpClientCreate remote directory- Specified by:
mkdirin interfaceSftpClient- Parameters:
path- Remote directory path- Throws:
IOException- If failed to execute
-
rmdir
Description copied from interface:SftpClientRemove remote directory- Specified by:
rmdirin interfaceSftpClient- Parameters:
path- Remote directory path- Throws:
IOException- If failed to execute
-
openDir
Description copied from interface:SftpClientObtain a handle for a directory- Specified by:
openDirin interfaceSftpClient- Parameters:
path- Remote directory path- Returns:
- The associated directory
SftpClient.Handle - Throws:
IOException- If failed to execute
-
readDir
public List<SftpClient.DirEntry> readDir(SftpClient.Handle handle, AtomicReference<Boolean> eolIndicator) throws IOException - Specified by:
readDirin interfaceSftpClient- Parameters:
handle- DirectorySftpClient.Handleto read fromeolIndicator- An indicator that can be used to get information whether end of list has been reached - ignored ifnull. Upon return, set value indicates whether all entries have been exhausted - anullvalue means that this information cannot be provided and another call toreadDiris necessary in order to verify that no more entries are pending- Returns:
- A
Listof entries -nullto indicate no more entries - Throws:
IOException- If failed to access the remote site- See Also:
-
checkDirResponse
protected List<SftpClient.DirEntry> checkDirResponse(SftpResponse response, AtomicReference<Boolean> eolIndicator) throws IOException - Throws:
IOException
-
handleUnknownDirListingPacket
protected List<SftpClient.DirEntry> handleUnknownDirListingPacket(SftpResponse response) throws IOException - Throws:
IOException
-
handleUnexpectedPacket
protected IOException handleUnexpectedPacket(int expected, SftpResponse response) throws IOException - Parameters:
expected- The expected packet typeresponse- The actualSftpResponsereceived- Returns:
- The exception to throw - if
nullthen implementor assumed to handle the exception internal. Otherwise, the exception is re-thrown - Throws:
IOException- If failed to handle the exception internally
-
canonicalPath
Description copied from interface:SftpClientThe effective "normalized" remote path- Specified by:
canonicalPathin interfaceSftpClient- Parameters:
path- The requested path - may be relative, and/or contain dots - e.g., ".", "..", "./foo", "../bar"- Returns:
- The effective "normalized" remote path
- Throws:
IOException- If failed to execute
-
stat
Description copied from interface:SftpClientRetrieve remote path meta-data - follow symbolic links if encountered- Specified by:
statin interfaceSftpClient- Parameters:
path- The remote path- Returns:
- The associated
SftpClient.Attributes - Throws:
IOException- If failed to execute
-
lstat
Description copied from interface:SftpClientRetrieve remote path meta-data - do not follow symbolic links- Specified by:
lstatin interfaceSftpClient- Parameters:
path- The remote path- Returns:
- The associated
SftpClient.Attributes - Throws:
IOException- If failed to execute
-
stat
Description copied from interface:SftpClientRetrieve file/directory handle meta-data- Specified by:
statin interfaceSftpClient- Parameters:
handle- TheSftpClient.Handleobtained via one of theopencalls- Returns:
- The associated
SftpClient.Attributes - Throws:
IOException- If failed to execute
-
setStat
Description copied from interface:SftpClientUpdate remote node meta-data- Specified by:
setStatin interfaceSftpClient- Parameters:
path- The remote pathattributes- TheSftpClient.Attributesto update- Throws:
IOException- If failed to execute
-
setStat
Description copied from interface:SftpClientUpdate remote node meta-data- Specified by:
setStatin interfaceSftpClient- Parameters:
handle- TheSftpClient.Handleobtained via one of theopencallsattributes- TheSftpClient.Attributesto update- Throws:
IOException- If failed to execute
-
readLink
Description copied from interface:SftpClientRetrieve target of a link- Specified by:
readLinkin interfaceSftpClient- Parameters:
path- Remote path that represents a link- Returns:
- The link target
- Throws:
IOException- If failed to execute
-
link
Description copied from interface:SftpClientCreate a link- Specified by:
linkin interfaceSftpClient- Parameters:
linkPath- The link locationtargetPath- The referenced target by the linksymbolic- Iftruethen make this a symbolic link, otherwise a hard one- Throws:
IOException- If failed to execute
-
lock
- Specified by:
lockin interfaceSftpClient- Throws:
IOException
-
unlock
- Specified by:
unlockin interfaceSftpClient- Throws:
IOException
-
readDir
- Specified by:
readDirin interfaceSftpClient- Parameters:
path- The remote directory path- Returns:
- An
Iterablethat can be used to iterate over all the directory entries (unlikeSftpClient.readDir(Handle)) - Throws:
IOException- If failed to access the remote site- See Also:
-
listDir
- Specified by:
listDirin interfaceSftpClient- Parameters:
handle- A directorySftpClient.Handle- Returns:
- An
Iterablethat can be used to iterate over all the directory entries (likeSftpClient.readDir(String)). Note: the iterable instance is not re-usable - i.e., files can be iterated only once - Throws:
IOException- If failed to access the directory
-
openRemoteFileChannel
public FileChannel openRemoteFileChannel(String path, Collection<SftpClient.OpenMode> modes) throws IOException Description copied from interface:SftpClientOpens anFileChannelon the specified remote path- Specified by:
openRemoteFileChannelin interfaceSftpClient- Parameters:
path- The remote pathmodes- The access mode(s) - ifnull/empty then theSftpClient.DEFAULT_CHANNEL_MODESare used- Returns:
- The open
FileChannel- Note: do not close this owner client instance until the channel is no longer needed since it uses the client for providing the channel's functionality. - Throws:
IOException- If failed to open the channel- See Also:
-
read
public InputStream read(String path, int bufferSize, Collection<SftpClient.OpenMode> mode) throws IOException Description copied from interface:SftpClientRead a remote file's data via an input stream- Specified by:
readin interfaceSftpClient- Parameters:
path- The remote file pathbufferSize- The internal read buffer sizemode- The remote fileSftpClient.OpenModes- Returns:
- An
InputStreamfor reading the remote file data - Throws:
IOException- If failed to execute
-
write
public OutputStream write(String path, int bufferSize, Collection<SftpClient.OpenMode> mode) throws IOException Description copied from interface:SftpClientWrite to a remote file via an output stream- Specified by:
writein interfaceSftpClient- Parameters:
path- The remote file pathbufferSize- The internal write buffer sizemode- The remote fileSftpClient.OpenModes- Returns:
- An
OutputStreamfor writing the data - Throws:
IOException- If failed to execute
-
getReadBufferSize
protected int getReadBufferSize() -
getWriteBufferSize
protected int getWriteBufferSize()
-