|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface FileTransferMBean
This MBean exposes remote file transfer capabilities and must be accessed
only within IBM's JMX REST Connector. Accessing this MBean by any
other means will result in a 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:
Field Summary | |
---|---|
static java.lang.String |
OBJECT_NAME
A string representing the ObjectName that this MBean maps to. |
Method Summary | |
---|---|
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. |
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. |
Field Detail |
---|
static final java.lang.String OBJECT_NAME
ObjectName
that this MBean maps to.
Method Detail |
---|
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 written
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 operation supports expanding an archive (specified as the local source file) to the remote target file. The supported compression formats are 'zip' and 'jar'. 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.
localSourceFile
- the local file location of the source to upload.
The source file must be a normal file, directories are not supported.remoteTargetFile
- the remote file location where the source contents will be writtenexpandOnCompletion
- indicates if the archive should be expanded automatically
to a folder location that matches the remoteTargetFile parameter.
The archive file deleted after expansion. If the uploaded file is not
an archive then false should be specified.
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 deleted
java.io.IOException
- if there are any issues handling the request
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |