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.
Note: this is an abstract component that cannot be instantiated.
Specifies a provider for Velocity context content for template pages hosted by the Metrics Engine.
Each request for a page that is implemented by a Velocity template results in a context being created that is used to provide values for variables, properties, and method references in Velocity templates. A Velocity Context Provider is used to populate the context with customized values that are exposed when a page is rendered.
↓Direct Subcomponents
↓Relations From this Component
↓Properties
↓dsconfig Usage
The following Velocity Context Providers are available in the server :
These Velocity Context Providers inherit from the properties described below.
The following components have a direct composition relation to Velocity Context Providers:
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| ↓ java-class | None |
| ↓ enabled | |
| ↓ object-scope | |
| ↓ included-view | |
| ↓ excluded-view |
| Description | Specifies the fully-qualified name of the Velocity context object provider class. |
| Default Value | None |
| Allowed Values | The fully-qualified name of a Java class that extends or implements com.unboundid.directory.server.extensions.velocity.VelocityContextProvider |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| 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 |
| 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 |
| 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 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 |
| 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 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 |
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 delete an existing Velocity Context Provider:
dsconfig delete-velocity-context-provider
--provider-name {name}
--extension-name {name}