public interface FileServiceMXBean
The ObjectName for this MBean is "WebSphere:feature=restConnector,type=FileService,name=FileService".
All paths are implicitly remote, as the operations performed by this MBean occur on the host which the server resides. All paths are required to be absolute, either explicitly or rooted with a WebSphere variable such as ${wlp.install.dir}.
Modifier and Type | Interface and Description |
---|---|
static class |
FileServiceMXBean.MetaData
Return type for the getMetaData and getDirectoryEntries methods.
|
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ATTRIBUTE_NAME_READ_LIST
The name of the attribute representing the list of read locations.
|
static java.lang.String |
ATTRIBUTE_NAME_WRITE_LIST
The name of the attribute representing the list of write locations.
|
static java.lang.String |
OBJECT_NAME
A String representing the
ObjectName that this MXBean maps to. |
static java.lang.String |
REQUEST_OPTIONS_ALL
Option indicating all available keys should be used for the query.
|
static java.lang.String |
REQUEST_OPTIONS_IS_DIRECTORY
Option indicating that "isDirectory" key should be used for the query.
|
static java.lang.String |
REQUEST_OPTIONS_LAST_MODIFIED
Option indicating that "lastModified" key should be used for the query.
|
static java.lang.String |
REQUEST_OPTIONS_READ_ONLY
Option indicating that "isReadOnly" key should be used for the query.
|
static java.lang.String |
REQUEST_OPTIONS_SIZE
Option indicating that "size" key should be used for the query.
|
Modifier and Type | Method and Description |
---|---|
boolean |
createArchive(java.lang.String sourcePath,
java.lang.String targetPath)
Create an archive of the given sourcePath.
|
boolean |
expandArchive(java.lang.String sourcePath,
java.lang.String targetPath)
Expand the archive at the given sourcePath.
|
FileServiceMXBean.MetaData[] |
getDirectoryEntries(java.lang.String directory,
boolean recursive,
java.lang.String requestOptions)
List the directory/files for the given path.
|
FileServiceMXBean.MetaData |
getMetaData(java.lang.String path,
java.lang.String requestOptions)
Get the metadata pertaining to the specified path.
|
java.util.List<java.lang.String> |
getReadList()
Get the configured list of read-accessible locations on the host where
this server resides.
|
java.util.List<java.lang.String> |
getWriteList()
Get the configured list of write-accessible locations on the host where
this server resides.
|
static final java.lang.String OBJECT_NAME
ObjectName
that this MXBean maps to.static final java.lang.String REQUEST_OPTIONS_ALL
static final java.lang.String REQUEST_OPTIONS_IS_DIRECTORY
static final java.lang.String REQUEST_OPTIONS_READ_ONLY
static final java.lang.String REQUEST_OPTIONS_SIZE
static final java.lang.String REQUEST_OPTIONS_LAST_MODIFIED
static final java.lang.String ATTRIBUTE_NAME_READ_LIST
static final java.lang.String ATTRIBUTE_NAME_WRITE_LIST
java.util.List<java.lang.String> getReadList()
For example:
<remoteFileAccess> <readDir>$ server.output.dir}/payloads</readDir> </remoteFileAccess>
The default is an empty list.
java.util.List<java.lang.String> getWriteList()
For example:
<remoteFileAccess> <writeDir>${server.output.dir}/target</writeDir> </remoteFileAccess>
The default is a list containing 3 entries: ${wlp.install.dir}, ${wlp.user.dir} and ${server.output.dir}.
FileServiceMXBean.MetaData getMetaData(java.lang.String path, java.lang.String requestOptions)
For example: to obtain a request that provides only the "size" and "lastModified" metadata values, the user can pass in "st" as the requestOptions field.
path
- the absolute path of the file or directory for which to retrieve the metadatarequestOptions
- a String representing the concatenation of the requested metadata keys. See REQUEST_OPTIONS_* fields.FileServiceMXBean.MetaData[] getDirectoryEntries(java.lang.String directory, boolean recursive, java.lang.String requestOptions)
directory
- the absolute path of the directory to listrecursive
- a boolean to specify if the search should be done to all descendant pathsrequestOptions
- a String representing the concatenation of the requested metadata keysboolean createArchive(java.lang.String sourcePath, java.lang.String targetPath)
This operation occurs on the file system on which this server resides. Therefore the sourcePath and targetPath are paths on the server's host system.
sourcePath
- the absolute path of the entity to archivetargetPath
- the absolute path to where resulting archive is to be storedboolean expandArchive(java.lang.String sourcePath, java.lang.String targetPath)
This operation occurs on the file system on which this server resides. Therefore the sourcePath and targetPath are paths on the server's host system.
sourcePath
- the absolute path of the archive to be expandedtargetPath
- the absolute path to where archive is to be expanded