10 Accessing EDQ Files Remotely
10.1 Using HTTP and HTPS Server to Access EDQ Files
EDQ 14.1.2.0.0 and later allows access to EDQ configuration and log files using HTTP and HTTPS. Web access is not enabled by default. Use settings in director.properties and an MBean to control web access to these files.
You can configure web access for these spaces:
Space | Description | Required Permissions | Writable |
---|---|---|---|
baseconfig |
The home configuration directory. |
System administration |
No |
localconfig |
The local configuration directory. |
System administration |
Yes |
landingarea |
The data file landing area. |
Upload/download files |
Yes |
projectlandingarea |
The project-specific data file area. |
Upload/download files |
Yes |
logs |
The EDQ log files. |
System administration |
No |
wlslogs |
The WebLogic logs. |
System administration |
No |
Directories under projectlandingarea are EDQ project names. The calling user must have permission to access any project referenced in a path.
The web path is:
http://server:port/edq/files/spacename/...
To list the contents of a space or subdirectory use:
http://server:port/edq/files/space/
http://server:post/edq/files/space/directory/
Listing contents requires that the space has list mode enabled. See Uploading and Deleting files.
By default, lists are generated for display in the browser. To generate a list as a JSON array for application use, add ?format=json to the URL.
The result is a JSON array in which each element contains these attributes:
Attribute | Type | Description |
---|---|---|
name |
String |
The entry name. |
Size |
Number |
The file size. This attribute is not present if the entry is a directory. |
directory |
Boolean |
true if entry is a directory. |
timestamp |
String |
The modification timestamp. |
Uploading and Deleting files
To upload a file to a writable space, use a PUT
or POST
request. To delete a file, use a DELETE
request. You can delete a directory only if it does not contain any entries. If you try to delete a non-empty directory, the request fails with a 400 error.
Enabling Web Access
Attribute | Description |
---|---|
r |
Read only mode. Space cannot be written or listed. |
rl |
Read/list. Space can be read and listed, but not written. |
rw |
Read/write. Space can be read and written, but not listed. |
rwl |
Read/write/list. Space can be read, written, and listed. |
w |
Write only. Space cannot be read or listed. |
wl |
Write/list. Space cannot be read. |
Non-writable spaces such as logs cannot be made writable.
Examples:
fileserver.enabled.spaces = all
fileserver.enabled.spaces = logs(rl) localconfig(rl)
fileserver.enabled.spaces = localconfig landingarea
By default the top level at http://server:port/files/
cannot be listed. To allow a listing of available spaces, add fileserver.listable = true
to director.properties.
Runtime Configuration
To enable configuration of the file server at runtime, add:
fileserver.dynamic = true
to director.properties. You can then control the set of enabled spaces and the global listable flag using the MBean with name:
edq:component=System,name=FileServer
and web path:
http://server:port/edq/management/mbeans/System/FileServer
Attribute | Type | Description |
---|---|---|
enabledSpaces |
Array of strings |
The list of enabled spaces with modes. |
listable |
Boolean |
The top-level listable flag. |
Attribute | Description |
---|---|
disableAllSpaces() |
Disable all file spaces. |
enableAllSpaces() |
Enable all spaces with default modes. |
setEnabledSpaces(list) |
Set list of enabled spaces - equivalent to setting fileserver.enabled.spaces. |
disbleSpace(space) |
Disable a named space. |
enableSpace(space) |
Enable a named space, with optional mode. |
The MBean is web enabled and can be read and written using the REST APIs. See REST API for MBeans for more information. For example, to set the list of spaces, use a payload like:
{ "operation": "setEnabledSpaces",
"arguments": ["wlslogs(rl) baseconfig(l)"]
}
10.2 Using SFTP Server to Access EDQ Files
EDQ is supplied with internal Secure File Transfer Protocol (SFTP) server. This server enables remote access to the configuration file area and landing area files.
The SFTP server is controlled by the sshd.port
property in director.properties
. The default value is 2222.
The following directories are available via the SFTP server:
Directory | Description |
---|---|
|
This corresponds to the EDQ base configuration directory ( |
|
This corresponds to the EDQ local configuration directory ( |
|
This corresponds to the |
|
This corresponds to the project specific landing areas in the EDQ installation. |
|
This corresponds to the |