Uses of Class
org.forgerock.util.Option
Package
Description
This package contains the SAML2 SSO APIs.
Core
Handler
implementations.Encryption Handler classes for each possible encryption algorithm.
This package contains utility methods to ease/unify development when using the OpenDJ LDAP SDK.
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.
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.
-
Uses of Option in org.forgerock.am.cts.api
Modifier and TypeFieldDescriptionstatic final Option<TokenFilter>
CTSOptions.ASSERTION_REQUEST_OPTION
Signals the CTS to perform an assertion using the providedTokenFilter
before performing the requested operation.CTSOptions.ETAG_ASSERT_OPTION
Signals to the CTS backing implementation to assert that the CTS entry being updated still has the givenETag
before applying the requested modification to it.CTSOptions.ETAG_READ_OPTION
Signals to the CTS backing implementation to include the result of an optimistic concurrency ETag in the response for this request.static final Option<CoreTokenField[]>
CTSOptions.PRE_DELETE_READ_OPTION
Signals the CTS to perform a read of a CTS token on delete.CTSOptions.VLV_SORT_ATTRIBUTE
Signals the CTS to utilise a pre-registered VLV-index based query, with the provided sort order.Modifier and TypeMethodDescriptionstatic <T> Options
CTSOptions.singleOption
(Option<T> option, T value) -
Uses of Option in org.forgerock.am.saml2.api
Modifier and TypeFieldDescriptionSaml2Options.ALLOW_CREATE
Whether the identity provider is allowed to create a new NameID value for the user.static final Option<AuthComparison>
Saml2Options.AUTH_COMPARISON
The comparison method the identity provider should use when determining the authentication method.Saml2Options.AUTH_CONTEXT_CLASS_REF
The authentication context class reference.Saml2Options.AUTH_CONTEXT_DECL_REF
The authentication context declaration reference.Saml2Options.FORCE_AUTHN
Whether the IDP should force re-authentication of the user.Saml2Options.IS_PASSIVE
Whether the IDP should silently check if the user is already authenticated.Saml2Options.NAME_ID_FORMAT
The NameID Format the IDP should use when constructing the assertion.Saml2Options.REQUEST_BINDING
The request binding AM should use when sending the authentication request.Saml2Options.RESPONSE_BINDING
The binding the IDP should use when returning the SAML response. -
Uses of Option in org.forgerock.http.handler
Modifier and TypeFieldDescriptionHttpClientHandler.OPTION_CONNECT_TIMEOUT
The TCP connect timeout for new HTTP connections.HttpClientHandler.OPTION_DISABLE_CONNECTION_STATE
This option is only taken into account whenOPTION_REUSE_CONNECTIONS
is also set to true.static final Option<HttpClientHandler.HostnameVerifier>
HttpClientHandler.OPTION_HOSTNAME_VERIFIER
Specifies the SSL host name verification policy.static final Option<KeyManagerFactory>
HttpClientHandler.OPTION_KEY_MANAGER_FACTORY
Specifies the key manager factory that should be used when configuring SSL/TLS connections.static final Option<KeyManager[]>
HttpClientHandler.OPTION_KEY_MANAGERS
Specifies the list of key managers that should be used when configuring SSL/TLS connections.HttpClientHandler.OPTION_LOADER
The strategy which should be used for loading theHttpClientProvider
.HttpClientHandler.OPTION_MAX_CONNECTIONS
Specifies the maximum number of connections that should be pooled by the HTTP client.HttpClientHandler.OPTION_NON_PROXY_HOSTS
Specifies the list of hosts for which requests should not be proxied.HttpClientHandler.OPTION_POOLED_CONNECTION_TTL
Specifies the time to live (expiry time) in milliseconds of connections from the pool.static final Option<HttpClientHandler.ProxyInfo>
HttpClientHandler.OPTION_PROXY
Specifies a proxy to use for requests by the HTTP Client.HttpClientHandler.OPTION_PROXY_SYSTEM
Specifies that the system defined proxy should be used for requests by the HTTP Client.HttpClientHandler.OPTION_RETRY_REQUESTS
Specifies whether requests should be retried if a failure is detected.HttpClientHandler.OPTION_REUSE_CONNECTIONS
Specifies whether HTTP connections should be kept alive and reused for additional requests.HttpClientHandler.OPTION_SO_TIMEOUT
The TCP socket timeout when waiting for HTTP responses.HttpClientHandler.OPTION_SSL_CIPHER_SUITES
List of JSSE ciphers to be enabled on the HttpClient.HttpClientHandler.OPTION_SSL_ENABLED_PROTOCOLS
List of SSL protocols to be enabled on the HttpClient.HttpClientHandler.OPTION_SSLCONTEXT_ALGORITHM
SSLContext algorithm to be used when making SSL/TLS connections.HttpClientHandler.OPTION_TEMPORARY_STORAGE
Specifies the temporary storage that should be used for storing HTTP responses.static final Option<TrustManagerFactory>
HttpClientHandler.OPTION_TRUST_MANAGER_FACTORY
Specifies the trust manager factory that should be used when configuring SSL/TLS connections.static final 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
Modifier and TypeFieldDescriptionRSAEncryptionHandler.USE_WRAP_UNWRAP_OPERATIONS
Indicates whether the handler should useCipher.wrap(Key)
andCipher.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
Modifier and TypeFieldDescriptionLDAPUtils.AFFINITY_ENABLED
AnOption
that tells whether affinity based load balancing is enabled for the connections.static final Option<LDAPUtils.CachedPoolOptions>
LDAPUtils.CACHED_POOL_OPTIONS
AnOption
that stores the settings related to cached connection pooling. -
Uses of Option in org.forgerock.opendj.discovery
Modifier and TypeFieldDescriptionstatic final Option<BindRequest>
ReplicationServiceDiscoveryMechanism.BIND_REQUEST
The bind request to use to perform service discovery when connecting to servers.ReplicationServiceDiscoveryMechanism.BOOTSTRAP_REPLICATION_SERVERS
The 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_INTERVAL
Interval between two replication server configuration discovery queries.PeriodicServiceDiscoveryMechanism.DISCOVERY_INTERVAL
Interval between two replication server configuration discovery queries.static final Option<Supplier<ScheduledExecutorService>>
PeriodicServiceDiscoveryMechanism.EXECUTOR_SERVICE
The scheduled executor service where service discovery is scheduled.static final Option<Supplier<ScheduledExecutorService>>
PeriodicServiceDiscoveryMechanism.EXECUTOR_SERVICE
The scheduled executor service where service discovery is scheduled.ReplicationServiceDiscoveryMechanism.PRIMARY_GROUP_ID
Replication domain group ID of preferred directory server replicas.StaticServiceDiscoveryMechanism.PRIMARY_SERVERS
Specifies a list of servers that will be used in preference to secondary servers when available.StaticServiceDiscoveryMechanism.SECONDARY_SERVERS
Specifies 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
Modifier and TypeFieldDescriptionLdapServer.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 specifiedBindRequest
.static final Option<Supplier<BindRequest>>
LdapConnectionFactory.AUTHN_BIND_REQUEST_FACTORY
Configures the connection factory to return pre-authenticated connections usingBindRequest
provided by the specifiedSupplier
.CommonLdapOptions.BUFFER_SIZE
Size of the buffer used when reading/writing data from/to the network.CommonLdapOptions.BUFFER_SIZE
Size of the buffer used when reading/writing data from/to the network.CommonLdapOptions.BUFFER_SIZE
Size of the buffer used when reading/writing data from/to the network.LdapServer.CONNECT_MAX_BACKLOG
Specifies the maximum queue length for incoming connections requests.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.LdapClients.CONNECTION_POOL_IDLE_TIMEOUT
The time interval after which idle connections can be closed, shrinking the connection pool towards theminimum size
.LdapClients.CONNECTION_POOL_MAX_SIZE
The maximum size for the connection pool.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 theBindRequest
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 theBindRequest
supplier used for pre-authenticated connection or availability checks made by load-balancersLdapClients.LDAP_CLIENT_ENABLE_PRE_AUTHENTICATION
Configures whether the connection factory must return pre-authenticated connections.LdapClients.LDAP_CLIENT_KEEP_ALIVE_ENABLED
Configures the connection factory to periodically send keep-alives to the Directory Server.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.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).LdapClients.LDAP_CLIENT_REQUEST_TIMEOUT
Specifies the operation timeout.LdapClients.LDAP_CLIENT_SSL_USE_STARTTLS
Specifies whether SSL or StartTLS should be used for securing connections when an SSL context is specified.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.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<Collection<Dn>>
LdapClients.LOAD_BALANCER_BASE_DNS
Specifies the base DN(s) for the data that the ldap service handles.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.static final Option<IntUnaryOperator>
LdapClients.LOAD_BALANCER_IDLE_SERVER_SELECTOR
Deprecated.For internal use only.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.LdapServer.MAX_CONCURRENT_REQUESTS
Specifies the maximum number of concurrent requests per connection.CommonLdapOptions.MAX_MSG_SIZE_IN_BYTES
Specifies the maximum request size in bytes for incoming LDAP messages.CommonLdapOptions.MAX_MSG_SIZE_IN_BYTES
Specifies the maximum request size in bytes for incoming LDAP messages.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.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.CommonLdapOptions.SELECTOR_THREAD_COUNT
Specifies the number of threads which will be used to handle incoming network events.CommonLdapOptions.SELECTOR_THREAD_COUNT
Specifies the number of threads which will be used to handle incoming network events.CommonLdapOptions.SELECTOR_THREAD_COUNT
Specifies the number of threads which will be used to handle incoming network events.CommonLdapOptions.SELECTOR_THREAD_NAME
Specifies the thread name used for selector threads.CommonLdapOptions.SELECTOR_THREAD_NAME
Specifies the thread name used for selector threads.CommonLdapOptions.SELECTOR_THREAD_NAME
Specifies the thread name used for selector threads.CommonLdapOptions.SO_KEEPALIVE
Specifies the value of theSO_KEEPALIVE
socket option for new connections.CommonLdapOptions.SO_KEEPALIVE
Specifies the value of theSO_KEEPALIVE
socket option for new connections.CommonLdapOptions.SO_KEEPALIVE
Specifies the value of theSO_KEEPALIVE
socket option for new connections.CommonLdapOptions.SO_LINGER_IN_SECONDS
Specifies the value of theSO_LINGER
socket option for new connections.CommonLdapOptions.SO_LINGER_IN_SECONDS
Specifies the value of theSO_LINGER
socket option for new connections.CommonLdapOptions.SO_LINGER_IN_SECONDS
Specifies the value of theSO_LINGER
socket option for new connections.CommonLdapOptions.SO_REUSE_ADDRESS
Specifies the value of theSO_REUSEADDR
socket option for new connections.CommonLdapOptions.SO_REUSE_ADDRESS
Specifies the value of theSO_REUSEADDR
socket option for new connections.CommonLdapOptions.SO_REUSE_ADDRESS
Specifies the value of theSO_REUSEADDR
socket option for new connections.static final Option<SslOptions>
CommonLdapOptions.SSL_OPTIONS
Specifies the options to use for the SSL support ornull
if SSL is disabled.static final Option<SslOptions>
CommonLdapOptions.SSL_OPTIONS
Specifies the options to use for the SSL support ornull
if SSL is disabled.static final Option<SslOptions>
CommonLdapOptions.SSL_OPTIONS
Specifies the options to use for the SSL support ornull
if SSL is disabled.LdapConnectionFactory.SSL_USE_STARTTLS
Specifies whether SSL or StartTLS should be used for securing connections when an SSL context is specified.CommonLdapOptions.TCP_NO_DELAY
Specifies the value of theTCP_NODELAY
socket option for new connections.CommonLdapOptions.TCP_NO_DELAY
Specifies the value of theTCP_NODELAY
socket option for new connections.CommonLdapOptions.TCP_NO_DELAY
Specifies the value of theTCP_NODELAY
socket option for new connections.CommonLdapOptions.TRANSPORT
Specifies the name of the transport implementation to be used.CommonLdapOptions.TRANSPORT
Specifies the name of the transport implementation to be used.CommonLdapOptions.TRANSPORT
Specifies the name of the transport implementation to be used.CommonLdapOptions.WRITE_TIMEOUT
Maximum time allowed for write operations to complete.CommonLdapOptions.WRITE_TIMEOUT
Maximum time allowed for write operations to complete.CommonLdapOptions.WRITE_TIMEOUT
Maximum time allowed for write operations to complete. -
Uses of Option in org.forgerock.opendj.ldap.schema
Modifier and TypeFieldDescriptionSchemaOptions.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.SchemaOptions.ALLOW_MALFORMED_CERTIFICATES
Specifies whether the Certificate syntax should allow values which do not conform to the X.509 specifications.SchemaOptions.ALLOW_MALFORMED_CERTLISTS
Specifies whether the CertificateList syntax should allow values which do not conform to the X.509 specifications.SchemaOptions.ALLOW_MALFORMED_CERTPAIRS
Specifies whether the CertificatePair syntax should allow values which do not conform to the X.509 specifications.SchemaOptions.ALLOW_MALFORMED_JPEG_PHOTOS
Specifies whether the JPEG Photo syntax should allow values which do not conform to the JFIF or Exif specifications.SchemaOptions.ALLOW_MALFORMED_NAMES_AND_OPTIONS
Specifies whether the schema should allow certain illegal characters in OIDs and attribute options.SchemaOptions.ALLOW_MALFORMED_POSTAL_ADDRESSES
Specifies whether the PostalAddress syntax should allow values which do not conform to the LDAP specifications.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.SchemaOptions.ALLOW_ZERO_LENGTH_DIRECTORY_STRINGS
Specifies whether zero-length values will be allowed by the Directory String syntax.SchemaOptions.DEFAULT_MATCHING_RULE_OID
Specifies the OID of the default matching rule which will be used when parsing unrecognized attributes.SchemaOptions.DEFAULT_SYNTAX_OID
Specifies the OID of the default syntax which will be used when parsing unrecognized attributes.SchemaOptions.STRICT_FORMAT_FOR_BOOLEAN
Indicates whether boolean values are required to strictly comply with the standard definition for this syntax.SchemaOptions.STRICT_FORMAT_FOR_COUNTRY_STRINGS
Indicates whether country code values are required to strictly comply with the standard definition for this syntax.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.Modifier and TypeMethodDescription<T> T
Returns the value associated to the providedOption
or the option default value, if there is no such option in this schema.<T> SchemaBuilder
Sets a schema option overriding any previous values for the option. -
Uses of Option in org.forgerock.opendj.security
Modifier and TypeFieldDescriptionstatic 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.KeyStoreParameters.GLOBAL_PASSWORD
The optional password which is used to protect all private and secret keys.KeyStoreParameters.PBKDF2_ITERATIONS
The number of iterations to use when deriving encryption keys from passwords using PBKDF2.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
Modifier and TypeFieldDescriptionSecretStore.CLOCK
Specifies the clock to use when making time comparisons.SecretsTrustManager.ENABLE_REVOCATION_CHECKING
Whether the trust manager should perform recovation checking or not.SecretsKeyManager.KEY_MANAGER_ALGORITHM
The algorithm of the underlyingX509ExtendedKeyManager
implementation to use.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.SecretsTrustManager.TRUST_MANAGER_ALGORITHM
Algorithm to use for looking up the underlying X509ExtendedTrustManager. -
Uses of Option in org.forgerock.util
Modifier 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.