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.openam.ldap	This package contains utility methods to ease/unify development when using the OpenDJ LDAP SDK.
org.forgerock.opendj.ldap	Classes and interfaces for core types including connections, entries, and attributes.
org.forgerock.opendj.ldap.schema	Classes and interfaces for constructing and querying LDAP schemas.
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.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 and 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<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<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<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 and 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.openam.ldap

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

Modifier and Type	Field and Description
static Option<Boolean>	LDAPUtils.AFFINITY_ENABLED An Option that tells whether affinity based load balancing is enabled for the connections.
static Option<LDAPUtils.CachedPoolOptions>	LDAPUtils.CACHED_POOL_OPTIONS An Option that stores the settings related to cached connection pooling.

Uses of Option in org.forgerock.opendj.ldap

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

Modifier and Type	Field and Description
static Option<AttributeFilter>	Entries.ATTRIBUTE_FILTER Selects which attributes will be compared.
static Option<BindRequest>	LdapConnectionFactory.AUTHN_BIND_REQUEST Configures the connection factory to return pre-authenticated connections using the specified BindRequest.
static Option<Supplier<BindRequest>>	LdapConnectionFactory.AUTHN_BIND_REQUEST_FACTORY Configures the connection factory to return pre-authenticated connections using BindRequest provided by the specified Supplier.
static Option<Boolean>	LdapServer.BLOCKING_WRITE Specify whether the response should be written synchronously.
static Option<Integer>	LdapServer.BUFFER_SIZE Size of the buffer used when reading/writing data from/to the network.
static Option<Integer>	LdapServer.CONNECT_MAX_BACKLOG Specifies the maximum queue length for incoming connections requests.
static Option<Duration>	LdapConnectionFactory.CONNECT_TIMEOUT Specifies the connect timeout spcified.
static Option<Entries.DiffStrategy>	Entries.DIFF_STRATEGY Defines the strategy to use to compute changes.
static Option<Boolean>	LdapConnectionFactory.HEARTBEAT_ENABLED Configures the connection factory to periodically send "heart-beat" or "keep-alive" requests to the Directory Server.
static Option<Duration>	LdapConnectionFactory.HEARTBEAT_INTERVAL Specifies the time between successive heart-beat requests (default interval is 10 seconds).
static Option<ScheduledExecutorService>	LdapConnectionFactory.HEARTBEAT_SCHEDULER Specifies the scheduler which will be used for periodically sending heart-beat requests.
static Option<SearchRequest>	LdapConnectionFactory.HEARTBEAT_SEARCH_REQUEST Specifies the parameters of the search request that will be used for heart-beats.
static Option<Duration>	LdapConnectionFactory.HEARTBEAT_TIMEOUT Specifies the timeout for heart-beat requests, after which the remote Directory Server will be deemed to be unavailable (default timeout is 3 seconds).
static Option<BindRequest>	LdapClients.LDAP_CLIENT_AUTHN_BIND_REQUEST Configures the connection factory to return pre-authenticated connections using the specified BindRequest.
static Option<Supplier<BindRequest>>	LdapClients.LDAP_CLIENT_AUTHN_BIND_REQUEST_FACTORY Configures the connection factory to return pre-authenticated connections using BindRequest provided by the specified Supplier.
static Option<Duration>	LdapClients.LDAP_CLIENT_CONNECT_TIMEOUT Specifies the connect timeout specified.
static Option<Boolean>	LdapClients.LDAP_CLIENT_HEARTBEAT_ENABLED Configures the connection factory to periodically send "heart-beat" or "keep-alive" requests to the Directory Server.
static Option<Duration>	LdapClients.LDAP_CLIENT_HEARTBEAT_INTERVAL Specifies the time between successive heart-beat requests (default interval is 10 seconds).
static Option<ScheduledExecutorService>	LdapClients.LDAP_CLIENT_HEARTBEAT_SCHEDULER Specifies the scheduler which will be used for periodically sending heart-beat requests.
static Option<SearchRequest>	LdapClients.LDAP_CLIENT_HEARTBEAT_SEARCH_REQUEST Specifies the parameters of the search request that will be used for heart-beats.
static Option<Duration>	LdapClients.LDAP_CLIENT_HEARTBEAT_TIMEOUT Specifies the timeout for heart-beat requests, after which the remote Directory Server will be deemed to be unavailable (default timeout is 3 seconds).
static Option<Integer>	LdapClients.LDAP_CLIENT_MAX_CONCURRENT_REQUESTS Specifies the maximum number of concurrent requests per connection.
static Option<Duration>	LdapClients.LDAP_CLIENT_REQUEST_TIMEOUT Specifies the operation timeout.
static Option<Boolean>	LdapClients.LDAP_CLIENT_SSL_USE_STARTTLS Specifies whether SSL or StartTLS should be used for securing connections when an SSL context is specified.
static Option<LoadBalancerEventListener>	LdapClients.LOAD_BALANCER_EVENT_LISTENER Specifies the event listener which should be notified whenever a load-balanced LDAP client changes state from online to offline or vice-versa.
static Option<IntUnaryOperator>	LdapClients.LOAD_BALANCER_IDLE_SERVER_SELECTOR Specifies a function to chose a server when all servers are idle.
static Option<Duration>	LdapClients.LOAD_BALANCER_MONITORING_INTERVAL Specifies the interval between successive attempts to reconnect to offline load-balanced LDAP clients.
static Option<Collection<Dn>>	LdapClients.LOAD_BALANCER_PARTITION_BASE_DNS Specifies partition base DNs.
static Option<ScheduledExecutorService>	LdapClients.LOAD_BALANCER_SCHEDULER Specifies the scheduler which will be used for periodically reconnecting to offline LDAP clients.
static Option<Integer>	LdapServer.MAX_CONCURRENT_REQUESTS Specifies the maximum number of concurrent requests per connection.
static Option<Entries.ReplaceStrategy>	Entries.REPLACE_STRATEGY Defines the strategy to use to generate changes.
static Option<Integer>	LdapServer.REQUEST_MAX_SIZE_IN_BYTES Specifies the maximum request size in bytes for incoming LDAP requests.
static Option<Duration>	LdapConnectionFactory.REQUEST_TIMEOUT Specifies the operation timeout.
static Option<Integer>	LdapServer.SELECTOR_THREAD_COUNT Specifies the number of threads which will be used to handle incoming network events.
static Option<String>	LdapServer.SELECTOR_THREAD_NAME Specifies the thread name used for selector threads.
static Option<Boolean>	LdapConnectionFactory.SSL_USE_STARTTLS Specifies whether SSL or StartTLS should be used for securing connections when an SSL context is specified.
static Option<Long>	LdapServer.WRITE_TIMEOUT_MS Maximum time allowed for write operations to complete.

Uses of Option in org.forgerock.opendj.ldap.schema

Fields in org.forgerock.opendj.ldap.schema declared as Option

Modifier and Type	Field and Description
static Option<Boolean>	SchemaOptions.ALLOW_ATTRIBUTE_TYPES_WITH_NO_SUP_OR_SYNTAX Specifies whether the schema should allow attribute type definitions that do not declare a superior attribute type or syntax.
static Option<Boolean>	SchemaOptions.ALLOW_MALFORMED_CERTIFICATES Specifies whether the Certificate syntax should allow values which do not conform to the X.509 specifications.
static Option<Boolean>	SchemaOptions.ALLOW_MALFORMED_JPEG_PHOTOS Specifies whether the JPEG Photo syntax should allow values which do not conform to the JFIF or Exif specifications.
static Option<Boolean>	SchemaOptions.ALLOW_MALFORMED_NAMES_AND_OPTIONS Specifies whether the schema should allow certain illegal characters in OIDs and attribute options.
static Option<Boolean>	SchemaOptions.ALLOW_NON_STANDARD_TELEPHONE_NUMBERS Specifies whether the Telephone Number syntax should allow values which do not conform to the E.123 international telephone number format.
static Option<Boolean>	SchemaOptions.ALLOW_ZERO_LENGTH_DIRECTORY_STRINGS Specifies whether zero-length values will be allowed by the Directory String syntax.
static Option<String>	SchemaOptions.DEFAULT_MATCHING_RULE_OID Specifies the OID of the default matching rule which will be used when parsing unrecognized attributes.
static Option<String>	SchemaOptions.DEFAULT_SYNTAX_OID Specifies the OID of the default syntax which will be used when parsing unrecognized attributes.
static Option<Boolean>	SchemaOptions.STRICT_FORMAT_FOR_COUNTRY_STRINGS Indicates whether country code values are required to strictly comply with the standard definition for this syntax.
static Option<Boolean>	SchemaOptions.STRIP_UPPER_BOUND_FOR_ATTRIBUTE_TYPE Indicates whether the minimum upper bound value should be stripped from the Attribute Type Syntax Description.
static Option<Function<String,MatchingRuleImpl>>	SchemaOptions.UNKNOWN_MATCHING_RULE_HANDLER Specifies the unknown matching rule handler which will be invoked when a non-strict schema is queried about an unknown matching rule.

Methods in org.forgerock.opendj.ldap.schema with parameters of type Option

Modifier and Type	Method and Description
<T> T	Schema.getOption(Option<T> option) Returns the value associated to the provided Option or the option default value, if there is no such option in this schema.
<T> SchemaBuilder	SchemaBuilder.setOption(Option<T> option, T value) Sets a schema option overriding any previous values for the option.

Uses of Option in org.forgerock.opendj.security

Fields in org.forgerock.opendj.security declared as Option

Modifier and Type	Field and Description
static Option<KeyStoreObjectCache>	KeyStoreParameters.CACHE The caching mechanism that the key store will use.
static Option<ExternalKeyWrappingStrategy>	KeyStoreParameters.EXTERNAL_KEY_WRAPPING_STRATEGY An alternative external mechanism for wrapping private and secret keys in the key store.
static Option<Factory<char[]>>	KeyStoreParameters.GLOBAL_PASSWORD The optional password which is used to protect all private and secret keys.
static Option<Integer>	KeyStoreParameters.PBKDF2_ITERATIONS The number of iterations to use when deriving encryption keys from passwords using PBKDF2.
static Option<Integer>	KeyStoreParameters.PBKDF2_SALT_SIZE The number of random bytes to use as the salt when deriving encryption keys from passwords using PBKDF2.

Uses of Option in org.forgerock.secrets

Fields in org.forgerock.secrets declared as Option

Modifier and Type	Field and Description
static Option<Clock>	SecretStore.CLOCK Option used to specify how long secrets from a store should be used before being refreshed.
static Option<Duration>	SecretStore.LEASE_EXPIRY_DURATION Option used to specify how long secrets from a store should be used before being refreshed.

Uses of Option in org.forgerock.util

Methods in org.forgerock.util that return Option

Modifier and Type	Method and 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.

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

Modifier and Type	Method and 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.