Uses of Class
org.forgerock.util.Option

Packages that use Option

Package	Description
org.forgerock.opendj.hdap	APIs for implementing lightweight REST to LDAP gateways.
org.forgerock.opendj.json.schema	This package contains LDAP schema syntaxes and matching rules for JSON based attributes.
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.
org.opends.server.schema	Contains implementations of various Directory Server schema elements.

Uses of Option in org.forgerock.opendj.hdap

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

Modifier and Type	Field	Description
static final Option<DecodeOptions>	Hdap.DECODE_OPTIONS	Specifies the LDAP decoding options which should be used when decoding LDAP DNs, attribute types, and controls.
static final Option<Boolean>	Hdap.LOAD_SCHEMA	Specifies whether the LDAP schema should be loaded from the LDAP server before being able to serve requests.
static final Option<Boolean>	Hdap.NORMALIZE_ATTRIBUTE_NAMES	Specifies whether HDAP should normalize attribute names in the JSON representation of the resource, or use the name provided in the request.
static final Option<Boolean>	Hdap.RETURN_NULL_FOR_MISSING_PROPERTIES	Specifies whether hdap should represent missing JSON property values using null.
static final Option<ScheduledExecutorService>	Hdap.SCHEDULER	Specifies the scheduler which will be used for periodically detecting changes to LDAP schema.
static final Option<Duration>	Hdap.SCHEMA_RELOAD_INTERVAL	Specifies the interval between successive attempts to detect changes in LDAP schema.
static final Option<Duration>	Hdap.SCHEMA_RETRY_INTERVAL	Specifies the interval between failed attempts to load the remote schema.

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

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

Modifier and Type	Field	Description
static final Option<Boolean>	JsonSchema.CASE_SENSITIVE_STRINGS	Matching rule option controlling whether JSON string comparisons should be case-sensitive.
static final Option<Boolean>	JsonSchema.IGNORE_WHITE_SPACE	Matching rule option controlling whether JSON string comparisons should ignore white-space.
static final Option<Collection<String>>	JsonSchema.INDEXED_FIELD_PATTERNS	Matching rule option controlling which JSON fields should be indexed by the matching rule.
static final Option<JsonSchema.ValidationPolicy>	JsonSchema.VALIDATION_POLICY	Schema option controlling syntax validation for JSON based attributes.

Uses of Option in org.forgerock.opendj.ldap

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

Modifier and Type	Field	Description
static final Option<Consumer<RxSocket<?>>>	LdapServer.ACCEPTED_CLIENT_VALIDATOR	A consumer which is invoked immediately after a new connection has been accepted in order to determine whether the connection should be accepted or not, in which case it will be closed immediately.
static final Option<AttributeFilter>	Entries.ATTRIBUTE_FILTER	Selects which attributes will be compared.
static final Option<BindRequest>	LdapConnectionFactory.AUTHN_BIND_REQUEST	Configures the connection factory to return pre-authenticated connections using the specified BindRequest.
static final 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 final Option<Integer>	CommonLdapOptions.BUFFER_SIZE	Size of the buffer used when reading/writing data from/to the network.
static final Option<Integer>	CommonLdapOptions.BUFFER_SIZE	Size of the buffer used when reading/writing data from/to the network.
static final Option<Integer>	CommonLdapOptions.BUFFER_SIZE	Size of the buffer used when reading/writing data from/to the network.
static final Option<Integer>	LdapServer.CONNECT_MAX_BACKLOG	Specifies the maximum queue length for incoming connections requests.
static final Option<Duration>	LdapClients.CONNECT_TIMEOUT	Specifies the connect timeout.
static final Option<ConnectionPoolEventListener>	LdapClients.CONNECTION_POOL_EVENT_LISTENER	Specifies the event listener which should be notified whenever an event occurs in a connection pool.
static final Option<Duration>	LdapClients.CONNECTION_POOL_IDLE_TIMEOUT	The time interval after which idle connections can be closed, shrinking the connection pool towards the minimum size.
static final Option<Integer>	LdapClients.CONNECTION_POOL_MAX_SIZE	The maximum size for the connection pool.
static final Option<Integer>	LdapClients.CONNECTION_POOL_MIN_SIZE	The minimum size for the connection pool.
static final Option<ScheduledExecutorService>	LdapClients.CONNECTION_POOL_SCHEDULER	Specifies the scheduler which will be used for periodically checking idle connections and timed-out connection attempts.
static final Option<DecodeOptions>	CommonLdapOptions.DECODE_OPTIONS	Sets the decoding options which will be used to control how requests and responses are decoded.
static final Option<DecodeOptions>	CommonLdapOptions.DECODE_OPTIONS	Sets the decoding options which will be used to control how requests and responses are decoded.
static final Option<DecodeOptions>	CommonLdapOptions.DECODE_OPTIONS	Sets the decoding options which will be used to control how requests and responses are decoded.
static final Option<Entries.DiffStrategy>	Entries.DIFF_STRATEGY	Defines the strategy to use to compute changes.
static final Option<BindRequest>	LdapClients.LDAP_CLIENT_AUTHN_BIND_REQUEST	Configures the BindRequest used for pre-authenticated connection or availability check made by load-balancers.
static final Option<Supplier<BindRequest>>	LdapClients.LDAP_CLIENT_AUTHN_BIND_REQUEST_FACTORY	Configures the BindRequest supplier used for pre-authenticated connection or availability checks made by load-balancers
static final Option<Boolean>	LdapClients.LDAP_CLIENT_ENABLE_PRE_AUTHENTICATION	Configures whether the connection factory must return pre-authenticated connections.
static final Option<Boolean>	LdapClients.LDAP_CLIENT_KEEP_ALIVE_ENABLED	Configures the connection factory to periodically send keep-alives to the Directory Server.
static final Option<Duration>	LdapClients.LDAP_CLIENT_KEEP_ALIVE_INTERVAL	Specifies the time between successive keep-alives (default interval is 300 seconds).
static final Option<ScheduledExecutorService>	LdapClients.LDAP_CLIENT_KEEP_ALIVE_SCHEDULER	Specifies the scheduler which will be used for periodically sending keep-alives.
static final Option<SearchRequest>	LdapClients.LDAP_CLIENT_KEEP_ALIVE_SEARCH_REQUEST	Specifies the parameters of the search request that will be used for keep-alives.
static final Option<Duration>	LdapClients.LDAP_CLIENT_KEEP_ALIVE_TIMEOUT	Specifies the timeout for keep-alives, after which the remote Directory Server will be deemed to be disconnected (default timeout is 3 seconds).
static final Option<Duration>	LdapClients.LDAP_CLIENT_REQUEST_TIMEOUT	Specifies the operation timeout.
static final 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 final Option<Duration>	LdapClients.LOAD_BALANCER_AVAILABILITY_CHECK_INTERVAL	Specifies the time between successive availability check requests (default interval is 5 seconds).
static final Option<SearchRequest>	LdapClients.LOAD_BALANCER_AVAILABILITY_CHECK_SEARCH_REQUEST	Specifies the parameters of the search request that will be used for availability check.
static final Option<Duration>	LdapClients.LOAD_BALANCER_AVAILABILITY_CHECK_TIMEOUT	Specifies the timeout for availability checks, after which the remote Directory Server will be deemed to be unavailable (default timeout is 3 seconds).
static final 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, or when the failover load-balancer performs a failover or a fallback.
static final Option<Set<Dn>>	LdapClients.LOAD_BALANCER_PARTITION_BASE_DNS	Specifies partition base DNs.
static final Option<ScheduledExecutorService>	LdapClients.LOAD_BALANCER_SCHEDULER	Specifies the scheduler which will be used for periodically reconnecting to offline LDAP clients.
static final Option<Integer>	LdapServer.MAX_CONCURRENT_REQUESTS	Specifies the maximum number of concurrent requests per connection.
static final Option<Integer>	CommonLdapOptions.MAX_MSG_SIZE_IN_BYTES	Specifies the maximum request size in bytes for incoming LDAP messages.
static final Option<Integer>	CommonLdapOptions.MAX_MSG_SIZE_IN_BYTES	Specifies the maximum request size in bytes for incoming LDAP messages.
static final Option<Integer>	CommonLdapOptions.MAX_MSG_SIZE_IN_BYTES	Specifies the maximum request size in bytes for incoming LDAP messages.
static final Option<IntConsumer>	CommonLdapOptions.PROBE_BYTES_READ	Callback invoked each time this server read bytes from the network.
static final Option<IntConsumer>	CommonLdapOptions.PROBE_BYTES_READ	Callback invoked each time this server read bytes from the network.
static final Option<IntConsumer>	CommonLdapOptions.PROBE_BYTES_READ	Callback invoked each time this server read bytes from the network.
static final Option<IntConsumer>	CommonLdapOptions.PROBE_BYTES_WRITTEN	Callback invoked each time this server write bytes to the network.
static final Option<IntConsumer>	CommonLdapOptions.PROBE_BYTES_WRITTEN	Callback invoked each time this server write bytes to the network.
static final Option<IntConsumer>	CommonLdapOptions.PROBE_BYTES_WRITTEN	Callback invoked each time this server write bytes to the network.
static final Option<ProxyProtocolHeader>	LdapClients.PROXY_PROTOCOL_HEADER_CLIENT	Enables the proxy protocol for client connections using the provided proxy header.
static final Option<Set<AddressMask>>	LdapServer.PROXY_PROTOCOL_SERVER_ALLOWED_CLIENTS	Specifies the clients that are allowed to access the server and that should use proxy protocol.
static final Option<Boolean>	LdapServer.PROXY_PROTOCOL_SERVER_ENABLED	Indicates if the proxy protocol is enabled on the server .
static final Option<Entries.ReplaceStrategy>	Entries.REPLACE_STRATEGY	Defines the strategy to use to generate changes.
static final Option<Integer>	CommonLdapOptions.SELECTOR_THREAD_COUNT	Specifies the number of threads which will be used to handle incoming network events.
static final Option<Integer>	CommonLdapOptions.SELECTOR_THREAD_COUNT	Specifies the number of threads which will be used to handle incoming network events.
static final Option<Integer>	CommonLdapOptions.SELECTOR_THREAD_COUNT	Specifies the number of threads which will be used to handle incoming network events.
static final Option<String>	CommonLdapOptions.SELECTOR_THREAD_NAME	Specifies the thread name used for selector threads.
static final Option<String>	CommonLdapOptions.SELECTOR_THREAD_NAME	Specifies the thread name used for selector threads.
static final Option<String>	CommonLdapOptions.SELECTOR_THREAD_NAME	Specifies the thread name used for selector threads.
static final Option<Boolean>	CommonLdapOptions.SO_KEEPALIVE	Specifies the value of the SO_KEEPALIVE socket option for new connections.
static final Option<Boolean>	CommonLdapOptions.SO_KEEPALIVE	Specifies the value of the SO_KEEPALIVE socket option for new connections.
static final Option<Boolean>	CommonLdapOptions.SO_KEEPALIVE	Specifies the value of the SO_KEEPALIVE socket option for new connections.
static final Option<Integer>	CommonLdapOptions.SO_LINGER_IN_SECONDS	Specifies the value of the SO_LINGER socket option for new connections.
static final Option<Integer>	CommonLdapOptions.SO_LINGER_IN_SECONDS	Specifies the value of the SO_LINGER socket option for new connections.
static final Option<Integer>	CommonLdapOptions.SO_LINGER_IN_SECONDS	Specifies the value of the SO_LINGER socket option for new connections.
static final Option<Boolean>	CommonLdapOptions.SO_REUSE_ADDRESS	Specifies the value of the SO_REUSEADDR socket option for new connections.
static final Option<Boolean>	CommonLdapOptions.SO_REUSE_ADDRESS	Specifies the value of the SO_REUSEADDR socket option for new connections.
static final Option<Boolean>	CommonLdapOptions.SO_REUSE_ADDRESS	Specifies the value of the SO_REUSEADDR socket option for new connections.
static final Option<SslOptions>	CommonLdapOptions.SSL_OPTIONS	Specifies the options to use for the SSL support or null if SSL is disabled.
static final Option<SslOptions>	CommonLdapOptions.SSL_OPTIONS	Specifies the options to use for the SSL support or null if SSL is disabled.
static final Option<SslOptions>	CommonLdapOptions.SSL_OPTIONS	Specifies the options to use for the SSL support or null if SSL is disabled.
static final Option<Boolean>	LdapConnectionFactory.SSL_USE_STARTTLS	Specifies whether SSL or StartTLS should be used for securing connections when an SSL context is specified.
static final Option<Boolean>	CommonLdapOptions.TCP_NO_DELAY	Specifies the value of the TCP_NODELAY socket option for new connections.
static final Option<Boolean>	CommonLdapOptions.TCP_NO_DELAY	Specifies the value of the TCP_NODELAY socket option for new connections.
static final Option<Boolean>	CommonLdapOptions.TCP_NO_DELAY	Specifies the value of the TCP_NODELAY socket option for new connections.
static final Option<String>	CommonLdapOptions.TRANSPORT	Specifies the name of the transport implementation to be used.
static final Option<String>	CommonLdapOptions.TRANSPORT	Specifies the name of the transport implementation to be used.
static final Option<String>	CommonLdapOptions.TRANSPORT	Specifies the name of the transport implementation to be used.
static final Option<Duration>	CommonLdapOptions.WRITE_TIMEOUT	Maximum time allowed for write operations to complete.
static final Option<Duration>	CommonLdapOptions.WRITE_TIMEOUT	Maximum time allowed for write operations to complete.
static final Option<Duration>	CommonLdapOptions.WRITE_TIMEOUT	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	Description
static final 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 final Option<Boolean>	SchemaOptions.ALLOW_MALFORMED_CERTIFICATES	Specifies whether the Certificate syntax should allow values which do not conform to the X.509 specifications.
static final Option<Boolean>	SchemaOptions.ALLOW_MALFORMED_CERTLISTS	Specifies whether the CertificateList syntax should allow values which do not conform to the X.509 specifications.
static final Option<Boolean>	SchemaOptions.ALLOW_MALFORMED_CERTPAIRS	Specifies whether the CertificatePair syntax should allow values which do not conform to the X.509 specifications.
static final 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 final Option<Boolean>	SchemaOptions.ALLOW_MALFORMED_NAMES_AND_OPTIONS	Specifies whether the schema should allow certain illegal characters in OIDs and attribute options.
static final Option<Boolean>	SchemaOptions.ALLOW_MALFORMED_POSTAL_ADDRESSES	Specifies whether the PostalAddress syntax should allow values which do not conform to the LDAP specifications.
static final 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 final Option<Boolean>	SchemaOptions.ALLOW_ZERO_LENGTH_DIRECTORY_STRINGS	Specifies whether zero-length values will be allowed by the Directory String syntax.
static final Option<String>	SchemaOptions.DEFAULT_MATCHING_RULE_OID	Specifies the OID of the default matching rule which will be used when parsing unrecognized attributes.
static final Option<String>	SchemaOptions.DEFAULT_SYNTAX_OID	Specifies the OID of the default syntax which will be used when parsing unrecognized attributes.
static final Option<Boolean>	SchemaOptions.STRICT_FORMAT_FOR_BOOLEAN	Indicates whether boolean values are required to strictly comply with the standard definition for this syntax.
static final 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 final 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 final 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	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	Description
static final Option<KeyStoreObjectCache>	KeyStoreParameters.CACHE	The caching mechanism that the key store will use.
static final Option<ExternalKeyWrappingStrategy>	KeyStoreParameters.EXTERNAL_KEY_WRAPPING_STRATEGY	An alternative external mechanism for wrapping private and secret keys in the key store.
static final Option<Factory<char[]>>	KeyStoreParameters.GLOBAL_PASSWORD	The optional password which is used to protect all private and secret keys.
static final Option<Integer>	KeyStoreParameters.PBKDF2_ITERATIONS	The number of iterations to use when deriving encryption keys from passwords using PBKDF2.
static final 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	Description
static final Option<Clock>	SecretStore.CLOCK	Specifies the clock to use when making time comparisons.
static final Option<Boolean>	SecretsTrustManager.ENABLE_REVOCATION_CHECKING	Whether the trust manager should perform recovation checking or not.
static final Option<String>	SecretsKeyManager.KEY_MANAGER_ALGORITHM	The algorithm of the underlying X509ExtendedKeyManager implementation to use.
static final Option<Duration>	SecretStore.LEASE_EXPIRY_DURATION	Option used to specify how long secrets from a store should be used before being refreshed.
static final Option<EnumSet<PKIXRevocationChecker.Option>>	SecretsTrustManager.REVOCATION_OPTIONS	The options to pass to the revocation checker, if revocation checking is enabled.
static final 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.

Uses of Option in org.opends.server.schema

Methods in org.opends.server.schema with parameters of type Option

Modifier and Type	Method	Description
<T> void	SchemaHandler.updateSchemaOption(Option<T> option, T newValue)	Updates the schema option if the new value differs from the old value.