Uses of Class
org.forgerock.util.Options

Packages that use Options

Package	Description
org.forgerock.opendj.discovery	Contains the Service Discovery Mechanisms and APIs.
org.forgerock.opendj.io	Classes and interfaces providing I/O functionality.
org.forgerock.opendj.io.rx	Classes and interfaces providing Reactive Streams I/O transports.
org.forgerock.opendj.ldap	Classes and interfaces for core types including connections, entries, and attributes.
org.forgerock.opendj.ldif	Classes and interfaces for reading and writing LDIF.
org.forgerock.opendj.rest2ldap	APIs for implementing REST to LDAP gateways.
org.forgerock.opendj.rest2ldap.schema	This package contains LDAP schema syntaxes and matching rules for JSON based attributes.
org.forgerock.opendj.security	An LDAP based security provider having the name "OpenDJ" and exposing an LDAP/LDIF based KeyStore service.
org.forgerock.secrets	Provides a unified API for accessing secrets of various kinds.
org.forgerock.secrets.keystore	Implementations of SecretStore for accessing keys stored in Java KeyStores, such as PKCS#11 Hardware Security Modules (HSMs) and PKCS#12 file-based encrypted key stores.
org.forgerock.util	Provides common interfaces and classes.
org.opends.server.discovery	Contains the Service Discovery Mechanisms and APIs.
org.opends.server.util	Contains implementations for various Directory Server utility classes and methods which may be used throughout the server but do not necessarily fit in elsewhere.

Uses of Options in org.forgerock.opendj.discovery

Methods in org.forgerock.opendj.discovery that return Options

Modifier and Type	Method	Description
Options	Partition.Server.getOptions()	Return the connections options for this server.

Constructors in org.forgerock.opendj.discovery with parameters of type Options

Modifier	Constructor	Description
	ReplicationServiceDiscoveryMechanism(Options options)	Initializes the mechanism with the provided options.

Uses of Options in org.forgerock.opendj.io

Methods in org.forgerock.opendj.io that return Options

Modifier and Type	Method	Description
Options	RxServerSocket.getOptions()	Returns a copy of the options currently used by this server socket.

Methods in org.forgerock.opendj.io with parameters of type Options

Modifier and Type	Method	Description
Single<S>	RxTransport.connect(String host, int port, Options options)	Returns a Single which will connect to the server at the provided address each time it is subscribed.
RxServerSocket<M,S>	RxTransport.listen(InetSocketAddress address, Options options)	Starts listening on the provided address and returns an RxServerSocket which will publish incoming connections via the RxServerSocket.accept() method.
boolean	RxServerSocket.setOptions(Options newOptions)	Updates the options of this server socket.

Uses of Options in org.forgerock.opendj.io.rx

Methods in org.forgerock.opendj.io.rx with parameters of type Options

Modifier and Type	Method	Description
static RxTransport<ByteBuffer,RxSocket<ByteBuffer>>	RxIo.asyncTcpTransport(Options options)	Returns a reactive TCP transport that uses asynchronous non-blocking IO when accepting connections, sending and receiving data.
static LdapSocket	RxIo.ldapClientSocket(RxSocket<ByteBuffer> socket, Options options)	Returns a reactive socket that adds an LDAP client layer to an underlying socket.
static RxTransport<LdapMessage,LdapSocket>	RxIo.ldapMemoryTransport(Options options)	Returns an in-memory reactive LDAP transport.
static LdapSocket	RxIo.ldapServerSocket(RxSocket<ByteBuffer> socket, Options options)	Returns a reactive socket that adds an LDAP server layer to an underlying socket.
static RxTransport<LdapMessage,LdapSocket>	RxIo.ldapTransportFromOptions(Options options)	Returns a new LDAP RxTransport configured using the provided options.
static RxTransport<ByteBuffer,RxSocket<ByteBuffer>>	RxIo.memoryByteBufferTransport(Options options)	Returns a reactive transport that uses in-memory sockets for all communication.
static <M> RxTransport<M,RxSocket<M>>	RxIo.memoryTransport(Options options)	Returns a reactive transport that uses in-memory sockets for all communication.
static SslRxSocket	RxIo.sslClientSocket(RxSocket<ByteBuffer> socket, Options options)	Returns a reactive socket that adds an SSL client layer to an underlying socket using an SSLEngine obtained from the CommonLdapOptions.SSL_OPTIONS of the provided options and the remote host and port of the provided socket.
static SslRxSocket	RxIo.sslServerSocket(RxSocket<ByteBuffer> socket, Options options)	Returns a reactive socket that adds an SSL server layer to an underlying socket using an SSLEngine obtained from the CommonLdapOptions.SSL_OPTIONS of the provided options.
static RxTransport<ByteBuffer,RxSocket<ByteBuffer>>	RxIo.syncTcpTransport(Options options)	Returns a reactive TCP transport that uses synchronous blocking IO when accepting connections, sending and receiving data.

Method parameters in org.forgerock.opendj.io.rx with type arguments of type Options

Modifier and Type	Method	Description
static <D, DS extends RxSocket<D>, U, US extends RxSocket<U>> RxTransport<U,US>	RxIo.transformTransport(String protocol, RxTransport<D,DS> downstream, BiFunction<Single<DS>,Options,Single<US>> connectTransformer, BiFunction<Single<DS>,RxServerSocket<D,DS>,Single<US>> acceptTransformer)	Returns a reactive transport that transforms downstream client and server reactive sockets of type D to upstream sockets of type U.

Uses of Options in org.forgerock.opendj.ldap

Methods in org.forgerock.opendj.ldap that return Options

Modifier and Type	Method	Description
Options	LdapServer.getOptions()	Returns a copy of the options currently used by this LDAP listener.

Methods in org.forgerock.opendj.ldap with parameters of type Options

Modifier and Type	Method	Description
static ModifyRequest	Entries.diffEntries(Entry fromEntry, Entry toEntry, Options options)	Creates a new modify request containing a list of modifications which can be used to transform fromEntry into entry toEntry.
static LdapClient	LdapClients.newAffinityRequestLoadBalancer(Map<com.forgerock.opendj.util.HostPort,? extends LdapClient> clients, Options options)	Creates a new "affinity" load-balancer which will load-balance individual requests across the provided set of LDAP clients, each typically representing a single replica, using an algorithm that ensures that requests targeting a given DN will always be routed to the same replica.
static ConnectionPool	LdapClients.newCachedConnectionPool(LdapClient client, Options options)	Creates a new connection pool which creates new connections as needed using the provided LDAP client, but will reuse previously allocated connections when they are available.
static LdapClient	LdapClients.newFailoverLoadBalancer(Collection<? extends LdapClient> clients, Options options)	Creates a new "fail-over" load-balancer which will load-balance connections across the provided set of LDAP clients.
static LdapClient	LdapClients.newFixedSizeDistributionLoadBalancer(Set<Dn> partitionBaseDns, ConsistentHashMap<? extends LdapClient> partitions, Options options)	Creates a distribution load balancer which uses consistent hashing to distributes requests across a set of partitions based on a hash of each request's target DN.
static LdapClient	LdapClients.newLdapClient(String host, int port, Options options)	Creates a new LDAP client which can be used to create LDAP connections to the Directory Server at the provided host and port number and custom options.
static LdapClient	LdapClients.newLdapService(Collection<String> bootstrapReplicationServerAdminEndpoints, Supplier<BindRequest> bindRequestSupplier, Options loadBalancingOptions, Options serviceDiscoveryOptions)	Creates a new LDAP load-balancer able to discover all the replicas in a directory service, load balance across them all, and reconfigure itself according to changes affecting the availability of the replicas.
static LdapClient	LdapClients.newLeastRequestsLoadBalancer(Collection<? extends LdapClient> clients, Options options)	Creates a new "least requests" load-balancer which will load-balance individual requests across the provided set of LDAP clients, each typically representing a single replica, using an algorithm that ensures that requests are routed to the replica which has the minimum number of active requests.
static LdapClient	LdapClients.newProxyLdapService(Collection<String> bootstrapReplicationServerAdminHostPorts, Options loadBalancingOptions, Options serviceDiscoveryOptions)	Creates a new LDAP load-balancer able to discover all the replicas in a directory service, load balance across them all, and reconfigure itself according to changes affecting the availability of the replicas.
void	LdapServer.setOptions(Options options)	Updates the options of this LDAP listener.

Constructors in org.forgerock.opendj.ldap with parameters of type Options

Modifier	Constructor	Description
	LdapConnectionFactory(String host, int port, Options options)	Creates a new LDAP connection factory which can be used to create LDAP connections to the Directory Server at the provided host and port number.
	LdapServer(int port, Function<LdapSession,BiFunction<Integer,Request,Flowable<Response>>> factory, Options options)	Creates a new LDAP listener implementation which will listen for LDAP client connections at the provided address.
	LdapServer(String host, int port, Function<LdapSession,BiFunction<Integer,Request,Flowable<Response>>> factory, Options options)	Creates a new LDAP listener implementation which will listen for LDAP client connections at the provided address.
	LdapServer(Set<InetSocketAddress> addresses, Function<LdapSession,BiFunction<Integer,Request,Flowable<Response>>> factory, Options options)	Creates a new LDAP listener implementation which will listen for LDAP client connections at the provided address.

Uses of Options in org.forgerock.opendj.ldif

Methods in org.forgerock.opendj.ldif with parameters of type Options

Modifier and Type	Method	Description
static ChangeRecordReader	Ldif.diff(EntryReader source, EntryReader target, Options options)	Compares the content of source to the content of target and returns the differences in a change record reader.

Uses of Options in org.forgerock.opendj.rest2ldap

Methods in org.forgerock.opendj.rest2ldap that return Options

Modifier and Type	Method	Description
static Options	Rest2LdapJsonConfigurator.configureOptions(JsonValue config)	Parses Rest2Ldap configuration options.

Methods in org.forgerock.opendj.rest2ldap with parameters of type Options

Modifier and Type	Method	Description
static RequestHandler	Rest2LdapJsonConfigurator.configureEndpoint(File endpointDirectory, Options options)	Creates a new CREST RequestHandler representing a single endpoint whose configuration is defined in the provided endpointDirectory parameter.
static Router	Rest2LdapJsonConfigurator.configureEndpoints(File endpointsDirectory, Options options)	Creates a new CREST Router using the provided endpoints configuration directory and Rest2Ldap options.
static List<Resource>	Rest2LdapJsonConfigurator.configureResources(JsonValue config, Options options)	Parses a list of Rest2Ldap resource definitions.
static RequestHandler	Hdap.newHdapRequestHandler(Options options)	Creates a new HDAP request handler with the provided options.
static Rest2Ldap	Rest2Ldap.rest2Ldap(Options options, Collection<Resource> resources)	Creates a new Rest2Ldap instance using the provided options and resources.
static Rest2Ldap	Rest2Ldap.rest2Ldap(Options options, Resource... resources)	Creates a new Rest2Ldap instance using the provided options and resources.

Uses of Options in org.forgerock.opendj.rest2ldap.schema

Methods in org.forgerock.opendj.rest2ldap.schema with parameters of type Options

Modifier and Type	Method	Description
static MatchingRuleImpl	JsonSchema.newJsonEqualityMatchingRuleImpl(Collection<JsonPointer> keys, Options options)	Creates a new custom JSON equality matching rule implementation with the provided matching rule name and options.
static MatchingRuleImpl	JsonSchema.newJsonOrderingMatchingRuleImpl(List<JsonPointer> keys, Options options)	Creates a new custom JSON ordering matching rule implementation with the provided matching rule name and options.
static MatchingRuleImpl	JsonSchema.newJsonQueryEqualityMatchingRuleImpl(String matchingRuleName, Options options)	Creates a new custom JSON query equality matching rule implementation with the provided matching rule name and options.
static MatchingRuleImpl	JsonSchema.newNameAndJsonQueryEqualityMatchingRuleImpl(String matchingRuleName, Options options)	Creates a new custom NameAndJson query equality matching rule implementation with provided matching rule name and options.

Uses of Options in org.forgerock.opendj.security

Methods in org.forgerock.opendj.security with parameters of type Options

Modifier and Type	Method	Description
static KeyStoreParameters	KeyStoreParameters.newKeyStoreParameters(ConnectionFactory factory, Dn baseDN, Options options)	Creates a set of LDAP key store parameters with custom options.
static KeyStore	OpenDjSecurityProvider.newLdapKeyStore(ConnectionFactory factory, Dn baseDN, Options options)	Creates a new LDAP key store with custom options.
static KeyStore	OpenDjSecurityProvider.newLdifKeyStore(File ldifFile, Dn baseDN, Options options)	Creates a new LDIF based key store which will read and write key store objects to the provided key store file.

Uses of Options in org.forgerock.secrets

Methods in org.forgerock.secrets with parameters of type Options

Modifier and Type	Method	Description
X509ExtendedKeyManager	SecretsProvider.getKeyManager(Set<Purpose<? extends CryptoKey>> purposes, Options options)	Returns a KeyManager that can be used to initialize an SSLContext, allowing certificates and private keys to be retrieved from this secrets provider.
X509ExtendedKeyManager	SecretsProvider.getKeyManager(Purpose<? extends CryptoKey> purpose, Options options)	Returns a KeyManager that can be used to initialize an SSLContext, allowing certificates and private keys to be retrieved from this secrets provider.
SecretsTrustManager	SecretsProvider.getTrustManager(Set<Purpose<? extends CryptoKey>> purposes, Options options)	Constructs an X509ExtendedTrustManager that will retrieve certificates from this secrets provider for the provided purposes.
SecretsTrustManager	SecretsProvider.getTrustManager(Purpose<? extends CryptoKey> purpose, Options options)	Constructs an X509ExtendedTrustManager that will retrieve certificates from this secrets provider for the provided purpose.

Uses of Options in org.forgerock.secrets.keystore

Constructors in org.forgerock.secrets.keystore with parameters of type Options

Modifier	Constructor	Description
	KeyStoreSecretStore(Function<char[],KeyStore,KeyStoreException> keyStoreLoader, SecretReference<GenericSecret> keyStorePassword, SecretReference<GenericSecret> keyEntryPassword, Options options, KeyStoreSecretStore.StableIdProvider stableIdProvider)	Initialises the key store.
	KeyStoreSecretStore(Function<char[],KeyStore,KeyStoreException> keyStoreLoader, SecretReference<GenericSecret> keyStorePassword, Options options)	Initialises the keystore using the same password for the keystore and all keys.

Uses of Options in org.forgerock.util

Methods in org.forgerock.util that return Options

Modifier and Type	Method	Description
static Options	Options.copyOf(Options options)	Returns a copy of the provided set of options.
static Options	Options.defaultOptions()	Returns a new set of options with default settings.
<T> Options	Options.reset(Option<T> option)	Resets an option to its default behavior.
<T> Options	Options.set(Option<T> option, T value)	Sets an option to the provided value.
static Options	Options.unmodifiableCopyOf(Options options)	Returns an unmodifiable copy of the provided set of options.
static Options	Options.unmodifiableDefaultOptions()	Returns an unmodifiable set of options with default settings.

Methods in org.forgerock.util with parameters of type Options

Modifier and Type	Method	Description
static Options	Options.copyOf(Options options)	Returns a copy of the provided set of options.
static Options	Options.unmodifiableCopyOf(Options options)	Returns an unmodifiable copy of the provided set of options.

Uses of Options in org.opends.server.discovery

Methods in org.opends.server.discovery that return Options

Modifier and Type	Method	Description
Options	Partition.Server.getOptions()	Return the connections options for this server.

Uses of Options in org.opends.server.util

Methods in org.opends.server.util that return Options

Modifier and Type	Method	Description
static Options	SslUtils.createOptionsForSslContext(Dn trustManagerProviderDn, Dn keyManagerProviderDn, String friendlyName, SortedSet<String> sslCertNicknames, SortedSet<String> sslCipherSuites, SortedSet<String> sslProtocols, ServerContext serverContext, ConnectionSecurity connectionSecurity)	Create SSL communications Options for an SSL context.