Uses of Class
org.forgerock.util.Option

Packages that use Option

Package	Description
org.forgerock.json.jose.jwe.handlers.encryption	Encryption Handler classes for each possible encryption algorithm.
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.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.util	Provides common interfaces and classes.
org.opends.server.replication.server.changelog.api	This package contains the API for the changelog database.
org.opends.server.schema	Contains implementations of various Directory Server schema elements.

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.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.rest2ldap

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

Modifier and Type	Field and Description
static Option<DecodeOptions>	Rest2Ldap.DECODE_OPTIONS Specifies the LDAP decoding options which should be used when decoding LDAP DNs, attribute types, and controls.
static Option<Integer>	Rest2Ldap.LOCAL_SORT_MAX_ENTRIES Specifies the maximum number of entries supported by the local sort mechanism.
static Option<String>	Rest2Ldap.MVCC_ATTRIBUTE Specifies the name of the LDAP attribute which should be used for multi-version concurrency control (MVCC) if enabled.
static Option<ReadOnUpdatePolicy>	Rest2Ldap.READ_ON_UPDATE_POLICY Specifies the policy which should be used in order to read an entry before it is deleted, or after it is added or modified.
static Option<Boolean>	Rest2Ldap.RETURN_NULL_FOR_MISSING_PROPERTIES Specifies whether Rest2Ldap should represent missing JSON property values using null.
static Option<Boolean>	Rest2Ldap.USE_MVCC Specifies whether Rest2Ldap should support multi-version concurrency control (MVCC) through the use of an MVCC LDAP attribute such as "etag".
static Option<Boolean>	Rest2Ldap.USE_PERMISSIVE_MODIFY Specifies whether Rest2Ldap should perform LDAP modify operations using the LDAP permissive modify control.
static Option<Boolean>	Rest2Ldap.USE_SERVER_SIDE_SORT_FOR_JSON Specifies whether Rest2Ldap should use server side sort control for LDAP attribute containing JSON.
static Option<Boolean>	Rest2Ldap.USE_SUBTREE_DELETE Specifies whether Rest2Ldap should perform LDAP delete operations using the LDAP subtree delete control.

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

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

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

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.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.

Uses of Option in org.opends.server.replication.server.changelog.api

Fields in org.opends.server.replication.server.changelog.api declared as Option

Modifier and Type	Field and Description
static Option<CSN>	ReplicationDomainDB.DEFAULT_CSN Option to specify the default CSN when reading changes, when there is no CSN for the start state of a replica.
static Option<Set<Dn>>	ReplicationDomainDB.EXCLUDED_BASE_DNS Option to specify the set of base DNs to exclude when reading changes.
static Option<Set<DomainReplicaId>>	ReplicationDomainDB.EXCLUDED_REPLICAS Option to specify the set of replicaIds to exclude when reading changes.
static Option<Set<Dn>>	ReplicationDomainDB.INCLUDED_BASE_DNS Option to specify the set of base DNs to include when reading changes.
static Option<Set<DomainReplicaId>>	ReplicationDomainDB.INCLUDED_REPLICAS Option to specify the set of replicaIds to include when reading changes.
static Option<DBCursor.PositionStrategy>	ReplicationDomainDB.POSITION_STRATEGY Option to specify the position strategy to use when reading changes.

Uses of Option in org.opends.server.schema

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

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