com.ibm.websphere.filetransfer
Interface FileTransferMBean


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:

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

OBJECT_NAME

static final java.lang.String OBJECT_NAME
A string representing the ObjectName that this MBean maps to.

See Also:
Constant Field Values
Method Detail

downloadFile

void downloadFile(java.lang.String remoteSourceFile,
                  java.lang.String localTargetFile)
                  throws java.io.IOException
Download a file from the specified remote source location and write it in the specified local target location.

Directories are not supported as the remote source file. To download a directory, it must first be archived.

Parameters:
remoteSourceFile - the remote file location of the source to download
localTargetFile - the local file location where the source contents will be written
Throws:
java.io.IOException - if there are any issues handling the source or target files

uploadFile

void uploadFile(java.lang.String localSourceFile,
                java.lang.String remoteTargetFile,
                boolean expandOnCompletion)
                throws java.io.IOException
Upload a file from the specified local source location and write it in the specified remote target location.

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.

Parameters:
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 written
expandOnCompletion - 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.
Throws:
java.io.IOException - if there are any issues handling the request

deleteFile

void deleteFile(java.lang.String remoteSourceFile)
                throws java.io.IOException
Delete a file located at the remote specified location.

Recursive deletion of a directory is not supported, however deletion of an empty directory is supported.

Parameters:
remoteSourceFile - the location of the remote file to be deleted
Throws:
java.io.IOException - if there are any issues handling the request