Directory Proxy Server Documentation Index
Configuration Reference Home

Third Party Placement Algorithm

Third Party Placement Algorithm provide placement algorithm implementations created in third-party code using the UnboundID server SDK.

↓Parent Component
↓Properties
↓dsconfig Usage

Parent Component

The Third Party Placement Algorithm component inherits from the Placement Algorithm

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
↓ description  None
↓ enabled
↓ rebalancing-enabled
↓ rebalancing-scope
↓ rebalancing-subtree-size-limit
↓ extension-class
↓ extension-argument

Basic Properties

description

Description
A description for this Placement Algorithm
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 placement algorithm 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

rebalancing-enabled

Description
Indicates whether rebalancing is enabled for this placement algorithm. When rebalancing is enabled, the placement algorithm is consulted after certain update operations to determine whether the target entry should be moved to a different backend set. The update operations that can trigger rebalancing are (1) any MODIFY of an existing entry-balanced entry, and (2) any ADD of a new child entry below an existing entry-balanced entry.
Default Value
false
Allowed Values
true
false
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

rebalancing-scope

Description
Indicates which modified entries are candidates for rebalancing.
Default Value
any
Allowed Values
top-level - Only entries immediately below the entry balancing base.

any - Entries at any level below the entry balancing base.
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

rebalancing-subtree-size-limit

Description
Specifies the maximum number of entries in a sub-tree that may be migrated from one backend set to another during rebalancing. The method by which entries are to be migrated from one backend set to another depends on the value of this property. If the property value is greater than 1 then the restricted accessibility method is used, whereby the subtree to be moved is set read-only on the source server and hidden on the target server while the entries are moved. If the property value is equal to 1 then a pair of interactive transactions are used to move the entry. With this method the target server transaction is committed immediately before the source server transaction is committed.
Default Value
50
Allowed Values
An integer value. Lower limit is 1. Upper limit is 1000 .
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

extension-class (Read-Only)

Description
The fully-qualified name of the Java class providing the logic for the Third Party Placement Algorithm.
Default Value
None
Allowed Values
The fully-qualified name of a Java class that extends or implements com.unboundid.directory.sdk.proxy.api.PlacementAlgorithm
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

extension-argument

Description
The set of arguments used to customize the behavior for the Third Party Placement Algorithm. Each configuration property should be given in the form 'name=value'.
Default Value
None
Allowed Values
A string
Multi-Valued
Yes
Required
No
Admin Action Required
None. Modification requires no further action


dsconfig Usage

To list the configured Placement Algorithms:

dsconfig list-placement-algorithms
     [--property {propertyName}] ...

To view the configuration for an existing Placement Algorithm:

dsconfig get-placement-algorithm-prop
     --algorithm-name {name}
     --processor-name {name}
     [--tab-delimited]
     [--script-friendly]
     [--property {propertyName}] ...

To update the configuration for an existing Placement Algorithm:

dsconfig set-placement-algorithm-prop
     --algorithm-name {name}
     --processor-name {name}
     (--set|--add|--remove) {propertyName}:{propertyValue}
     [(--set|--add|--remove) {propertyName}:{propertyValue}] ...

To create a new Third Party Placement Algorithm:

dsconfig create-placement-algorithm
     --algorithm-name {name}
     --processor-name {name}
     --type third-party
     --set enabled:{propertyValue}
     --set extension-class:{propertyValue}
     [--set {propertyName}:{propertyValue}] ...

To delete an existing Placement Algorithm:

dsconfig delete-placement-algorithm
     --algorithm-name {name}
     --processor-name {name}