Affinity QOS Policies specify how a series of requests arriving from the same client should be routed.
Under some circumstances a single request may be routed to one of several data sources. A Affinity QOS Policy determines which data source should be selected based on how previous requests from the same client were routed.
The Affinity QOS Policy component inherits from the QOS Policy
This page describes the Affinity QOS Policy:
A description of each property follows.
| Basic Properties: | Advanced Properties: |
|---|---|
| ↓ affinity-policy | ↓ java-class |
| ↓ affinity-timeout |
| Description | The client connection affinity policy. A client connection affinity allows requests to be routed to a specific data source regardless of the regular routing process. For example, you can set all the requests to be routed to a data source after a write has been completed on that data source. That way, read requests would return results which are consistent with the previous write request. |
| Default Value | none |
| Allowed Values | all-requests-after-first-request - Routes all requests to the same data source to which a previous request has been routed to. This affinity policy simulates tunneling between a client application and a data source. all-requests-after-first-write-request - Routes all requests to the same data source to which a previous write request has been routed to. all-write-requests-after-first-write-request - Routes all write requests to the same data source to which a previous write request has been routed to. This affinity policy is useful for batch updates where a parent entry and its subordinates must be sent to the same data source. first-read-request-after-write-request - Routes the first read request to the same data source to which a previous write request has been routed to. This affinity is useful when a client application performs a read request after a write request and the read request should return results consistent with the write. none - No client connection affinity. |
| Multi-valued | No |
| Required | Yes |
| Admin Action Required | None |
| Advanced Property | No |
| Read-only | No |
| Description | The period of time during which a client connection affinity policy remains active. A client connection affinity policy remains active until the timeout period expires, unless the timeout value is 0s, in which case the policy remains active until the client connection is closed. |
| Default Value | 0s |
| Allowed Values | A duration Syntax. Lower limit is 0 seconds. |
| Multi-valued | No |
| Required | Yes |
| Admin Action Required | None |
| Advanced Property | No |
| Read-only | No |
| Description | Specifies the fully-qualified name of the Java class that provides the Affinity QOS Policy implementation. |
| Default Value | com.sun.dps.server.workflowelement.loadbalancing.AffinityQOSPolicyFactory |
| 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 Affinity QOS Policy must be disabled and re-enabled for changes to this setting to take effect |
| Advanced Property | Yes |
| Read-only | No |
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-affinity-qos-policy |
| objectclass superior | ds-cfg-qos-policy |
| Property | LDAP attribute |
| affinity-policy | ds-cfg-affinity-policy |
| affinity-timeout | ds-cfg-affinity-timeout |
| java-class | ds-cfg-java-class |