Ping Identity PingAuthorize Server - Third Party Velocity Context Provider

PingAuthorize Server Documentation Index
Configuration Reference Home

Third Party Velocity Context Provider

Third Party Velocity Context Provider provide Velocity context provider implementations created in third-party code using the UnboundID server SDK.

↓Parent Component
↓Properties
↓dsconfig Usage

Parent Component

The Third Party Velocity Context Provider component inherits from the Velocity Context Provider

Properties

The properties supported by this managed object are as follows:

Basic Properties:	Advanced Properties:
↓ enabled	None
↓ object-scope
↓ included-view
↓ excluded-view
↓ http-method
↓ response-header
↓ extension-class
↓ extension-argument

Basic Properties

enabled

Description	Indicates whether this Velocity Context Provider is enabled. If set to 'false' this Velocity Context Provider will not contribute context content for any requests.
Default Value	true
Allowed Values	true false
Multi-Valued	No
Required	No
Admin Action Required	None. Modification requires no further action

object-scope

Description	Scope for context objects contributed by this Velocity Context Provider. Must be either 'request' or 'session' or 'application'.
Default Value	application
Allowed Values	application - Objects contributed by this Velocity Context Provider need only once per the life of the server's JVM instance. session - Objects contributed by this Velocity Context Provider should be created once per the current client request's session. request - Objects contributed by this Velocity Context Provider should be created for each client request.
Multi-Valued	No
Required	No
Admin Action Required	None. Modification requires no further action

included-view

Description	The name of a view for which this Velocity Context Provider will contribute content. A provider may be restricted to specific views using the included-view and excluded-view properties. If one or more views are specified by this property then only requests for those views will result in this Velocity Context Provider contributing content for the request's Velocity context. If this property is unspecified and this provider is not excluded by the excluded-view property, this provider will contribute content for all requests. A view name is the URL request path to a template that does not include the HTTP servlet extension's base context path, nor a starting path separator. So for example if a template was accessible by the URL http://localhost:8080/view/path/to/template the view name would be 'path/to/template'.
Default Value	None
Allowed Values	A string
Multi-Valued	Yes
Required	No
Admin Action Required	None. Modification requires no further action

excluded-view

Description	The name of a view for which this Velocity Context Provider will not contribute content. A Velocity Context Provider may be restricted to specific views using the included-view and excluded-view properties. If one or more views are specified by this property then this provider will not contribute content for the request's Velocity context. A view name is the URL request path to a template that does not include the HTTP servlet extension's base context path, nor a starting path separator. So for example if a template was accessible by the URL http://localhost:8080/view/path/to/template the view name would be 'path/to/template'.
Default Value	None
Allowed Values	A string
Multi-Valued	Yes
Required	No
Admin Action Required	None. Modification requires no further action

http-method

Description	Specifies the set of HTTP methods handled by this Velocity Context Provider, which will perform actions necessary to fulfill the request before updating the context for the response. The values of this property are not case-sensitive. Typical values are standard HTTP methods: GET, POST, PATCH, PUT, DELETE, HEAD, OPTIONS, and TRACE. A request's method that matches a specified value will cause the corresponding Velocity Context Provider method to be invoked (handleGet, handlePost, handlePatch, handlePut, handleDelete, handleHead, or handleOptions and handleTrace respectively). This property is string-based, which allows non-standard methods to be specified. When these methods are matched, the Velocity Context Provider method handleAdditionalMethod is invoked. Requests specifying unsafe HTTP methods (all except for GET, HEAD, OPTIONS, and TRACE) for which no Velocity Context Provider has been configured, will result in a 405 Method Not Allowed error response from the server.
Default Value	GET
Allowed Values	A string
Multi-Valued	Yes
Required	No
Admin Action Required	None. Modification requires no further action

response-header

Description	Specifies HTTP header fields and values added to response headers for template page requests to which this Velocity Context Provider contributes content. The values specified here will override those configured for the same field names in the Velocity HTTP Servlet Extension. A Velocity Context Provider may also manipulate header fields in its updateContext method by updating the HTTP response directly. Values specified here must specify both the header field name and the value in conformance with RFC 2616. Fields may only be specified once; multiple values for the same header should be comma-separated. See RFC 7231 for a standard set of field names.
Default Value	None
Allowed Values	Colon-separated header field name and value
Multi-Valued	Yes
Required	No
Admin Action Required	None. Modification requires no further action

extension-class (Read-Only)

Description	The fully-qualified name of the Java class providing the logic for the Third Party Velocity Context Provider.
Default Value	None
Allowed Values	The fully-qualified name of a Java class that extends or implements com.unboundid.directory.sdk.common.api.VelocityContextProvider
Multi-Valued	No
Required	Yes
Admin Action Required	None. Modification requires no further action

extension-argument

Description	The set of arguments used to customize the behavior for the Third Party Velocity Context Provider. Each configuration property should be given in the form 'name=value'.
Default Value	None
Allowed Values	A string
Multi-Valued	Yes
Required	No
Admin Action Required	None. Modification requires no further action

dsconfig Usage

To list the configured Velocity Context Providers:

dsconfig list-velocity-context-providers
     [--property {propertyName}] ...

To view the configuration for an existing Velocity Context Provider:

dsconfig get-velocity-context-provider-prop
     --provider-name {name}
     --extension-name {name}
     [--tab-delimited]
     [--script-friendly]
     [--property {propertyName}] ...

To update the configuration for an existing Velocity Context Provider:

dsconfig set-velocity-context-provider-prop
     --provider-name {name}
     --extension-name {name}
     (--set|--add|--remove) {propertyName}:{propertyValue}
     [(--set|--add|--remove) {propertyName}:{propertyValue}] ...

To create a new Third Party Velocity Context Provider:

dsconfig create-velocity-context-provider
     --provider-name {name}
     --extension-name {name}
     --type third-party
     --set extension-class:{propertyValue}
     [--set {propertyName}:{propertyValue}] ...

To delete an existing Velocity Context Provider:

dsconfig delete-velocity-context-provider
     --provider-name {name}
     --extension-name {name}