Uses of Class
org.forgerock.util.Option
Packages that use 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.
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
Fields in org.forgerock.am.cts.api declared as OptionModifier and TypeFieldDescriptionstatic final Option<TokenFilter>CTSOptions.ASSERTION_REQUEST_OPTIONSignals the CTS to perform an assertion using the providedTokenFilterbefore performing the requested operation.CTSOptions.ETAG_ASSERT_OPTIONSignals to the CTS backing implementation to assert that the CTS entry being updated still has the givenETagbefore applying the requested modification to it.CTSOptions.ETAG_READ_OPTIONSignals 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_OPTIONSignals the CTS to perform a read of a CTS token on delete.CTSOptions.VLV_SORT_ATTRIBUTESignals the CTS to utilise a pre-registered VLV-index based query, with the provided sort order.Methods in org.forgerock.am.cts.api with parameters of type OptionModifier and TypeMethodDescriptionstatic <T> OptionsCTSOptions.singleOption(Option<T> option, T value) -
Uses of Option in org.forgerock.am.saml2.api
Fields in org.forgerock.am.saml2.api declared as OptionModifier and TypeFieldDescriptionSaml2Options.ALLOW_CREATEWhether the identity provider is allowed to create a new NameID value for the user.static final Option<AuthComparison>Saml2Options.AUTH_COMPARISONThe comparison method the identity provider should use when determining the authentication method.Saml2Options.AUTH_CONTEXT_CLASS_REFThe authentication context class reference.Saml2Options.AUTH_CONTEXT_DECL_REFThe authentication context declaration reference.Saml2Options.FORCE_AUTHNWhether the IDP should force re-authentication of the user.Saml2Options.IS_PASSIVEWhether the IDP should silently check if the user is already authenticated.Saml2Options.NAME_ID_FORMATThe NameID Format the IDP should use when constructing the assertion.Saml2Options.REQUEST_BINDINGThe request binding AM should use when sending the authentication request.Saml2Options.RESPONSE_BINDINGThe binding the IDP should use when returning the SAML response. -
Uses of Option in org.forgerock.http.handler
Fields in org.forgerock.http.handler declared as OptionModifier and TypeFieldDescriptionHttpClientHandler.OPTION_CONNECT_TIMEOUTThe TCP connect timeout for new HTTP connections.HttpClientHandler.OPTION_DISABLE_CONNECTION_STATEThis option is only taken into account whenOPTION_REUSE_CONNECTIONSis also set to true.static final Option<HttpClientHandler.HostnameVerifier>HttpClientHandler.OPTION_HOSTNAME_VERIFIERSpecifies the SSL host name verification policy.static final Option<KeyManagerFactory>HttpClientHandler.OPTION_KEY_MANAGER_FACTORYSpecifies the key manager factory that should be used when configuring SSL/TLS connections.static final Option<KeyManager[]>HttpClientHandler.OPTION_KEY_MANAGERSSpecifies the list of key managers that should be used when configuring SSL/TLS connections.HttpClientHandler.OPTION_LOADERThe strategy which should be used for loading theHttpClientProvider.HttpClientHandler.OPTION_MAX_CONNECTIONSSpecifies the maximum number of connections that should be pooled by the HTTP client.HttpClientHandler.OPTION_NON_PROXY_HOSTSSpecifies the list of hosts for which requests should not be proxied.HttpClientHandler.OPTION_POOLED_CONNECTION_TTLSpecifies the time to live (expiry time) in milliseconds of connections from the pool.static final Option<HttpClientHandler.ProxyInfo>HttpClientHandler.OPTION_PROXYSpecifies a proxy to use for requests by the HTTP Client.HttpClientHandler.OPTION_PROXY_SYSTEMSpecifies that the system defined proxy should be used for requests by the HTTP Client.HttpClientHandler.OPTION_RETRY_REQUESTSSpecifies whether requests should be retried if a failure is detected.HttpClientHandler.OPTION_REUSE_CONNECTIONSSpecifies whether HTTP connections should be kept alive and reused for additional requests.HttpClientHandler.OPTION_SO_KEEP_ALIVEThe TCP socket keep-alive feature.HttpClientHandler.OPTION_SO_LINGERThe TCP socket feature to linger on close if data is present.HttpClientHandler.OPTION_SO_REUSE_ADDRESSThe TCP socket reuse address feature.HttpClientHandler.OPTION_SO_TIMEOUTThe TCP socket timeout when waiting for HTTP responses.HttpClientHandler.OPTION_SSL_CIPHER_SUITESList of JSSE ciphers to be enabled on the HttpClient.HttpClientHandler.OPTION_SSL_ENABLED_PROTOCOLSList of SSL protocols to be enabled on the HttpClient.HttpClientHandler.OPTION_SSLCONTEXT_ALGORITHMSSLContext algorithm to be used when making SSL/TLS connections.HttpClientHandler.OPTION_TCP_NO_DELAYThe TCP socket feature to disable the Nagle algorithm; that algorithm aims to coalesce short segments and improve network efficiency.HttpClientHandler.OPTION_TEMPORARY_STORAGESpecifies the temporary storage that should be used for storing HTTP responses.static final Option<TrustManagerFactory>HttpClientHandler.OPTION_TRUST_MANAGER_FACTORYSpecifies the trust manager factory that should be used when configuring SSL/TLS connections.static final Option<TrustManager[]>HttpClientHandler.OPTION_TRUST_MANAGERSSpecifies 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 OptionModifier and TypeFieldDescriptionRSAEncryptionHandler.USE_WRAP_UNWRAP_OPERATIONSIndicates 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
Fields in org.forgerock.openam.ldap declared as OptionModifier and TypeFieldDescriptionLDAPUtils.AFFINITY_ENABLEDAnOptionthat tells whether affinity based load balancing is enabled for the connections.static final Option<LDAPUtils.CachedPoolOptions>LDAPUtils.CACHED_POOL_OPTIONSAnOptionthat stores the settings related to cached connection pooling. -
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<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, or when the failover load-balancer performs a failover or a fallback.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.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