Configuration Reference Home
OpenDS - Referral QOS Policy

Referral QOS Policy

Referral QOS Policies specify how referrals should be handled by the server.

Under some circumstances the server may be able to follow any referrals which were encountered when processing a client request.

Parent Component

The Referral QOS Policy component inherits from the QOS Policy




This page describes the Referral QOS Policy:


Properties

A description of each property follows.


Basic Properties: Advanced Properties:
↓ referral-hop-limit ↓ java-class
↓ referral-policy

Basic Properties

referral-hop-limit

Description
Specifies the maximum number of hops when following referrals. A value of 0 means that no limit is enforced.
Default Value
0
Allowed Values
An integer value. Lower value is 0.
Multi-valued
No
Required
Yes
Admin Action Required
None
Advanced Property
No
Read-only
No

referral-policy

Description
Determines how referrals encountered when processing a client request should be handled by the server.
Default Value
forward
Allowed Values
discard - Discard referrals.

follow - Follow referrals

forward - Forward referrals.


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


Advanced Properties

java-class

Description
Specifies the fully-qualified name of the Java class that provides the Referral QOS Policy implementation.
Default Value
com.sun.dps.server.workflowelement.proxyldap.ReferralQOSPolicyFactory
Allowed Values
A java class that implements or extends the class(es) :
org.opends.server.api.QOSPolicyFactory
Multi-valued
No
Required
Yes
Admin Action Required
The Referral QOS Policy must be disabled and re-enabled for changes to this setting to take effect
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=QoS Policies
objectclass name
ds-cfg-referral-qos-policy
objectclass superior
ds-cfg-qos-policy

Property
LDAP attribute
java-class
ds-cfg-java-class
referral-hop-limit
ds-cfg-referral-hop-limit
referral-policy
ds-cfg-referral-policy