Directory Proxy Server Documentation Index
Configuration Reference Home

Proxy Transformation

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

A Proxy Transformation may be used to transform requests as they are forwarded from the client to a backend server, and to transform responses as they are forwarded from the backend server to the client.

↓Direct Subcomponents
↓Relations From this Component
↓Relations To this Component
↓Properties
↓dsconfig Usage

Direct Subcomponents

The following Proxy Transformations are available in the server :

These Proxy Transformations inherit from the properties described below.

Relations From this Component

The following components have a direct aggregation relation from Proxy Transformations:

Relations To this Component

The following components have a direct aggregation relation to Proxy Transformations:

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
↓ description  None
↓ enabled
↓ java-class
↓ request-criteria

Basic Properties

description

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

enabled

Description
Indicates whether this proxy transformation is enabled for use in the server.
Default Value
None
Allowed Values
true
false
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

java-class (Read-Only)

Description
The fully-qualified name of the Java class that provides the logic for this proxy transformation.
Default Value
None
Allowed Values
The fully-qualified name of a Java class that extends or implements com.unboundid.directory.proxy.api.ProxyTransformation
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

request-criteria

Description
Criteria indicating the set of operations for which the transformation will be invoked.
Default Value
This Proxy Transformation will be invoked for all operations.
Allowed Values
The DN of any Request Criteria.
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action


dsconfig Usage

To list the configured Proxy Transformations:

dsconfig list-proxy-transformations
     [--property {propertyName}] ...

To view the configuration for an existing Proxy Transformation:

dsconfig get-proxy-transformation-prop
     --transformation-name {name}
     [--tab-delimited]
     [--script-friendly]
     [--property {propertyName}] ...

To update the configuration for an existing Proxy Transformation:

dsconfig set-proxy-transformation-prop
     --transformation-name {name}
     (--set|--add|--remove) {propertyName}:{propertyValue}
     [(--set|--add|--remove) {propertyName}:{propertyValue}] ...

To delete an existing Proxy Transformation:

dsconfig delete-proxy-transformation
     --transformation-name {name}