Broker Web Application Extension
Note: this is an abstract component that cannot be instantiated.
The Broker Web Application Extension represents an Identity Broker web application.
↓Direct Subcomponents
↓Parent Component
↓Properties
↓dsconfig Usage
Direct Subcomponents
The following Broker Web Application Extensions are available in the server :
These Broker Web Application Extensions inherit from the properties described below.
Parent Component
The Broker Web Application Extension component inherits from the Web Application Extension
Properties
The properties supported by this managed object are as follows:
Basic Properties
description
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
|
base-context-path
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 must represent a valid HTTP context path.
|
Default Value
| None
|
Allowed Values
| The value must start with a forward slash 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.
|
war-file
Description
| Specifies the path to a standard web application archive (WAR) file.
|
Default Value
| None
|
Allowed Values
| Unknown
|
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.
|
document-root-directory
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
| Unknown
|
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.
|
deployment-descriptor-file
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
| Unknown
|
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.
|
temporary-directory
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
| Unknown
|
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.
|
init-parameter
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.
|
service-url
Description
| The Identity Broker service URL.
Note: The Identity Broker server must be able to connect to this URL. Make sure that it is not blocked by a firewall.
|
Default Value
| The application cannot communicate with the Identity Broker
|
Allowed Values
| A string
|
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.
|
oauth-service-url
Description
| The Identity Broker OAuth service URL. This property need only be specified if the OAuth service is accessed through a different URL to that specified in the service-url.
Note: The Identity Broker server must be able to connect to this URL. Make sure that it is not blocked by a firewall.
|
Default Value
| The service-url value is used.
|
Allowed Values
| A string
|
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.
|
admin-service-url
Description
| The Identity Broker Admin service URL. This property need only be specified if the Admin service is accessed through a different URL to that specified in the service-url.
Note: The Identity Broker server must be able to connect to this URL. Make sure that it is not blocked by a firewall.
|
Default Value
| The service-url value is used.
|
Allowed Values
| A string
|
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.
|
pdp-service-url
Description
| The Identity Broker PDP service URL. This property need only be specified if the PDP service is accessed through a different URL to that specified in the service-url.
Note: The Identity Broker server must be able to connect to this URL. Make sure that it is not blocked by a firewall.
|
Default Value
| The service-url value is used.
|
Allowed Values
| A string
|
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.
|
privacy-service-url
Description
| The Identity Broker Privacy service URL. This property need only be specified if the Privacy service is accessed through a different URL to that specified in the service-url.
Note: The Identity Broker server must be able to connect to this URL. Make sure that it is not blocked by a firewall.
|
Default Value
| The service-url value is used.
|
Allowed Values
| A string
|
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.
|
oauth-admin-client-id
Description
| Specifies the client_id to be used to access the Identity Broker services using OAuth authentication.
|
Default Value
| The application cannot authenticate with the Identity Broker
|
Allowed Values
| A string
|
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.
|
oauth-admin-client-secret
Description
| Specifies the client_secret to be used to access the Identity Broker services using OAuth authentication.
|
Default Value
| The application cannot authenticate with the Identity Broker
|
Allowed Values
| A string
|
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.
|
trust-store-file
Description
| Specifies the path to the file containing trust information for the Identity Broker.
|
Default Value
| None
|
Allowed Values
| Unknown
|
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.
|
log-file
Description
| The path to the log file for the web application.
|
Default Value
| No logging is performed.
|
Allowed Values
| Unknown
|
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.
|
redirect-url
Description
| The absolute URL by which this application is accessed. This URL is passed to the Identity Broker and used to redirect clients back to this application after authenticating users. This URL may refer directly to the host and port of this Identity Broker or to an external component such as a load-balancer that forwards HTTP traffic to this application.
|
Default Value
| None
|
Allowed Values
| A string
|
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.
|
dsconfig Usage
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 delete an existing Web Application Extension:
dsconfig delete-web-application-extension
--extension-name {name}