Uses of Class
org.forgerock.util.Options

Packages that use Options

Package	Description
org.forgerock.am.cts
org.forgerock.am.cts.api
org.forgerock.am.saml2.api	This package contains the SAML2 SSO APIs.
org.forgerock.am.saml2.impl	This package contains the implementation of the SAML2 client APIs.
org.forgerock.http.handler	Core Handler implementations.
org.forgerock.http.spi	HTTP service provider API.
org.forgerock.json.jose.jwe.handlers.encryption	Encryption Handler classes for each possible encryption algorithm.
org.forgerock.openam.ldap	This package contains utility methods to ease/unify development when using the OpenDJ LDAP SDK.
org.forgerock.openam.secrets	The AM supporting classes for centrally configuring secrets.
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.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.jwkset	Secret store backend for retrieving keys from a local or remote JWK Set.
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.

Uses of Options in org.forgerock.am.cts

Methods in org.forgerock.am.cts with parameters of type Options

Modifier and Type	Method	Description
Collection<PartialToken>	CTSPersistentStore.attributeQuery(TokenFilter tokenFilter, Options options)	Performs a partial Token query against the store synchronously.
Token	CTSPersistentStore.create(Token token, Options options)	Creates a Token in the persistent store synchronously.
PartialToken	CTSPersistentStore.delete(String tokenId, Options options)	Delete the Token from the store synchronously based on its id.
Promise<PartialToken,CoreTokenException>	CTSPersistentStore.deleteAsync(String tokenId, Options options)	Delete the Token from the store asynchronously based on its id.
Collection<PartialToken>	CTSPersistentStore.deleteOnQuery(TokenFilter tokenFilter, Options options)	Performs an asynchronous query against the persistent store using the provided TokenFilter and then deletes the matching tokens from the store.
PartialToken	CTSPersistentStore.patch(String tokenId, TokenType tokenType, TokenModifications modifications, Options options)	Patches a token which already exists in the persistent store with modifications.
Collection<Token>	CTSPersistentStore.query(TokenFilter filter, Options options)	Performs a synchronous query against the persistent store using the provided TokenFilter.
Token	CTSPersistentStore.read(String tokenId, Options options)	Read a Token from the persistent store synchronously.
Token	CTSPersistentStore.update(Token readState, Token updatedState, Options options)	Updates an existing Token in the store synchronously.
Token	CTSPersistentStore.upsert(Token token, Options options)	Updates an existing Token in the store synchronously.

Uses of Options in org.forgerock.am.cts.api

Methods in org.forgerock.am.cts.api that return Options

Modifier and Type	Method	Description
static <T> Options	CTSOptions.singleOption(Option<T> option, T value)

Methods in org.forgerock.am.cts.api with parameters of type Options

Modifier and Type	Method	Description
Token	TokenStorageAdapter.create(Token token, Options options)	Create the Token in the database.
default PartialToken	TokenStorageAdapter.delete(String tokenId, Options options)	Performs a delete against the Token ID provided.
Promise<PartialToken,DataLayerException>	TokenStorageAdapter.deleteAsync(String tokenId, Options options)	Performs a delete against the Token ID provided.
Collection<PartialToken>	TokenStorageAdapter.partialQuery(TokenFilter query, Options options)	Performs a partial query using the provided filter.
PartialToken	TokenStorageAdapter.patch(String tokenId, TokenModifications modifications, Options options)	Applies a patch to the database entry using the instructions contained within the TokenModification.
Collection<Token>	TokenStorageAdapter.query(TokenFilter query, Options options)	Performs a full-token query using the provided filter.
Token	TokenStorageAdapter.read(String tokenId, Options options)	Performs a read against the database and converts the result into a Token.
Token	TokenStorageAdapter.update(Token previous, Token updated, Options options)	Update the Token based on whether there were any changes between the two.

Uses of Options in org.forgerock.am.saml2.api

Methods in org.forgerock.am.saml2.api with parameters of type Options

Modifier and Type	Method	Description
Callback	Saml2SsoInitiator.initiateSso(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Realm realm, String spEntityId, String idpEntityId, Options saml2Options)	Initiates SAML2 SSO based on the provided parameters.

Uses of Options in org.forgerock.am.saml2.impl

Methods in org.forgerock.am.saml2.impl with parameters of type Options

Modifier and Type	Method	Description
Callback	Saml2SpSsoInitiator.initiateSso(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Realm realm, String spEntityId, String idpEntityId, Options saml2Options)

Uses of Options in org.forgerock.http.handler

Constructors in org.forgerock.http.handler with parameters of type Options

Constructor	Description
HttpClientHandler(Options options)	Creates a new HTTP client using the provided client options.

Uses of Options in org.forgerock.http.spi

Methods in org.forgerock.http.spi with parameters of type Options

Modifier and Type	Method	Description
<S> S	Loader.load(Class<S> service, Options options)	Loads a service of the specified type.
HttpClient	HttpClientProvider.newHttpClient(Options options)	Returns a new HttpClient configured using the provided set of options.

Uses of Options in org.forgerock.json.jose.jwe.handlers.encryption

Constructors in org.forgerock.json.jose.jwe.handlers.encryption with parameters of type Options

Constructor	Description
RSAEncryptionHandler(EncryptionMethod encryptionMethod, JweAlgorithm jweAlgorithm, Options options)	Constructs a new RSAEncryptionHandler instance with the given options.

Uses of Options in org.forgerock.openam.ldap

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

Modifier and Type	Method	Description
static ConnectionFactory	LDAPUtils.createFailoverConnectionFactory(String host, int defaultPort, boolean ssl, String authDN, String authPasswd, boolean mtlsEnabled, String mtlsSecretId, Realm realm, Secrets secrets, Options options)	Creates a ConnectionFactory from the host string and associated details.
static ConnectionFactory	LDAPUtils.createFailoverConnectionFactory(String host, int defaultPort, boolean ssl, String authDN, String authPasswd, Options options)	Creates a ConnectionFactory from the host string and associated details.
static ConnectionFactory	LDAPUtils.newFailoverConnectionFactory(Set<org.forgerock.openam.ldap.LDAPURL> servers, String username, char[] password, int heartBeatInterval, String heartBeatTimeUnit, boolean useStartTls, boolean sslTrustAll, boolean mtlsEnabled, String mtlsSecretId, Realm realm, Secrets secrets, Options ldapOptions)	Creates a new connection factory that is capable to failover to the servers defined in case there is an error.
static ConnectionFactory	LDAPUtils.newFailoverConnectionFactory(Set<org.forgerock.openam.ldap.LDAPURL> servers, String username, char[] password, int heartBeatInterval, String heartBeatTimeUnit, boolean useStartTls, boolean sslTrustAll, Options ldapOptions)	Creates a new connection factory that is capable to failover to the servers defined in case there is an error.
static ConnectionFactory	LDAPUtils.newFailoverConnectionPool(Set<org.forgerock.openam.ldap.LDAPURL> servers, String username, char[] password, int maxSize, int heartBeatInterval, String heartBeatTimeUnit, boolean useStartTLS, boolean sslTrustAll, Options ldapOptions)	Creates a new connection pool that is capable to failover to the servers defined in case there is an error.
static ConnectionFactory	LDAPUtils.newFailoverConnectionPool(Set<org.forgerock.openam.ldap.LDAPURL> servers, String username, char[] password, int maxSize, int heartBeatInterval, String heartBeatTimeUnit, boolean useStartTLS, boolean sslTrustAll, Options ldapOptions, boolean mtlsEnabled, String mtlsSecretId, Secrets secrets, Realm realm)	Creates a new connection pool that is capable to failover to the servers defined in case there is an error.
static ConnectionFactory	LDAPUtils.newFailoverConnectionPool(Set<org.forgerock.openam.ldap.LDAPURL> primaryUrls, Set<org.forgerock.openam.ldap.LDAPURL> secondaryUrls, String username, char[] password, int maxSize, int heartBeatInterval, String heartBeatTimeUnit, boolean useStartTLS, boolean sslTrustAll, boolean mtlsEnabled, String mtlsCertificateLabel, Realm realm, Secrets secrets, Options ldapOptions)	Creates a new connection pool that is capable to failover from the primary to the secondary servers defined in case there is an error.
static ConnectionFactory	LDAPUtils.newFailoverConnectionPool(Set<org.forgerock.openam.ldap.LDAPURL> primaryUrls, Set<org.forgerock.openam.ldap.LDAPURL> secondaryUrls, String username, char[] password, int maxSize, int heartBeatInterval, String heartBeatTimeUnit, boolean useStartTLS, boolean sslTrustAll, Options ldapOptions)	Creates a new connection pool that is capable to failover from the primary to the secondary servers defined in case there is an error.
static ConnectionFactory	LDAPUtils.newPasswordConnectionFactory(Set<org.forgerock.openam.ldap.LDAPURL> servers, String username, char[] password, int maxSize, int heartBeatInterval, String heartBeatTimeUnit, boolean useStartTLS, boolean sslTrustAll, Options ldapOptions)	Creates a new connection pooled connection factory that is capable to failover to the servers defined in case there is an error.
static ConnectionFactory	LDAPUtils.newPasswordConnectionFactory(Set<org.forgerock.openam.ldap.LDAPURL> primaryServers, Set<org.forgerock.openam.ldap.LDAPURL> secondaryServers, String username, char[] password, int maxSize, int heartBeatInterval, String heartBeatTimeUnit, boolean useStartTLS, boolean sslTrustAll, Options ldapOptions)	Creates a new connection pooled connection factory that is capable to failover to the servers defined in case there is an error.
static ConnectionFactory	LDAPUtils.newPrioritizedFailoverConnectionFactory(Set<String> servers, String hostServerId, String hostSiteId, String username, char[] password, int heartBeatInterval, String heartBeatTimeUnit, boolean useStartTLS, boolean sslTrustAll, Options options)	Based on the incoming parameters prioritizes the LDAP server list, then creates a connection factory that is capable to failover to the servers defined in case there is an error.
static ConnectionFactory	LDAPUtils.newPrioritizedFailoverConnectionPool(Set<String> servers, String hostServerId, String hostSiteId, String username, char[] password, int maxSize, int heartBeatInterval, String heartBeatTimeUnit, boolean useStartTLS, boolean sslTrustAll, Options ldapOptions)	Based on the incoming parameters prioritizes the LDAP server list, then creates a connection pool that is capable to failover to the servers defined in case there is an error.

Uses of Options in org.forgerock.openam.secrets

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

Modifier and Type	Method	Description
X509ExtendedKeyManager	SecretsProviderFacade.getKeyManager(Purpose<? extends CryptoKey> purpose, Options options)
SecretsTrustManager	SecretsProviderFacade.getTrustManager(Purpose<? extends CryptoKey> purpose, Options options)

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

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
io.reactivex.rxjava3.core.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<io.reactivex.rxjava3.core.Single<DS>,Options,io.reactivex.rxjava3.core.Single<US>> connectTransformer, BiFunction<io.reactivex.rxjava3.core.Single<DS>,RxServerSocket<D,DS>,io.reactivex.rxjava3.core.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(Collection<? 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

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, io.reactivex.rxjava3.functions.Function<LdapSession,io.reactivex.rxjava3.functions.BiFunction<Integer,Request,io.reactivex.rxjava3.core.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, io.reactivex.rxjava3.functions.Function<LdapSession,io.reactivex.rxjava3.functions.BiFunction<Integer,Request,io.reactivex.rxjava3.core.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, io.reactivex.rxjava3.functions.Function<LdapSession,io.reactivex.rxjava3.functions.BiFunction<Integer,Request,io.reactivex.rxjava3.core.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.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(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.jwkset

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

Constructor	Description
JwkSetSecretStore(JWKSet jwkSet, Options options)	Creates a secret store directly from the given JWK Set.
JwkSetSecretStore(JwksStore jwksStore, Options options)	Creates a secret store from a JwksStore.

Uses of Options in org.forgerock.secrets.keystore

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

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.