Metrics Engine Documentation Index
Configuration Reference Home

Scripted 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.

Note: this is an abstract component that cannot be instantiated.

Scripted HTTP Servlet Extension provide HTTP servlet extension implementations defined in a dynamically-loaded script which implements the ScriptedHTTPServletExtension class defined in the UnboundID server SDK.

↓Direct Subcomponents
↓Parent Component
↓Properties
↓dsconfig Usage

Direct Subcomponents

The following Scripted HTTP Servlet Extensions are available in the server :

These Scripted HTTP Servlet Extensions inherit from the properties described below.

Parent Component

The Scripted HTTP Servlet Extension component inherits from the HTTP Servlet Extension

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
↓ description  None
↓ java-class
↓ script-argument

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

java-class (Read-Only)

Description
Specifies the name of the servlet extension class which can be used to obtain a servlet instance.
Default Value
None
Allowed Values
The fully-qualified name of a Java class that extends or implements com.unboundid.directory.server.protocols.http.HTTPServletExtension
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

script-argument

Description
The set of arguments used to customize the behavior for the Scripted HTTP Servlet Extension. Each configuration property should be given in the form 'name=value'.
Default Value
None
Allowed Values
An argument in the form 'name=value'. Argument names are allowed to contain only ASCII alphabetic characters, numeric digits, dashes, and underscores.
Multi-Valued
Yes
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 delete an existing HTTP Servlet Extension:

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