Configuration Reference Home
OpenDS - Proxy LDAP Workflow Element

Proxy LDAP Workflow Element

The Proxy LDAP Workflow Element provides access to an LDAP server.

Parent Component

The Proxy LDAP Workflow Element component inherits from the Workflow Element

Relations From this Component

The following components have a direct AGGREGATION relation FROM Proxy LDAP Workflow Elements :




This page describes the Proxy LDAP Workflow Element:


Properties

A description of each property follows.


Basic Properties: Advanced Properties:
↓ client-cred-mode ↓ java-class
↓ enabled ↓ remote-ldap-server-bind-password
↓ ldap-server-extension
↓ remote-ldap-server-bind-dn
↓ remote-ldap-server-bind-password-file
↓ workflow-element-id

Basic Properties

client-cred-mode

Description
Specifies the way the proxy server binds to the remote LDAP server. Possible values are "use-specific-identity", "use-client-identity" and "use-proxy-auth".
Default Value
None
Allowed Values
use-client-identity - This Proxy LDAP Workflow Element forwards the requests with the identity of the client.

use-proxy-auth - This Proxy LDAP Workflow Element adds a proxy authorization control to the request. The autorization ID of this control is the bind DN of the incoming request. The requests are forwarded with the identity of the user specified with the parameters remote-ldap-server-bind-dn and remote-ldap-server-bind-password (or remote-ldap-server-bind-password-file if password is stored in a file).

use-specific-identity - This Proxy LDAP Workflow Element forwards the requests with the identity of the user specified with the parameters remote-ldap-server-bind-dn and remote-ldap-server-bind-password (or remote-ldap-server-bind-password-file if password is stored in a file).


Multi-valued
No
Required
Yes
Admin Action Required
None
Advanced Property
No
Read-only
No

enabled

Description
Indicates whether the Workflow Element is enabled for use in the server. If a Workflow Element is not enabled, then its contents are not accessible when processing operations.
Default Value
None
Allowed Values
true
false
Multi-valued
No
Required
Yes
Admin Action Required
None
Advanced Property
No
Read-only
No

ldap-server-extension

Description
Identifies the LDAP server extension configured for this Proxy LDAP Workflow Element. Specifies the remote server extension to forward requests to.
Default Value
None
Allowed Values
The DN of any Extension. The referenced LDAP server must be enabled.
Multi-valued
No
Required
Yes
Admin Action Required
None
Advanced Property
No
Read-only
No

remote-ldap-server-bind-dn

Description
DN which will be used to connect to a remote server. This DN must exist on the remote server. This must be a valid DN.
Default Value
None
Allowed Values
A String
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
No
Read-only
No

remote-ldap-server-bind-password-file

Description
File which contains the password which will be used to connect to the remote server. This must be a valid path.
Default Value
None
Allowed Values
A String
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
No
Read-only
No

workflow-element-id

Description
Provides a name that identifies the associated Workflow Element . The name must be unique among all Workflow Elements in the server.
Default Value
None
Allowed Values
A String
Multi-valued
No
Required
Yes
Admin Action Required
None
Advanced Property
No
Read-only
Yes


Advanced Properties

java-class

Description
Specifies the fully-qualified name of the Java class that provides the Proxy LDAP Workflow Element implementation.
Default Value
com.sun.dps.server.workflowelement.proxyldap.ProxyLdapWorkflowElement
Allowed Values
A java class that implements or extends the class(es) :
org.opends.server.workflowelement.WorkflowElement
Multi-valued
No
Required
Yes
Admin Action Required
None
Advanced Property
Yes
Read-only
No

remote-ldap-server-bind-password

Description
Password which will be used to connect to the remote server. This is a string.
Default Value
None
Allowed Values
A String
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No


LDAP Mapping

Each configuration property can be mapped to a specific LDAP attribute under the "cn=config" entry. The mappings that follow are provided for information only. In general, you should avoid changing the server configuration by manipulating the LDAP attributes directly.

Base DN
cn=Workflow elements,cn=config
objectclass name
ds-cfg-proxy-ldap-workflow-element
objectclass superior
ds-cfg-workflow-element

Property
LDAP attribute
client-cred-mode
ds-cfg-client-cred-mode
enabled
ds-cfg-enabled
java-class
ds-cfg-java-class
ldap-server-extension
ds-cfg-ldap-server-extension-ref
remote-ldap-server-bind-dn
ds-cfg-proxy-remote-ldap-server-bind-dn
remote-ldap-server-bind-password
ds-cfg-proxy-remote-ldap-server-bind-password
remote-ldap-server-bind-password-file
ds-cfg-proxy-remote-ldap-server-bind-password-file
workflow-element-id
ds-cfg-workflow-element-id