public final class ProxyServerSetup extends FrontEndServerSetup<ProxyServerSetup>
This class configures a proxy backend.
Modifier and Type | Class and Description |
---|---|
static class |
ProxyServerSetup.ReplicationMechanism
Represents a replication service discovery mechanism
to use in
serviceDiscoveryMechanism(ServiceDiscoveryMechanism) . |
static class |
ProxyServerSetup.RoutingStrategy
Represents a strategy to use to route incoming requests to the remote servers.
|
static class |
ProxyServerSetup.Server
Represents server host and port.
|
static class |
ProxyServerSetup.ServiceDiscoveryMechanism<T extends ProxyServerSetup.ServiceDiscoveryMechanism<T>>
Represents global data used to configure a service discovery mechanism.
|
static class |
ProxyServerSetup.StaticMechanism
Represents a static servers service discovery mechanism to use
in
serviceDiscoveryMechanism(ServiceDiscoveryMechanism) . |
JVM_TRUST_MANAGER_PROVIDER
Modifier and Type | Method and Description |
---|---|
ProxyServerSetup |
loadBalancingAlgorithm(org.forgerock.opendj.server.config.meta.ProxyBackendCfgDefn.LoadBalancingAlgorithm algorithm)
Specifies the
ProxyBackendCfgDefn.LoadBalancingAlgorithm to use to load balance between servers. |
ProxyServerSetup |
loadBalancingAlgorithm(String algorithm)
Specifies the algorithm to use to load balance between servers.
|
static ProxyServerSetup |
newProxyServerSetup()
Creates a new
ProxyServerSetup object to start adding setup parameters. |
ProxyServerSetup |
proxyBackendName(String backendName)
Specifies the proxy backend name.
|
ProxyServerSetup |
proxyBindDn(org.forgerock.opendj.ldap.Dn proxyBindDn)
Specified the bind
Dn that is used to forward LDAP requests to remote servers. |
ProxyServerSetup |
proxyBindDn(String proxyDn)
Specified the bind DN that is used to forward LDAP requests to remote servers.
|
ProxyServerSetup |
proxyBindPassword(Security.PasswordProvider proxyBindPasswordProvider)
Specifies the provider which must provide the bind password associated with the proxy bind DN.
|
static ProxyServerSetup.ReplicationMechanism |
replicationServiceDiscoveryMechanism()
Creates a new
ProxyServerSetup.ReplicationMechanism object to use in
serviceDiscoveryMechanism(ServiceDiscoveryMechanism) . |
static ProxyServerSetup.RoutingStrategy |
routeAll()
Specifies that all incoming requests will be routed to the remote servers.
|
static ProxyServerSetup.RoutingStrategy |
routeBaseDns(org.forgerock.opendj.ldap.Dn... baseDnsToRoute)
Specifies the base
Dn s for the data that the proxy backend handles. |
static ProxyServerSetup.RoutingStrategy |
routeBaseDns(List<org.forgerock.opendj.ldap.Dn> baseDnsToRoute)
Specifies the base
Dn s for the data that the proxy backend handles. |
static ProxyServerSetup.RoutingStrategy |
routeBaseDns(String... baseDnsToRoute)
Specifies the base DN(s) for the data that the proxy backend handles.
|
ProxyServerSetup |
routingStrategy(ProxyServerSetup.RoutingStrategy routingStrategy)
Specified the strategy to use to route incoming requests to the remote servers.
|
static ProxyServerSetup.Server |
server(String hostPort)
Creates a new remote
ProxyServerSetup.Server to use in a ProxyServerSetup.ServiceDiscoveryMechanism from the provided
String representation. |
static ProxyServerSetup.Server |
server(String host,
int port)
Creates a new
ProxyServerSetup.Server which contains host and port of a remote server to use in a
ProxyServerSetup.ServiceDiscoveryMechanism . |
static Collection<ProxyServerSetup.Server> |
servers(List<String> serverStrings)
Creates a new
Collection corresponding to the provided String representations. |
ProxyServerSetup |
serviceDiscoveryMechanism(ProxyServerSetup.ServiceDiscoveryMechanism<?> serviceDiscoveryMechanism)
Specifies the
ProxyServerSetup.ServiceDiscoveryMechanism to use in the proxy instance to setup. |
static ProxyServerSetup.StaticMechanism |
staticServiceDiscoveryMechanism()
Creates a new
ProxyServerSetup.StaticMechanism object to use in
serviceDiscoveryMechanism(ServiceDiscoveryMechanism) . |
disableLdapConnectionHandler, disableLdapSecureConnectionHandler, enableStartTls, ldapPort, ldapPort, ldapSecurePort
adminPort, checkPortAvailability, console, disableHttpConnectionHandler, disableHttpSecureConnectionHandler, enableWindowsService, fullyQualifiedHostName, httpPort, httpSecurePort, installDirectory, installDirectory, instanceDirectory, instanceDirectory, productionModeEnabled, rootUserDn, rootUserDn, rootUserPassword, secureWith, setup, startServer
public static Collection<ProxyServerSetup.Server> servers(List<String> serverStrings) throws com.forgerock.opendj.cli.ArgumentException
Collection
corresponding to the provided String
representations.
The representation must respect the format host:port. If an IPV6 address is used, then the format must be [IPv6 Address]:port
serverStrings
- Collection
which must contains ProxyServerSetup.Server
string representationsCollection
corresponding to the provided String
representations.com.forgerock.opendj.cli.ArgumentException
- If one of the provided String
representations cannot be parsed as a ProxyServerSetup.Server
public static ProxyServerSetup.Server server(String hostPort) throws com.forgerock.opendj.cli.ArgumentException
ProxyServerSetup.Server
to use in a ProxyServerSetup.ServiceDiscoveryMechanism
from the provided
String
representation.
The representation must respect the format host:port. If an IPV6 address is used, then the format must be [IPv6 Address]:port
hostPort
- String
which must contains remote server host and portProxyServerSetup.Server
to use in a ProxyServerSetup.ServiceDiscoveryMechanism
com.forgerock.opendj.cli.ArgumentException
- If the provided String
representation cannot be parsed as a ProxyServerSetup.Server
ReplicationMechanism#replicationServers(Server...)
,
StaticMechanism#primaryServers(Server...)
,
StaticMechanism#secondaryServers(Server...)
public static ProxyServerSetup.Server server(String host, int port) throws com.forgerock.opendj.cli.ArgumentException
ProxyServerSetup.Server
which contains host and port of a remote server to use in a
ProxyServerSetup.ServiceDiscoveryMechanism
.host
- Remote server host nameport
- Remote server portProxyServerSetup.Server
to use in a ProxyServerSetup.ServiceDiscoveryMechanism
com.forgerock.opendj.cli.ArgumentException
- If the provided port value is invalidReplicationMechanism#replicationServers(Server...)
,
StaticMechanism#primaryServers(Server...)
,
StaticMechanism#secondaryServers(Server...)
public static ProxyServerSetup.ReplicationMechanism replicationServiceDiscoveryMechanism()
ProxyServerSetup.ReplicationMechanism
object to use in
serviceDiscoveryMechanism(ServiceDiscoveryMechanism)
.ProxyServerSetup.ReplicationMechanism
objectserviceDiscoveryMechanism(ServiceDiscoveryMechanism)
public static ProxyServerSetup.StaticMechanism staticServiceDiscoveryMechanism()
ProxyServerSetup.StaticMechanism
object to use in
serviceDiscoveryMechanism(ServiceDiscoveryMechanism)
.ProxyServerSetup.StaticMechanism
objectserviceDiscoveryMechanism(ServiceDiscoveryMechanism)
public static ProxyServerSetup.RoutingStrategy routeAll()
ProxyServerSetup.RoutingStrategy
public static ProxyServerSetup.RoutingStrategy routeBaseDns(String... baseDnsToRoute) throws com.forgerock.opendj.cli.ArgumentException
baseDnsToRoute
- Base DNs to routecom.forgerock.opendj.cli.ArgumentException
- If one or more of the provided base DNs is invalidpublic static ProxyServerSetup.RoutingStrategy routeBaseDns(org.forgerock.opendj.ldap.Dn... baseDnsToRoute) throws com.forgerock.opendj.cli.ArgumentException
Dn
s for the data that the proxy backend handles.baseDnsToRoute
- Base Dn
s to routecom.forgerock.opendj.cli.ArgumentException
- If one or more of the provided base Dn
is invalidpublic static ProxyServerSetup.RoutingStrategy routeBaseDns(List<org.forgerock.opendj.ldap.Dn> baseDnsToRoute) throws com.forgerock.opendj.cli.ArgumentException
Dn
s for the data that the proxy backend handles.baseDnsToRoute
- Base Dn
s to routecom.forgerock.opendj.cli.ArgumentException
- If one or more of the provided base Dn
is invalidpublic static ProxyServerSetup newProxyServerSetup()
ProxyServerSetup
object to start adding setup parameters.ProxyServerSetup
object to start adding setup parameters.public ProxyServerSetup serviceDiscoveryMechanism(ProxyServerSetup.ServiceDiscoveryMechanism<?> serviceDiscoveryMechanism) throws com.forgerock.opendj.cli.ArgumentException
ProxyServerSetup.ServiceDiscoveryMechanism
to use in the proxy instance to setup.
This method must have been called before the Setup.setup()
method is called because the service discovery mechanism is a mandatory parameter.
serviceDiscoveryMechanism
- The ProxyServerSetup.ServiceDiscoveryMechanism
to usecom.forgerock.opendj.cli.ArgumentException
- If the provided ProxyServerSetup.ServiceDiscoveryMechanism
is invalidreplicationServiceDiscoveryMechanism()
,
staticServiceDiscoveryMechanism()
public ProxyServerSetup routingStrategy(ProxyServerSetup.RoutingStrategy routingStrategy)
This method must have been called before the Setup.setup()
method is called since the route strategy is a mandatory parameter.
routingStrategy
- The ProxyServerSetup.RoutingStrategy
to userouteAll()
,
routeBaseDns(List)
,
routeBaseDns(Dn...)
public ProxyServerSetup proxyBackendName(String backendName)
This method must have been called before the Setup.setup()
method is called since the backend name is a mandatory parameter.
backendName
- The proxy backend namepublic ProxyServerSetup proxyBindDn(String proxyDn) throws com.forgerock.opendj.cli.ArgumentException
The proxy connects to the remote server using this bind DN and use the proxied authorization control to forward requests on behalf of the proxy users.
This bind DN must exists on all the remote servers.
By default, "cn=proxy" will be used
proxyDn
- The bind DN that is used to forward LDAP requests to remote servers.com.forgerock.opendj.cli.ArgumentException
- If the provided value can not be parsed as a valid Dn
Setup.rootUserDn(String)
,
Setup.rootUserDn(Dn)
public ProxyServerSetup proxyBindDn(org.forgerock.opendj.ldap.Dn proxyBindDn) throws com.forgerock.opendj.cli.ArgumentException
Dn
that is used to forward LDAP requests to remote servers.
The proxy connects to the remote server using this bind DN and use the proxied authorization control to forward requests on behalf of the proxy users.
This bind DN must exists on all the remote servers.
By default, "cn=proxy" will be used
proxyBindDn
- The bind DN that is used to forward LDAP requests to remote servers.com.forgerock.opendj.cli.ArgumentException
- If the provided Dn
is invalidSetup.rootUserDn(String)
,
Setup.rootUserDn(Dn)
public ProxyServerSetup proxyBindPassword(Security.PasswordProvider proxyBindPasswordProvider)
This method must have been called before the Setup.setup()
method is called because the proxy bind password is a mandatory parameter.
The Security.unprotected()
provider is not allowed to be used with this method.
proxyBindPasswordProvider
- The Security.PasswordProvider
to use for the bind password associated with the proxy bind DN.IllegalArgumentException
- If the Security.unprotected()
password provider is used with this methodSetup.rootUserPassword(String)
public ProxyServerSetup loadBalancingAlgorithm(String algorithm) throws com.forgerock.opendj.cli.ArgumentException
The affinity algorithm will be used if this method is not called.
algorithm
- String
which represents the algorithmcom.forgerock.opendj.cli.ArgumentException
- If the provided algorithm is invalidProxyServerSetup#loadBalancingAlgorithm(LoadBalancingAlgorithm)
public ProxyServerSetup loadBalancingAlgorithm(org.forgerock.opendj.server.config.meta.ProxyBackendCfgDefn.LoadBalancingAlgorithm algorithm)
ProxyBackendCfgDefn.LoadBalancingAlgorithm
to use to load balance between servers.
The affinity algorithm will be used if this method is not called.
algorithm
- The algorithm to use to load balance between servers.Copyright © 2010-2017 ForgeRock AS. All Rights Reserved.