Uses of Class
org.forgerock.util.Option

Packages that use Option

Package	Description
org.forgerock.http.handler	Core Handler implementations.
org.forgerock.json.jose.jwe.handlers.encryption	Encryption Handler classes for each possible encryption algorithm.
org.forgerock.openig.ldap	Facilitates access to the OpenDJ LDAP SDK from within scripts.
org.forgerock.secrets	Provides a unified API for accessing secrets of various kinds.
org.forgerock.util	Provides common interfaces and classes.

Uses of Option in org.forgerock.http.handler

Fields in org.forgerock.http.handler declared as Option

Modifier and Type	Field	Description
static Option<Duration>	HttpClientHandler.OPTION_CONNECT_TIMEOUT	The TCP connect timeout for new HTTP connections.
static Option<Boolean>	HttpClientHandler.OPTION_DISABLE_CONNECTION_STATE	This option is only taken into account when OPTION_REUSE_CONNECTIONS is also set to true.
static Option<HttpClientHandler.HostnameVerifier>	HttpClientHandler.OPTION_HOSTNAME_VERIFIER	Specifies the SSL host name verification policy.
static Option<KeyManagerFactory>	HttpClientHandler.OPTION_KEY_MANAGER_FACTORY	Specifies the key manager factory that should be used when configuring SSL/TLS connections.
static Option<KeyManager[]>	HttpClientHandler.OPTION_KEY_MANAGERS	Specifies the list of key managers that should be used when configuring SSL/TLS connections.
static Option<Loader>	HttpClientHandler.OPTION_LOADER	The strategy which should be used for loading the HttpClientProvider.
static Option<Integer>	HttpClientHandler.OPTION_MAX_CONNECTIONS	Specifies the maximum number of connections that should be pooled by the HTTP client.
static Option<List<String>>	HttpClientHandler.OPTION_NON_PROXY_HOSTS	Specifies the list of hosts for which requests should not be proxied.
static Option<Long>	HttpClientHandler.OPTION_POOLED_CONNECTION_TTL	Specifies the time to live (expiry time) in milliseconds of connections from the pool.
static Option<HttpClientHandler.ProxyInfo>	HttpClientHandler.OPTION_PROXY	Specifies a proxy to use for requests by the HTTP Client.
static Option<Boolean>	HttpClientHandler.OPTION_PROXY_SYSTEM	Specifies that the system defined proxy should be used for requests by the HTTP Client.
static Option<Boolean>	HttpClientHandler.OPTION_RETRY_REQUESTS	Specifies whether requests should be retried if a failure is detected.
static Option<Boolean>	HttpClientHandler.OPTION_REUSE_CONNECTIONS	Specifies whether HTTP connections should be kept alive and reused for additional requests.
static Option<Duration>	HttpClientHandler.OPTION_SO_TIMEOUT	The TCP socket timeout when waiting for HTTP responses.
static Option<List<String>>	HttpClientHandler.OPTION_SSL_CIPHER_SUITES	List of JSSE ciphers to be enabled on the HttpClient.
static Option<List<String>>	HttpClientHandler.OPTION_SSL_ENABLED_PROTOCOLS	List of SSL protocols to be enabled on the HttpClient.
static Option<String>	HttpClientHandler.OPTION_SSLCONTEXT_ALGORITHM	SSLContext algorithm to be used when making SSL/TLS connections.
static Option<Factory<Buffer>>	HttpClientHandler.OPTION_TEMPORARY_STORAGE	Specifies the temporary storage that should be used for storing HTTP responses.
static Option<TrustManagerFactory>	HttpClientHandler.OPTION_TRUST_MANAGER_FACTORY	Specifies the trust manager factory that should be used when configuring SSL/TLS connections.
static Option<TrustManager[]>	HttpClientHandler.OPTION_TRUST_MANAGERS	Specifies the list of trust managers that should be used when configuring SSL/TLS connections.

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

Fields in org.forgerock.json.jose.jwe.handlers.encryption declared as Option

Modifier and Type	Field	Description
static Option<Boolean>	RSAEncryptionHandler.USE_WRAP_UNWRAP_OPERATIONS	Indicates whether the handler should use Cipher.wrap(Key) and Cipher.unwrap(byte[], String, int) operations or normal encrypt/decrypt operations for encrypting the per-message symmetric AES key.

Uses of Option in org.forgerock.openig.ldap

Fields in org.forgerock.openig.ldap declared as Option

Modifier and Type	Field	Description
static Option<TransactionId>	LdapClient.TRANSACTIONID_OPTION	The option to pass the TransactionId to LdapConnection.

Uses of Option in org.forgerock.secrets

Fields in org.forgerock.secrets declared as Option

Modifier and Type	Field	Description
static Option<Clock>	SecretStore.CLOCK	Specifies the clock to use when making time comparisons.
static Option<Boolean>	SecretsTrustManager.ENABLE_REVOCATION_CHECKING	Whether the trust manager should perform recovation checking or not.
static Option<String>	SecretsKeyManager.KEY_MANAGER_ALGORITHM	The algorithm of the underlying X509ExtendedKeyManager implementation to use.
static Option<Duration>	SecretStore.LEASE_EXPIRY_DURATION	Option used to specify how long secrets from a store should be used before being refreshed.
static Option<EnumSet<PKIXRevocationChecker.Option>>	SecretsTrustManager.REVOCATION_OPTIONS	The options to pass to the revocation checker, if revocation checking is enabled.
static Option<String>	SecretsTrustManager.TRUST_MANAGER_ALGORITHM	Algorithm to use for looking up the underlying X509ExtendedTrustManager.

Uses of Option in org.forgerock.util

Methods in org.forgerock.util that return Option

Modifier and Type	Method	Description
static <T> Option<T>	Option.of(Class<T> type, T defaultValue)	Defines an option with the provided type and default value.
static <T> Option<T>	Option.withDefault(T defaultValue)	Defines a boolean option with the provided default value.
static <E extends Enum<E>,T extends E> Option<E>	Option.withDefault(T defaultValue)	Defines a boolean option with the provided default value.

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

Modifier and Type	Method	Description
<T> T	Options.get(Option<T> option)	Returns the value associated with the provided option, or its default value if the option has not been configured.
<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.