Uses of Class
org.forgerock.util.Option
Packages that use Option
Package
Description
Contains the Service Discovery Mechanisms and APIs.
Classes and interfaces for core types including connections, entries, and
attributes.
Classes and interfaces for constructing and querying LDAP schemas.
APIs for implementing REST to LDAP gateways.
This package contains LDAP schema syntaxes and matching rules for JSON based attributes.
An LDAP based security provider having the name "OpenDJ" and exposing an LDAP/LDIF based
KeyStore service.Provides a unified API for accessing secrets of various kinds.
Provides common interfaces and classes.
Contains implementations of various Directory Server schema elements.
-
Uses of Option in org.forgerock.opendj.discovery
Fields in org.forgerock.opendj.discovery declared as OptionModifier and TypeFieldDescriptionstatic final Option<BindRequest>ReplicationServiceDiscoveryMechanism.BIND_REQUESTThe bind request to use to perform service discovery when connecting to servers.ReplicationServiceDiscoveryMechanism.BOOTSTRAP_REPLICATION_SERVERSThe addresses of one or more replication servers within the topology which this server should connect to in order to discover the rest of the topology.PeriodicServiceDiscoveryMechanism.DISCOVERY_INTERVALInterval between two replication server configuration discovery queries.PeriodicServiceDiscoveryMechanism.DISCOVERY_INTERVALInterval between two replication server configuration discovery queries.static final Option<Supplier<ScheduledExecutorService>>PeriodicServiceDiscoveryMechanism.EXECUTOR_SERVICEThe scheduled executor service where service discovery is scheduled.static final Option<Supplier<ScheduledExecutorService>>PeriodicServiceDiscoveryMechanism.EXECUTOR_SERVICEThe scheduled executor service where service discovery is scheduled.ReplicationServiceDiscoveryMechanism.PRIMARY_GROUP_IDReplication domain group ID of preferred directory server replicas.StaticServiceDiscoveryMechanism.PRIMARY_SERVERSSpecifies a list of servers that will be used in preference to secondary servers when available.StaticServiceDiscoveryMechanism.SECONDARY_SERVERSSpecifies a list of servers that will be used in place of primary servers when all primary servers are unavailable. -
Uses of Option in org.forgerock.opendj.ldap
Fields in org.forgerock.opendj.ldap declared as OptionModifier and TypeFieldDescriptionLdapServer.ACCEPTED_CLIENT_VALIDATORA 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_FILTERSelects which attributes will be compared.static final Option<BindRequest>LdapConnectionFactory.AUTHN_BIND_REQUESTConfigures the connection factory to return pre-authenticated connections using the specifiedBindRequest.static final Option<Supplier<BindRequest>>LdapConnectionFactory.AUTHN_BIND_REQUEST_FACTORYConfigures the connection factory to return pre-authenticated connections usingBindRequestprovided by the specifiedSupplier.CommonLdapOptions.BUFFER_SIZESize of the buffer used when reading/writing data from/to the network.CommonLdapOptions.BUFFER_SIZESize of the buffer used when reading/writing data from/to the network.CommonLdapOptions.BUFFER_SIZESize of the buffer used when reading/writing data from/to the network.LdapServer.CONNECT_MAX_BACKLOGSpecifies the maximum queue length for incoming connections requests.LdapClients.CONNECT_TIMEOUTSpecifies the connect timeout.static final Option<ConnectionPoolEventListener>LdapClients.CONNECTION_POOL_EVENT_LISTENERSpecifies the event listener which should be notified whenever an event occurs in a connection pool.LdapClients.CONNECTION_POOL_IDLE_TIMEOUTThe time interval after which idle connections can be closed, shrinking the connection pool towards theminimum size.LdapClients.CONNECTION_POOL_MAX_SIZEThe maximum size for the connection pool.LdapClients.CONNECTION_POOL_MIN_SIZEThe minimum size for the connection pool.static final Option<ScheduledExecutorService>LdapClients.CONNECTION_POOL_SCHEDULERSpecifies the scheduler which will be used for periodically checking idle connections and timed-out connection attempts.static final Option<DecodeOptions>CommonLdapOptions.DECODE_OPTIONSSets the decoding options which will be used to control how requests and responses are decoded.static final Option<DecodeOptions>CommonLdapOptions.DECODE_OPTIONSSets the decoding options which will be used to control how requests and responses are decoded.static final Option<DecodeOptions>CommonLdapOptions.DECODE_OPTIONSSets the decoding options which will be used to control how requests and responses are decoded.static final Option<Entries.DiffStrategy>Entries.DIFF_STRATEGYDefines the strategy to use to compute changes.static final Option<BindRequest>LdapClients.LDAP_CLIENT_AUTHN_BIND_REQUESTConfigures theBindRequestused for pre-authenticated connection or availability check made by load-balancers.static final Option<Supplier<BindRequest>>LdapClients.LDAP_CLIENT_AUTHN_BIND_REQUEST_FACTORYConfigures theBindRequestsupplier used for pre-authenticated connection or availability checks made by load-balancersLdapClients.LDAP_CLIENT_ENABLE_PRE_AUTHENTICATIONConfigures whether the connection factory must return pre-authenticated connections.LdapClients.LDAP_CLIENT_KEEP_ALIVE_ENABLEDConfigures the connection factory to periodically send keep-alives to the Directory Server.LdapClients.LDAP_CLIENT_KEEP_ALIVE_INTERVALSpecifies the time between successive keep-alives (default interval is 300 seconds).static final Option<ScheduledExecutorService>LdapClients.LDAP_CLIENT_KEEP_ALIVE_SCHEDULERSpecifies the scheduler which will be used for periodically sending keep-alives.static final Option<SearchRequest>LdapClients.LDAP_CLIENT_KEEP_ALIVE_SEARCH_REQUESTSpecifies the parameters of the search request that will be used for keep-alives.LdapClients.LDAP_CLIENT_KEEP_ALIVE_TIMEOUTSpecifies the timeout for keep-alives, after which the remote Directory Server will be deemed to be disconnected (default timeout is 3 seconds).LdapClients.LDAP_CLIENT_REQUEST_TIMEOUTSpecifies the operation timeout.LdapClients.LDAP_CLIENT_SSL_USE_STARTTLSSpecifies whether SSL or StartTLS should be used for securing connections when an SSL context is specified.LdapClients.LOAD_BALANCER_AVAILABILITY_CHECK_INTERVALSpecifies the time between successive availability check requests (default interval is 5 seconds).static final Option<SearchRequest>LdapClients.LOAD_BALANCER_AVAILABILITY_CHECK_SEARCH_REQUESTSpecifies the parameters of the search request that will be used for availability check.LdapClients.LOAD_BALANCER_AVAILABILITY_CHECK_TIMEOUTSpecifies 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<Collection<Dn>>LdapClients.LOAD_BALANCER_BASE_DNSSpecifies the base DN(s) for the data that the ldap service handles.static final Option<LoadBalancerEventListener>LdapClients.LOAD_BALANCER_EVENT_LISTENERSpecifies the event listener which should be notified whenever a load-balanced LDAP client changes state from online to offline or vice-versa.static final Option<IntUnaryOperator>LdapClients.LOAD_BALANCER_IDLE_SERVER_SELECTORDeprecated.For internal use only.LdapClients.LOAD_BALANCER_PARTITION_BASE_DNSSpecifies partition base DNs.static final Option<ScheduledExecutorService>LdapClients.LOAD_BALANCER_SCHEDULERSpecifies the scheduler which will be used for periodically reconnecting to offline LDAP clients.LdapServer.MAX_CONCURRENT_REQUESTSSpecifies the maximum number of concurrent requests per connection.CommonLdapOptions.MAX_MSG_SIZE_IN_BYTESSpecifies the maximum request size in bytes for incoming LDAP messages.CommonLdapOptions.MAX_MSG_SIZE_IN_BYTESSpecifies the maximum request size in bytes for incoming LDAP messages.CommonLdapOptions.MAX_MSG_SIZE_IN_BYTESSpecifies the maximum request size in bytes for incoming LDAP messages.static final Option<IntConsumer>CommonLdapOptions.PROBE_BYTES_READCallback invoked each time this server read bytes from the network.static final Option<IntConsumer>CommonLdapOptions.PROBE_BYTES_READCallback invoked each time this server read bytes from the network.static final Option<IntConsumer>CommonLdapOptions.PROBE_BYTES_READCallback invoked each time this server read bytes from the network.static final Option<IntConsumer>CommonLdapOptions.PROBE_BYTES_WRITTENCallback invoked each time this server write bytes to the network.static final Option<IntConsumer>CommonLdapOptions.PROBE_BYTES_WRITTENCallback invoked each time this server write bytes to the network.static final Option<IntConsumer>CommonLdapOptions.PROBE_BYTES_WRITTENCallback invoked each time this server write bytes to the network.static final Option<ProxyProtocolHeader>LdapClients.PROXY_PROTOCOL_HEADER_CLIENTEnables the proxy protocol for client connections using the provided proxy header.static final Option<Set<AddressMask>>LdapServer.PROXY_PROTOCOL_SERVER_ALLOWED_CLIENTSSpecifies the clients that are allowed to access the server and that should use proxy protocol.LdapServer.PROXY_PROTOCOL_SERVER_ENABLEDIndicates if the proxy protocol is enabled on the server .static final Option<Entries.ReplaceStrategy>Entries.REPLACE_STRATEGYDefines the strategy to use to generate changes.CommonLdapOptions.SELECTOR_THREAD_COUNTSpecifies the number of threads which will be used to handle incoming network events.CommonLdapOptions.SELECTOR_THREAD_COUNTSpecifies the number of threads which will be used to handle incoming network events.CommonLdapOptions.SELECTOR_THREAD_COUNTSpecifies the number of threads which will be used to handle incoming network events.CommonLdapOptions.SELECTOR_THREAD_NAMESpecifies the thread name used for selector threads.CommonLdapOptions.SELECTOR_THREAD_NAMESpecifies the thread name used for selector threads.CommonLdapOptions.SELECTOR_THREAD_NAMESpecifies the thread name used for selector threads.CommonLdapOptions.SO_KEEPALIVESpecifies the value of theSO_KEEPALIVEsocket option for new connections.CommonLdapOptions.SO_KEEPALIVESpecifies the value of theSO_KEEPALIVEsocket option for new connections.CommonLdapOptions.SO_KEEPALIVESpecifies the value of theSO_KEEPALIVEsocket option for new connections.CommonLdapOptions.SO_LINGER_IN_SECONDSSpecifies the value of theSO_LINGERsocket option for new connections.CommonLdapOptions.SO_LINGER_IN_SECONDSSpecifies the value of theSO_LINGERsocket option for new connections.CommonLdapOptions.SO_LINGER_IN_SECONDSSpecifies the value of theSO_LINGERsocket option for new connections.CommonLdapOptions.SO_REUSE_ADDRESSSpecifies the value of theSO_REUSEADDRsocket option for new connections.CommonLdapOptions.SO_REUSE_ADDRESSSpecifies the value of theSO_REUSEADDRsocket option for new connections.CommonLdapOptions.SO_REUSE_ADDRESSSpecifies the value of theSO_REUSEADDRsocket option for new connections.static final Option<SslOptions>CommonLdapOptions.SSL_OPTIONSSpecifies the options to use for the SSL support ornullif SSL is disabled.static final Option<SslOptions>CommonLdapOptions.SSL_OPTIONSSpecifies the options to use for the SSL support ornullif SSL is disabled.static final Option<SslOptions>CommonLdapOptions.SSL_OPTIONSSpecifies the options to use for the SSL support ornullif SSL is disabled.LdapConnectionFactory.SSL_USE_STARTTLSSpecifies whether SSL or StartTLS should be used for securing connections when an SSL context is specified.CommonLdapOptions.TCP_NO_DELAYSpecifies the value of theTCP_NODELAYsocket option for new connections.CommonLdapOptions.TCP_NO_DELAYSpecifies the value of theTCP_NODELAYsocket option for new connections.CommonLdapOptions.TCP_NO_DELAYSpecifies the value of theTCP_NODELAYsocket option for new connections.CommonLdapOptions.TRANSPORTSpecifies the name of the transport implementation to be used.CommonLdapOptions.TRANSPORTSpecifies the name of the transport implementation to be used.CommonLdapOptions.TRANSPORTSpecifies the name of the transport implementation to be used.CommonLdapOptions.WRITE_TIMEOUTMaximum time allowed for write operations to complete.CommonLdapOptions.WRITE_TIMEOUTMaximum time allowed for write operations to complete.CommonLdapOptions.WRITE_TIMEOUTMaximum 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 OptionModifier and TypeFieldDescriptionSchemaOptions.ALLOW_ATTRIBUTE_TYPES_WITH_NO_SUP_OR_SYNTAXSpecifies whether the schema should allow attribute type definitions that do not declare a superior attribute type or syntax.SchemaOptions.ALLOW_MALFORMED_CERTIFICATESSpecifies whether the Certificate syntax should allow values which do not conform to the X.509 specifications.SchemaOptions.ALLOW_MALFORMED_CERTLISTSSpecifies whether the CertificateList syntax should allow values which do not conform to the X.509 specifications.SchemaOptions.ALLOW_MALFORMED_CERTPAIRSSpecifies whether the CertificatePair syntax should allow values which do not conform to the X.509 specifications.SchemaOptions.ALLOW_MALFORMED_JPEG_PHOTOSSpecifies whether the JPEG Photo syntax should allow values which do not conform to the JFIF or Exif specifications.SchemaOptions.ALLOW_MALFORMED_NAMES_AND_OPTIONSSpecifies whether the schema should allow certain illegal characters in OIDs and attribute options.SchemaOptions.ALLOW_MALFORMED_POSTAL_ADDRESSESSpecifies whether the PostalAddress syntax should allow values which do not conform to the LDAP specifications.SchemaOptions.ALLOW_NON_STANDARD_TELEPHONE_NUMBERSSpecifies whether the Telephone Number syntax should allow values which do not conform to the E.123 international telephone number format.SchemaOptions.ALLOW_ZERO_LENGTH_DIRECTORY_STRINGSSpecifies whether zero-length values will be allowed by the Directory String syntax.SchemaOptions.DEFAULT_MATCHING_RULE_OIDSpecifies the OID of the default matching rule which will be used when parsing unrecognized attributes.SchemaOptions.DEFAULT_SYNTAX_OIDSpecifies the OID of the default syntax which will be used when parsing unrecognized attributes.SchemaOptions.STRICT_FORMAT_FOR_BOOLEANIndicates whether boolean values are required to strictly comply with the standard definition for this syntax.SchemaOptions.STRICT_FORMAT_FOR_COUNTRY_STRINGSIndicates whether country code values are required to strictly comply with the standard definition for this syntax.SchemaOptions.STRIP_UPPER_BOUND_FOR_ATTRIBUTE_TYPEIndicates 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_HANDLERSpecifies 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 OptionModifier and TypeMethodDescription<T> TReturns the value associated to the providedOptionor the option default value, if there is no such option in this schema.<T> SchemaBuilderSets 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 OptionModifier and TypeFieldDescriptionstatic final Option<DecodeOptions>Rest2Ldap.DECODE_OPTIONSSpecifies the LDAP decoding options which should be used when decoding LDAP DNs, attribute types, and controls.Rest2Ldap.IN_INVOKER_THREADSpecifies whether the Rest2Ldap transformations should be performed in the invoker thread rather than I/O thread.Rest2Ldap.LOAD_SCHEMASpecifies whether the LDAP schema should be loaded from the LDAP server before being able to serve requests.Rest2Ldap.LOCAL_SORT_MAX_ENTRIESSpecifies the maximum number of entries supported by the local sort mechanism.Rest2Ldap.MVCC_ATTRIBUTESpecifies the name of the LDAP attribute which should be used for multi-version concurrency control (MVCC) ifenabled.static final Option<ReadOnUpdatePolicy>Rest2Ldap.READ_ON_UPDATE_POLICYSpecifies the policy which should be used in order to read an entry before it is deleted, or after it is added or modified.Rest2Ldap.RETURN_NULL_FOR_MISSING_PROPERTIESSpecifies whether Rest2Ldap should represent missing JSON property values usingnull.static final Option<ScheduledExecutorService>Rest2Ldap.SCHEDULERSpecifies the scheduler which will be used for periodically detecting changes to LDAP schema.Rest2Ldap.SCHEMA_RELOAD_INTERVALSpecifies the interval between successive attempts to detect changes in LDAP schema.Rest2Ldap.SCHEMA_RETRY_INTERVALSpecifies the interval between failed attempts to load the remote schema.Rest2Ldap.USE_MVCCSpecifies whether Rest2Ldap should support multi-version concurrency control (MVCC) through the use of an MVCC LDAPattributesuch as "etag".Rest2Ldap.USE_PERMISSIVE_MODIFYSpecifies whether Rest2Ldap should perform LDAP modify operations using the LDAP permissive modify control.Rest2Ldap.USE_SERVER_SIDE_SORT_FOR_JSONSpecifies whether Rest2Ldap should use server side sort control for LDAP attribute containing JSON.Rest2Ldap.USE_SUBTREE_DELETESpecifies 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 OptionModifier and TypeFieldDescriptionJsonSchema.CASE_SENSITIVE_STRINGSMatching rule option controlling whether JSON string comparisons should be case-sensitive.JsonSchema.IGNORE_WHITE_SPACEMatching rule option controlling whether JSON string comparisons should ignore white-space.static final Option<Collection<String>>JsonSchema.INDEXED_FIELD_PATTERNSMatching rule option controlling which JSON fields should be indexed by the matching rule.static final Option<JsonSchema.ValidationPolicy>JsonSchema.VALIDATION_POLICYSchema option controlling syntax validation for JSON based attributes. -
Uses of Option in org.forgerock.opendj.security
Fields in org.forgerock.opendj.security declared as OptionModifier and TypeFieldDescriptionstatic final Option<KeyStoreObjectCache>KeyStoreParameters.CACHEThe caching mechanism that the key store will use.static final Option<ExternalKeyWrappingStrategy>KeyStoreParameters.EXTERNAL_KEY_WRAPPING_STRATEGYAn alternative external mechanism for wrapping private and secret keys in the key store.KeyStoreParameters.GLOBAL_PASSWORDThe optional password which is used to protect all private and secret keys.KeyStoreParameters.PBKDF2_ITERATIONSThe number of iterations to use when deriving encryption keys from passwords using PBKDF2.KeyStoreParameters.PBKDF2_SALT_SIZEThe 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 OptionModifier and TypeFieldDescriptionSecretStore.CLOCKSpecifies the clock to use when making time comparisons.SecretsTrustManager.ENABLE_REVOCATION_CHECKINGWhether the trust manager should perform recovation checking or not.SecretsKeyManager.KEY_MANAGER_ALGORITHMThe algorithm of the underlyingX509ExtendedKeyManagerimplementation to use.SecretStore.LEASE_EXPIRY_DURATIONOption used to specify how long secrets from a store should be used before being refreshed.static final Option<EnumSet<PKIXRevocationChecker.Option>>SecretsTrustManager.REVOCATION_OPTIONSThe options to pass to the revocation checker, if revocation checking is enabled.SecretsTrustManager.TRUST_MANAGER_ALGORITHMAlgorithm to use for looking up the underlying X509ExtendedTrustManager. -
Uses of Option in org.forgerock.util
Methods in org.forgerock.util that return OptionModifier and TypeMethodDescriptionstatic <T> Option<T>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.Option.withDefault(T defaultValue) Defines a boolean option with the provided default value.Methods in org.forgerock.util with parameters of type Option -
Uses of Option in org.opends.server.schema
Methods in org.opends.server.schema with parameters of type OptionModifier and TypeMethodDescription<T> voidSchemaHandler.updateSchemaOption(Option<T> option, T newValue) Updates the schema option if the new value differs from the old value.