Uses of Class
org.forgerock.util.Options

Packages that use Options

Package	Description
org.forgerock.http.handler	Core Handler implementations.
org.forgerock.http.spi	HTTP service provider API.
org.forgerock.json.jose.jwe.handlers.encryption	Encryption Handler classes for each possible encryption algorithm.
org.forgerock.openig.handler	Handles HTTP requests by generating responses.
org.forgerock.openig.ldap	Facilitates access to the OpenDJ LDAP SDK from within scripts.
org.forgerock.openig.proxy	Contains proxy related heaplets.
org.forgerock.openig.secrets	Provides the Common Secrets API for accessing secrets of various kinds.
org.forgerock.openig.tools	Common tools used in policy service.
org.forgerock.openig.websocket	WebSocket proxy support.
org.forgerock.secrets	Provides a unified API for accessing secrets of various kinds.
org.forgerock.secrets.jwkset	Secret store backend for retrieving keys from a local or remote JWK Set.
org.forgerock.secrets.keystore	Implementations of SecretStore for accessing keys stored in Java KeyStores, such as PKCS#11 Hardware Security Modules (HSMs) and PKCS#12 file-based encrypted key stores.
org.forgerock.util	Provides common interfaces and classes.

Uses of Options in org.forgerock.http.handler

Constructors in org.forgerock.http.handler with parameters of type Options

Constructor	Description
HttpClientHandler(Options options)	Creates a new HTTP client using the provided client options.

Uses of Options in org.forgerock.http.spi

Methods in org.forgerock.http.spi with parameters of type Options

Modifier and Type	Method	Description
<S> S	Loader.load(Class<S> service, Options options)	Loads a service of the specified type.
HttpClient	HttpClientProvider.newHttpClient(Options options)	Returns a new HttpClient configured using the provided set of options.

Uses of Options in org.forgerock.json.jose.jwe.handlers.encryption

Constructors in org.forgerock.json.jose.jwe.handlers.encryption with parameters of type Options

Constructor	Description
RSAEncryptionHandler(EncryptionMethod encryptionMethod, JweAlgorithm jweAlgorithm, Options options)	Constructs a new RSAEncryptionHandler instance with the given options.

Uses of Options in org.forgerock.openig.handler

Methods in org.forgerock.openig.handler with parameters of type Options

Modifier and Type	Method	Description
protected List<Filter>	ClientHandlerHeaplet.filters(org.forgerock.openig.http.spi.HttpClientLoader loader, Options options)
protected abstract List<Filter>	HttpClientHandlerHeaplet.filters(org.forgerock.openig.http.spi.HttpClientLoader loader, Options options)	Returns a list of Filter that will be executed on every request before the HttpClientHandler.
protected List<Filter>	ReverseProxyHandlerHeaplet.filters(org.forgerock.openig.http.spi.HttpClientLoader loader, Options options)

Uses of Options in org.forgerock.openig.ldap

Methods in org.forgerock.openig.ldap that return Options

Modifier and Type	Method	Description
static Options	LdapClient.defaultOptions(Context context)	Setup the default options to create a LdapClient and adds the transactionId if any in the context's chain.

Methods in org.forgerock.openig.ldap with parameters of type Options

Modifier and Type	Method	Description
LdapConnection	LdapClient.connect(String host, int port, Options options)	Returns an LDAP connection for the specified LDAP server using the provided LDAP options.

Uses of Options in org.forgerock.openig.proxy

Methods in org.forgerock.openig.proxy with parameters of type Options

Modifier and Type	Method	Description
Promise<Void,NeverThrowsException>	CustomProxyOptions.configure(Options options)
Promise<Void,NeverThrowsException>	NoProxyOptions.configure(Options options)
Promise<Void,NeverThrowsException>	SystemProxyOptions.configure(Options options)

Uses of Options in org.forgerock.openig.secrets

Methods in org.forgerock.openig.secrets with parameters of type Options

Modifier and Type	Method	Description
X509ExtendedKeyManager	DefaultSecretsService.getKeyManager(Purpose<? extends CryptoKey> purpose, Options options)	Deprecated.
X509ExtendedKeyManager	SecretsService.getKeyManager(Purpose<? extends CryptoKey> purpose, Options options)	Returns a KeyManager that can be used to initialize an SSLContext, allowing certificates and private keys to be retrieved from this secrets provider.
SecretsTrustManager	DefaultSecretsService.getTrustManager(Purpose<? extends CryptoKey> purpose, Options options)	Deprecated.
SecretsTrustManager	SecretsService.getTrustManager(Purpose<? extends CryptoKey> purpose, Options options)	Constructs an X509ExtendedTrustManager that will retrieve certificates from this secrets provider for the provided purpose.
KeyStoreSecretStore	HsmSecretStoreHeaplet.keyStore(SecretsProvider secretsProvider, Purpose<GenericSecret> storePasswordPurpose, Options options)
KeyStoreSecretStore	KeyStoreSecretStoreHeaplet.keyStore(SecretsProvider secretsProvider, Purpose<GenericSecret> storePasswordPurpose, Options options)

Uses of Options in org.forgerock.openig.tools

Methods in org.forgerock.openig.tools with parameters of type Options

Modifier and Type	Method	Description
Promise<Void,NeverThrowsException>	ProxyOptions.configure(Options options)	Configure proxy settings.

Uses of Options in org.forgerock.openig.websocket

Methods in org.forgerock.openig.websocket with parameters of type Options

Modifier and Type	Method	Description
Filter	WebSocketProxyFilterProvider.newWebSocketProxyFilter(Options options)	Create a new Filter to manage WebSocket upgrade requests, and manage subsequent communication.

Uses of Options in org.forgerock.secrets

Methods in org.forgerock.secrets with parameters of type Options

Modifier and Type	Method	Description
X509ExtendedKeyManager	SecretsProvider.getKeyManager(Purpose<? extends CryptoKey> purpose, Options options)	Returns a KeyManager that can be used to initialize an SSLContext, allowing certificates and private keys to be retrieved from this secrets provider.
SecretsTrustManager	SecretsProvider.getTrustManager(Set<Purpose<? extends CryptoKey>> purposes, Options options)	Constructs an X509ExtendedTrustManager that will retrieve certificates from this secrets provider for the provided purposes.
SecretsTrustManager	SecretsProvider.getTrustManager(Purpose<? extends CryptoKey> purpose, Options options)	Constructs an X509ExtendedTrustManager that will retrieve certificates from this secrets provider for the provided purpose.

Uses of Options in org.forgerock.secrets.jwkset

Constructors in org.forgerock.secrets.jwkset with parameters of type Options

Constructor	Description
JwkSetSecretStore(JWKSet jwkSet, Options options)	Creates a secret store directly from the given JWK Set.
JwkSetSecretStore(JwksStore jwksStore, Options options)	Creates a secret store from a JwksStore.

Uses of Options in org.forgerock.secrets.keystore

Constructors in org.forgerock.secrets.keystore with parameters of type Options

Constructor	Description
KeyStoreSecretStore(Function<char[],KeyStore,KeyStoreException> keyStoreLoader, SecretReference<GenericSecret> keyStorePassword, SecretReference<GenericSecret> keyEntryPassword, Options options, KeyStoreSecretStore.StableIdProvider stableIdProvider)	Initialises the key store.
KeyStoreSecretStore(Function<char[],KeyStore,KeyStoreException> keyStoreLoader, SecretReference<GenericSecret> keyStorePassword, Options options)	Initialises the keystore using the same password for the keystore and all keys.

Uses of Options in org.forgerock.util

Methods in org.forgerock.util that return Options

Modifier and Type	Method	Description
static Options	Options.copyOf(Options options)	Returns a copy of the provided set of options.
static Options	Options.defaultOptions()	Returns a new set of options with default settings.
<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.
static Options	Options.unmodifiableCopyOf(Options options)	Returns an unmodifiable copy of the provided set of options.
static Options	Options.unmodifiableDefaultOptions()	Returns an unmodifiable set of options with default settings.

Methods in org.forgerock.util with parameters of type Options

Modifier and Type	Method	Description
static Options	Options.copyOf(Options options)	Returns a copy of the provided set of options.
static Options	Options.unmodifiableCopyOf(Options options)	Returns an unmodifiable copy of the provided set of options.