public interface ProxyBackendCfgClient extends BackendCfgClient
A Proxy Backend forwards LDAP requests to other servers.
Modifier and Type | Method and Description |
---|---|
ManagedObjectDefinition<? extends ProxyBackendCfgClient,? extends ProxyBackendCfg> |
definition()
Get the configuration definition associated with this Proxy Backend.
|
SortedSet<Dn> |
getBaseDn()
Gets the "base-dn" property.
|
long |
getConnectionPoolIdleTimeout()
Gets the "connection-pool-idle-timeout" property.
|
int |
getConnectionPoolMaxSize()
Gets the "connection-pool-max-size" property.
|
int |
getConnectionPoolMinSize()
Gets the "connection-pool-min-size" property.
|
long |
getConnectionTimeout()
Gets the "connection-timeout" property.
|
long |
getDiscoveryInterval()
Gets the "discovery-interval" property.
|
long |
getHeartbeatInterval()
Gets the "heartbeat-interval" property.
|
Dn |
getHeartbeatSearchRequestBaseDn()
Gets the "heartbeat-search-request-base-dn" property.
|
String |
getJavaClass()
Gets the "java-class" property.
|
ProxyBackendCfgDefn.LoadBalancingAlgorithm |
getLoadBalancingAlgorithm()
Gets the "load-balancing-algorithm" property.
|
SortedSet<Dn> |
getPartitionBaseDn()
Gets the "partition-base-dn" property.
|
Dn |
getProxyUserDn()
Gets the "proxy-user-dn" property.
|
String |
getProxyUserPassword()
Gets the "proxy-user-password" property.
|
String |
getProxyUserPasswordEnvironmentVariable()
Gets the "proxy-user-password-environment-variable" property.
|
String |
getProxyUserPasswordFile()
Gets the "proxy-user-password-file" property.
|
String |
getProxyUserPasswordProperty()
Gets the "proxy-user-password-property" property.
|
String |
getServiceDiscoveryMechanism()
Gets the "service-discovery-mechanism" property.
|
Boolean |
isRouteAll()
Gets the "route-all" property.
|
void |
setBaseDn(Collection<Dn> values)
Sets the "base-dn" property.
|
void |
setConnectionPoolIdleTimeout(Long value)
Sets the "connection-pool-idle-timeout" property.
|
void |
setConnectionPoolMaxSize(Integer value)
Sets the "connection-pool-max-size" property.
|
void |
setConnectionPoolMinSize(Integer value)
Sets the "connection-pool-min-size" property.
|
void |
setConnectionTimeout(Long value)
Sets the "connection-timeout" property.
|
void |
setDiscoveryInterval(Long value)
Sets the "discovery-interval" property.
|
void |
setHeartbeatInterval(Long value)
Sets the "heartbeat-interval" property.
|
void |
setHeartbeatSearchRequestBaseDn(Dn value)
Sets the "heartbeat-search-request-base-dn" property.
|
void |
setJavaClass(String value)
Sets the "java-class" property.
|
void |
setLoadBalancingAlgorithm(ProxyBackendCfgDefn.LoadBalancingAlgorithm value)
Sets the "load-balancing-algorithm" property.
|
void |
setPartitionBaseDn(Collection<Dn> values)
Sets the "partition-base-dn" property.
|
void |
setProxyUserDn(Dn value)
Sets the "proxy-user-dn" property.
|
void |
setProxyUserPassword(String value)
Sets the "proxy-user-password" property.
|
void |
setProxyUserPasswordEnvironmentVariable(String value)
Sets the "proxy-user-password-environment-variable" property.
|
void |
setProxyUserPasswordFile(String value)
Sets the "proxy-user-password-file" property.
|
void |
setProxyUserPasswordProperty(String value)
Sets the "proxy-user-password-property" property.
|
void |
setRouteAll(boolean value)
Sets the "route-all" property.
|
void |
setServiceDiscoveryMechanism(String value)
Sets the "service-discovery-mechanism" property.
|
getBackendId, isEnabled, setBackendId, setEnabled
commit, properties
ManagedObjectDefinition<? extends ProxyBackendCfgClient,? extends ProxyBackendCfg> definition()
definition
in interface BackendCfgClient
definition
in interface ConfigurationClient
SortedSet<Dn> getBaseDn()
Specifies the base DN(s) for the data that the backend handles.
A single backend may be responsible for one or more base DNs. Note that no two backends may have the same base DN although one backend may have a base DN that is below a base DN provided by another backend (similar to the use of sub-suffixes in the Sun Java System Directory Server). If any of the base DNs is subordinate to a base DN for another backend, then all base DNs for that backend must be subordinate to that same base DN. When the "route-all" property is set to "true" then the "base-dn" property is ignored.
void setBaseDn(Collection<Dn> values) throws PropertyException
Specifies the base DN(s) for the data that the backend handles.
A single backend may be responsible for one or more base DNs. Note that no two backends may have the same base DN although one backend may have a base DN that is below a base DN provided by another backend (similar to the use of sub-suffixes in the Sun Java System Directory Server). If any of the base DNs is subordinate to a base DN for another backend, then all base DNs for that backend must be subordinate to that same base DN. When the "route-all" property is set to "true" then the "base-dn" property is ignored.
values
- The values of the "base-dn" property.PropertyException
- If one or more of the new values are invalid.long getConnectionPoolIdleTimeout()
The time out period after which unused non-core connections will be closed and removed from the connection pool.
void setConnectionPoolIdleTimeout(Long value) throws PropertyException
The time out period after which unused non-core connections will be closed and removed from the connection pool.
value
- The value of the "connection-pool-idle-timeout" property.PropertyException
- If the new value is invalid.int getConnectionPoolMaxSize()
Maximum size of the connection pool for each remote server
void setConnectionPoolMaxSize(Integer value) throws PropertyException
Maximum size of the connection pool for each remote server
value
- The value of the "connection-pool-max-size" property.PropertyException
- If the new value is invalid.int getConnectionPoolMinSize()
Minimum size of the connection pool for each remote server
void setConnectionPoolMinSize(Integer value) throws PropertyException
Minimum size of the connection pool for each remote server
value
- The value of the "connection-pool-min-size" property.PropertyException
- If the new value is invalid.long getConnectionTimeout()
Specifies the timeout used when connecting to servers, performing SSL negotiation, and for individual search and bind requests.
If the timeout expires then the current operation will be aborted and retried against another LDAP server if one is available.
void setConnectionTimeout(Long value) throws PropertyException
Specifies the timeout used when connecting to servers, performing SSL negotiation, and for individual search and bind requests.
If the timeout expires then the current operation will be aborted and retried against another LDAP server if one is available.
value
- The value of the "connection-timeout" property.PropertyException
- If the new value is invalid.long getDiscoveryInterval()
Interval between two server configuration discovery executions.
Specifies how frequently to read the configuration of the servers in order to discover any configuration change.
void setDiscoveryInterval(Long value) throws PropertyException
Interval between two server configuration discovery executions.
Specifies how frequently to read the configuration of the servers in order to discover any configuration change.
value
- The value of the "discovery-interval" property.PropertyException
- If the new value is invalid.long getHeartbeatInterval()
Specifies the heartbeat interval that the Proxy Backend will use when communicating with the remote servers.
The Proxy Backend sends a heartbeat request to the servers every heartbeat interval. The heartbeat serves 3 purposes: keepalive, heartbeat and recovery. The hearbeat requests are small requests sent to prevent the connection from appearing idle and being forcefully closed (keepalive). The heartbeat responses inform the Proxy Backend the server is available (heartbeat). If a heartbeat answer is not received within the interval, the Proxy Backend closes the unresponsive connection and connects to another server. After an unresponsive connection is closed, the server is contacted each heartbeat interval to determine whether it is available again (recovery).
void setHeartbeatInterval(Long value) throws PropertyException
Specifies the heartbeat interval that the Proxy Backend will use when communicating with the remote servers.
The Proxy Backend sends a heartbeat request to the servers every heartbeat interval. The heartbeat serves 3 purposes: keepalive, heartbeat and recovery. The hearbeat requests are small requests sent to prevent the connection from appearing idle and being forcefully closed (keepalive). The heartbeat responses inform the Proxy Backend the server is available (heartbeat). If a heartbeat answer is not received within the interval, the Proxy Backend closes the unresponsive connection and connects to another server. After an unresponsive connection is closed, the server is contacted each heartbeat interval to determine whether it is available again (recovery).
value
- The value of the "heartbeat-interval" property.PropertyException
- If the new value is invalid.Dn getHeartbeatSearchRequestBaseDn()
Specifies the name of the entry that will be targeted by heartbeat requests.
By default heartbeat requests will attempt to read the remote server's root DSE, which is sufficient to determine whether the remote server is available, but it will not detect whether a particular backend is available. Set the heartbeat request base DN to the base entry of the backend containing application data in order to detect whether a remote server is available and handling requests against the backend.
void setHeartbeatSearchRequestBaseDn(Dn value) throws PropertyException
Specifies the name of the entry that will be targeted by heartbeat requests.
By default heartbeat requests will attempt to read the remote server's root DSE, which is sufficient to determine whether the remote server is available, but it will not detect whether a particular backend is available. Set the heartbeat request base DN to the base entry of the backend containing application data in order to detect whether a remote server is available and handling requests against the backend.
value
- The value of the "heartbeat-search-request-base-dn" property.PropertyException
- If the new value is invalid.String getJavaClass()
Specifies the fully-qualified name of the Java class that provides the backend implementation.
getJavaClass
in interface BackendCfgClient
void setJavaClass(String value) throws PropertyException
Specifies the fully-qualified name of the Java class that provides the backend implementation.
setJavaClass
in interface BackendCfgClient
value
- The value of the "java-class" property.PropertyException
- If the new value is invalid.ProxyBackendCfgDefn.LoadBalancingAlgorithm getLoadBalancingAlgorithm()
How to load balance between servers
void setLoadBalancingAlgorithm(ProxyBackendCfgDefn.LoadBalancingAlgorithm value) throws PropertyException
How to load balance between servers
value
- The value of the "load-balancing-algorithm" property.PropertyException
- If the new value is invalid.SortedSet<Dn> getPartitionBaseDn()
Specifies the base DN(s) which will be used for partitioning entries when using the "affinity" load-balancing algorithm.
This settings only applies for "affinity" load-balancing algorithm and provides consistency for add/delete operations targeting entries within the same sub-tree. Entries immediately subordinate to the base DNs will be considered to be the root of a sub-tree whose entries belong to the same partition. For example, a partition base DN of "ou=people,dc=example,dc=com" would mean that "uid=bjensen,ou=people,dc=example,dc=com" and "deviceid=12345,uid=bjensen,ou=people,dc=example,dc=com" both belong to the same partition, and all operations targeting them would be routed to the same remote server.
void setPartitionBaseDn(Collection<Dn> values) throws PropertyException
Specifies the base DN(s) which will be used for partitioning entries when using the "affinity" load-balancing algorithm.
This settings only applies for "affinity" load-balancing algorithm and provides consistency for add/delete operations targeting entries within the same sub-tree. Entries immediately subordinate to the base DNs will be considered to be the root of a sub-tree whose entries belong to the same partition. For example, a partition base DN of "ou=people,dc=example,dc=com" would mean that "uid=bjensen,ou=people,dc=example,dc=com" and "deviceid=12345,uid=bjensen,ou=people,dc=example,dc=com" both belong to the same partition, and all operations targeting them would be routed to the same remote server.
values
- The values of the "partition-base-dn" property.PropertyException
- If one or more of the new values are invalid.Dn getProxyUserDn()
The bind DN that is used to forward LDAP requests to remote servers.
The proxy connects to the remote server using this bind DN and uses the proxied authorization control to forward requests on behalf of the proxy users. This bind DN must exist on all the remote servers.
void setProxyUserDn(Dn value) throws PropertyException
The bind DN that is used to forward LDAP requests to remote servers.
The proxy connects to the remote server using this bind DN and uses the proxied authorization control to forward requests on behalf of the proxy users. This bind DN must exist on all the remote servers.
value
- The value of the "proxy-user-dn" property.PropertyException
- If the new value is invalid.String getProxyUserPassword()
Clear-text password associated with the proxy bind DN.
The proxy password must be the same on all the remote servers.
void setProxyUserPassword(String value) throws PropertyException
Clear-text password associated with the proxy bind DN.
The proxy password must be the same on all the remote servers.
value
- The value of the "proxy-user-password" property.PropertyException
- If the new value is invalid.String getProxyUserPasswordEnvironmentVariable()
Specifies the name of the environment variable that contains the clear-text password associated with the proxy bind DN.
The proxy password must be the same on all the remote servers.
void setProxyUserPasswordEnvironmentVariable(String value) throws PropertyException
Specifies the name of the environment variable that contains the clear-text password associated with the proxy bind DN.
The proxy password must be the same on all the remote servers.
value
- The value of the "proxy-user-password-environment-variable" property.PropertyException
- If the new value is invalid.String getProxyUserPasswordFile()
Specifies the path to the text file whose only contents should be a single line containing the clear-text password associated with the proxy bind DN.
The proxy password must be the same on all the remote servers.
void setProxyUserPasswordFile(String value) throws PropertyException
Specifies the path to the text file whose only contents should be a single line containing the clear-text password associated with the proxy bind DN.
The proxy password must be the same on all the remote servers.
value
- The value of the "proxy-user-password-file" property.PropertyException
- If the new value is invalid.String getProxyUserPasswordProperty()
Specifies the name of the Java property that contains the clear-text password associated with the proxy bind DN.
The proxy password must be the same on all the remote servers.
void setProxyUserPasswordProperty(String value) throws PropertyException
Specifies the name of the Java property that contains the clear-text password associated with the proxy bind DN.
The proxy password must be the same on all the remote servers.
value
- The value of the "proxy-user-password-property" property.PropertyException
- If the new value is invalid.Boolean isRouteAll()
Route requests to all discovered public naming contexts.
When the "route-all" property is set to "true" then the "base-dn" property is ignored.
void setRouteAll(boolean value) throws PropertyException
Route requests to all discovered public naming contexts.
When the "route-all" property is set to "true" then the "base-dn" property is ignored.
value
- The value of the "route-all" property.PropertyException
- If the new value is invalid.String getServiceDiscoveryMechanism()
Mechanism for finding remote servers to forward LDAP requests to
void setServiceDiscoveryMechanism(String value) throws PropertyException
Mechanism for finding remote servers to forward LDAP requests to
value
- The value of the "service-discovery-mechanism" property.PropertyException
- If the new value is invalid.Copyright 2010-2020 ForgeRock AS.