Metrics Engine Documentation Index
Configuration Reference Home

Spring Security HTTP Servlet Extension

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 UnboundID support in order to understand the potential impact of that change.

The Spring Security HTTP Servlet Extension may be used to provide authentication and authorization services to other HTTP Servlet Extensions by using Spring Security filters chains.

↓Parent Component
↓Relations To this Component
↓Properties
↓dsconfig Usage

Parent Component

The Spring Security HTTP Servlet Extension component inherits from the HTTP Servlet Extension

Relations from This Component

The following components have a direct aggregation relation from Spring Security HTTP Servlet Extensions:

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
↓ description  None
↓ target-bean-name
↓ spring-configuration-file
↓ default-http-authentication-scheme
↓ logout-url
↓ default-logout-success-url

Basic Properties

description

Description
A description for this HTTP Servlet Extension
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

target-bean-name

Description
The name of the FilterChainProxy bean.
Default Value
springSecurityFilterChain
Allowed Values
A string
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

spring-configuration-file

Description
Specifies the path to the file(s) on the local filesystem containing the XML-based bean definitions for this Spring Security HTTP Servlet Extension. The file must exist.
Default Value
None
Allowed Values
Unknown
Multi-Valued
Yes
Required
Yes
Admin Action Required
None. Modification requires no further action

default-http-authentication-scheme

Description
Specifies the default scheme that will be used to initiate the authentication process.
Default Value
The authentication scheme whose name appears first in sorted order will be used
Allowed Values
The DN of any HTTP Authentication Scheme. The associated HTTP authentication scheme must be enabled.
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

logout-url

Description
Specifies the URL that will cause a logout.
Default Value
/logout.do
Allowed Values
The value must start with a forward slash and must represent a valid HTTP context path.
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

default-logout-success-url

Description
The URL that will be redirected to after successful logout, if the redirect_uri request parameter is not available.
Default Value
/
Allowed Values
A string
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action


dsconfig Usage

To list the configured HTTP Servlet Extensions:

dsconfig list-http-servlet-extensions
     [--property {propertyName}] ...

To view the configuration for an existing HTTP Servlet Extension:

dsconfig get-http-servlet-extension-prop
     --extension-name {name}
     [--tab-delimited]
     [--script-friendly]
     [--property {propertyName}] ...

To update the configuration for an existing HTTP Servlet Extension:

dsconfig set-http-servlet-extension-prop
     --extension-name {name}
     (--set|--add|--remove) {propertyName}:{propertyValue}
     [(--set|--add|--remove) {propertyName}:{propertyValue}] ...

To create a new Spring Security HTTP Servlet Extension:

dsconfig create-http-servlet-extension
     --extension-name {name}
     --type spring-security
     --set spring-configuration-file:{propertyValue}
     [--set {propertyName}:{propertyValue}] ...

To delete an existing HTTP Servlet Extension:

dsconfig delete-http-servlet-extension
     --extension-name {name}