public interface FileTransferMBean
UnsupportedOperationException
.
The ObjectName for this MBean is "WebSphere:feature=restConnector,type=FileTransfer,name=FileTransfer".
For the remote file parameters (ie: remoteSourceFile for download/delete and remoteTargetFile for upload) the following characteristics apply:
FileServiceMXBean
for details.
For the local file parameters (ie: localTargetFile for download and and localSourceFile for upload) the following characteristics apply:
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
OBJECT_NAME
A string representing the
ObjectName that this MBean maps to. |
Modifier and Type | Method and Description |
---|---|
void |
deleteAll(java.util.List<java.lang.String> remoteArtifacts)
Delete files and folders (empty and non-empty) at the remote specified locations
|
void |
deleteFile(java.lang.String remoteSourceFile)
Delete a file located at the remote specified location.
|
void |
downloadFile(java.lang.String remoteSourceFile,
java.lang.String localTargetFile)
Download a file from the specified remote source location and write it
in the specified local target location.
|
long |
downloadFile(java.lang.String remoteSourceFile,
java.lang.String localTargetFile,
long startOffset,
long endOffset)
Download part of a file from the specified remote source location using the specified start and
end offset byte values and write it in the specified local target location.
|
void |
uploadFile(java.lang.String localSourceFile,
java.lang.String remoteTargetFile,
boolean expandOnCompletion)
Upload a file from the specified local source location and write it
in the specified remote target location.
|
static final java.lang.String OBJECT_NAME
ObjectName
that this MBean maps to.void downloadFile(java.lang.String remoteSourceFile, java.lang.String localTargetFile) throws java.io.IOException
Directories are not supported as the remote source file. To download a directory, it must first be archived.
remoteSourceFile
- the remote file location of the source to downloadlocalTargetFile
- the local file location where the source contents will be writtenjava.io.IOException
- if there are any issues handling the source or target fileslong downloadFile(java.lang.String remoteSourceFile, java.lang.String localTargetFile, long startOffset, long endOffset) throws java.io.IOException
Directories are not supported as the remote source file. To download a directory, it must first be archived.
This partial download feature is currently available only in non-routing scenarios.
remoteSourceFile
- the remote file location of the source to downloadlocalTargetFile
- the local file location where the source contents will be writtenstartOffset
- index of the first byte to copy (zero-based and inclusive)endOffset
- index of the last byte to copy (zero-based and inclusive).
Specify -1 to copy until the end of file.java.io.IOException
- if there are any issues handling the source or target filesvoid uploadFile(java.lang.String localSourceFile, java.lang.String remoteTargetFile, boolean expandOnCompletion) throws java.io.IOException
This method optionally supports expanding an archive (specified as the local source file) to the remote target file. The supported compression formats are 'zip' and 'jar' (including war and ear) . All other format types will result in undefined behaviour.
Directories are not supported as the local source file. To upload a directory, it must first be archived and can then be expanded during upload using the expandOnCompletion option. This option has a special behaviour: the archive will be uploaded as a regular file to the remote system, and then we will make a directory that matches the filename specified by remoteTargetFile, and the contents will be expanded inside that new folder.
Example: Uploading an archive with remoteTargetFile /home/myFolder/wlp.zip and the expandOnCompletion option set to true will upload the archive wlp.zip to the remote file system, create a folder called wlp.zip under the directory /home/myFolder, and then expand the contents of the archive inside the folder /home/myFolder/wlp.zip. If expandOnCompletion flag is false,then remoteTargetFile must match a filename with an extension (unless the file has not extension), and cannot be a folder.
localSourceFile
- the local path to the file that will be uploaded.
The source file must be a file, since directories are not supported.remoteTargetFile
- the remote path of the uploaded file.
The target file must be a file, since directories are not supported.expandOnCompletion
- indicates if the archive should be expanded automatically after it is uploaded.java.io.IOException
- if there are any issues handling the requestvoid deleteFile(java.lang.String remoteSourceFile) throws java.io.IOException
Recursive deletion of a directory is not supported, however deletion of an empty directory is supported.
remoteSourceFile
- the location of the remote file to be deletedjava.io.IOException
- if there are any issues handling the requestvoid deleteAll(java.util.List<java.lang.String> remoteArtifacts) throws java.io.IOException
remoteArtifacts
- list of locations of remote files and folders (empty and non-empty) to deletejava.io.IOException
- if there are any issues handling the request