Note: this component is designated "advanced", which means that objects of this type are not expected to be created or altered in most environments. If you believe that such a change is necessary, you may want to contact support in order to understand the potential impact of that change.
Web Application Extensions may be used to define web applications to be hosted by the server.
A web application may be deployed in one of two ways: either as WAR file that has been packaged according to the standard layout and containing a web.xml deployment descriptor, or from a directory containing the application's source components arranged in the standard layout. In the case of the latter you may specify the location of the web.xml deployment descriptor if it is not in the standard location. You may also specify the directory used by the server for temporary files. At runtime the web application has access to the server classes.
Web applications may interact with the server via the WebAppServerContext interface defined in the Server SDK. The com.unboundid.directory.sdk.http.api.WebAppServerContextFactory class may be used to obtain a WebAppServerContext instance. This server context provides methods for obtaining information about the server, performing internal operations, registering components like change listeners and monitor providers, logging messages and generating alerts, and interacting with the server debugging framework.
The following Web Application Extensions are available in the server :
These Web Application Extensions inherit from the properties described below.
The following components have a direct aggregation relation to Web Application Extensions:
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| description | None |
| base-context-path | |
| war-file | |
| document-root-directory | |
| deployment-descriptor-file | |
| temporary-directory | |
| init-parameter |
| Description | A description for this Web Application Extension |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies the base context path that should be used by HTTP clients to reference content. The value must start with a forward slash and at least one additional character and must represent a valid HTTP context path. |
| Default Value | None |
| Allowed Values | The value must start with a forward slash and at least one additional character and must represent a valid HTTP context path. |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | For this modification to take effect, you must either restart the server or else disable and then re-enable any HTTP Connection Handler referencing this component. |
| Description | Specifies the path to a standard web application archive (WAR) file. |
| Default Value | None |
| Allowed Values | A filesystem path |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | For this modification to take effect, you must either restart the server or else disable and then re-enable any HTTP Connection Handler referencing this component. |
| Description | Specifies the path to the directory on the local filesystem containing the files to be served by this Web Application Extension. The path must exist, and it must be a directory. |
| Default Value | None |
| Allowed Values | A filesystem path |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | For this modification to take effect, you must either restart the server or else disable and then re-enable any HTTP Connection Handler referencing this component. |
| Description | Specifies the path to the deployment descriptor file when used with document-root-directory. |
| Default Value | Located under the document-root-directory at WEB-INF/web.xml. |
| Allowed Values | A filesystem path |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | For this modification to take effect, you must either restart the server or else disable and then re-enable any HTTP Connection Handler referencing this component. |
| Description | Specifies the path to the directory that may be used to store temporary files such as extracted WAR files and compiled JSP files. |
| Default Value | A temporary directory will be chosen by the server based on environment settings. |
| Allowed Values | A filesystem path |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | For this modification to take effect, you must either restart the server or else disable and then re-enable any HTTP Connection Handler referencing this component. |
| Description | Specifies an initialization parameter to pass into the web application during startup. |
| Default Value | None |
| Allowed Values | A 'key=value' pair to specify as an init-parameter. |
| Multi-Valued | Yes |
| Required | No |
| Admin Action Required | For this modification to take effect, you must either restart the server or else disable and then re-enable any HTTP Connection Handler referencing this component. |
To list the configured Web Application Extensions:
dsconfig list-web-application-extensions
[--property {propertyName}] ...
To view the configuration for an existing Web Application Extension:
dsconfig get-web-application-extension-prop
--extension-name {name}
[--tab-delimited]
[--script-friendly]
[--property {propertyName}] ...
To update the configuration for an existing Web Application Extension:
dsconfig set-web-application-extension-prop
--extension-name {name}
(--set|--add|--remove) {propertyName}:{propertyValue}
[(--set|--add|--remove) {propertyName}:{propertyValue}] ...
To create a new Web Application Extension:
dsconfig create-web-application-extension
--extension-name {name}
--type {type}
--set base-context-path:{propertyValue}
[--set {propertyName}:{propertyValue}] ...
To delete an existing Web Application Extension:
dsconfig delete-web-application-extension
--extension-name {name}