Deprecated API

Contents

• Terminally Deprecated
• Interfaces
• Classes
• Fields
• Methods
• Constructors
• Enum Constants

Terminally Deprecated Elements

Element	Description
org.forgerock.audit.batch.CommonAuditBatchConfiguration.POLLING_INTERVAL	Use CommonAuditBatchConfiguration.POLLING_INTERVAL_DURATION instead.
org.forgerock.audit.events.handlers.buffering.BufferedBatchPublisher.Builder.writeInterval(Duration)	Use BufferedBatchPublisher.Builder.writeInterval(Duration) instead.
org.forgerock.audit.rotation.FixedTimeRotationPolicy(List<Duration>)	Use FixedTimeRotationPolicy.fixedTimeRotationPolicy(List) instead.
org.forgerock.audit.rotation.FixedTimeRotationPolicy.getDailyRotationTimes()	Use FixedTimeRotationPolicy.getDailyRotationTimeDurations() instead.
org.forgerock.audit.rotation.TimeLimitRotationPolicy(Duration)	Use TimeLimitRotationPolicy(java.time.Duration) instead.
org.forgerock.audit.rotation.TimeLimitRotationPolicy.getRotationInterval()	Use TimeLimitRotationPolicy.getRotationIntervalDuration() instead.
org.forgerock.http.filter.Filters.newHttpBasicAuthenticationFilter(String, SecretReference<GenericSecret>)	use Filters.newHttpBasicAuthenticationFilter(CredentialPair) instead
org.forgerock.http.filter.Filters.newHttpBasicAuthenticationFilter(String, SecretReference<GenericSecret>, Charset)	use Filters.newHttpBasicAuthenticationFilter(CredentialPair, Charset) instead
org.forgerock.http.filter.Filters.newUrlEncodedHttpBasicAuthFilter(String, SecretReference<GenericSecret>)	use Filters.newUrlEncodedHttpBasicAuthFilter(CredentialPair) instead
org.forgerock.http.header.SetCookie2Header	This header is no longer supported by browsers. Use SetCookieHeader instead.
org.forgerock.http.oauth2.AccessTokenResolver.resolve(Context, String)	Use AccessTokenResolver.resolve(Context, Supplier, String) instead.
org.forgerock.http.oauth2.ClientSecretPostAuthenticationFilter(String, SecretReference<GenericSecret>)	Use ClientSecretPostAuthenticationFilter(CredentialPair) instead.
org.forgerock.http.oauth2.EncryptedPrivateKeyJwtClientAuthenticationFilter.Builder.buildSecretReferences()	for removal with EncryptedPrivateKeyJwtClientAuthenticationFilter.Builder.withEncryptionPurpose(Purpose). Will be removed in winter 2021 season.
org.forgerock.http.oauth2.EncryptedPrivateKeyJwtClientAuthenticationFilter.Builder.withEncryptionPurpose(Purpose<DataEncryptionKey>)	Please use EncryptedPrivateKeyJwtClientAuthenticationFilter.Builder.withEncryptionSecretReference(SecretReference) instead. Will be removed in winter 2021 season.
org.forgerock.http.oauth2.PrivateKeyJwtClientAuthenticationFilter.Builder.buildSecretReferences()	for removal with PrivateKeyJwtClientAuthenticationFilter.Builder.withSigningPurpose(Purpose). Will be removed in winter 2021 season.
org.forgerock.http.oauth2.PrivateKeyJwtClientAuthenticationFilter.Builder.withSecretsProvider(SecretsProvider)	Please use SecretReference API instead. Will be removed in winter 2021 season.
org.forgerock.http.oauth2.PrivateKeyJwtClientAuthenticationFilter.Builder.withSigningPurpose(Purpose<SigningKey>)	Please use PrivateKeyJwtClientAuthenticationFilter.Builder.withSigningSecretReference(SecretReference) instead. Will be removed in winter 2021 season.
org.forgerock.json.jose.jwk.store.JwksStore.getCacheMissCacheTime()	Use JwksStore.getCacheMissCacheTimeDuration() instead.
org.forgerock.json.jose.jwk.store.JwksStore.getCacheTimeout()	Use JwksStore.getCacheTimeoutDuration() instead.
org.forgerock.json.jose.jwk.store.JwksStore.newJwksStore(Duration, Duration, URL, JWKSetParser, Clock)	Use JwksStore.newJwksStore(Duration, Duration, URL, JWKSetParser, Clock) instead.
org.forgerock.json.jose.jwk.store.JwksStore.setCacheMissCacheTime(Duration)	Use JwksStore.setCacheMissCacheTime(Duration) instead.
org.forgerock.json.jose.jwk.store.JwksStore.setCacheTimeout(Duration)	Use JwksStore.setCacheTimeout(Duration) instead.
org.forgerock.json.jose.jwk.store.JwksStoreService.configureJwksStoreAsync(String, Duration, Duration, URL, Clock)	use JwksStoreService.configureJwksStoreAsync(String, Duration, Duration, URL, Clock) instead.
org.forgerock.json.jose.jwk.store.JwksStoreService.JWKS_STORE_DEFAULT_CACHE_MISS_CACHE_TIME_MS	Use JwksStoreService.JWKS_STORE_DEFAULT_CACHE_MISS_CACHE_TIME instead.
org.forgerock.json.jose.jwk.store.JwksStoreService.JWKS_STORE_DEFAULT_CACHE_TIMEOUT_MS	Use JwksStoreService.JWKS_STORE_DEFAULT_CACHE_TIMEOUT instead.
org.forgerock.json.JsonValueFunctions.duration()	use JsonValueFunctions.javaDuration() instead
org.forgerock.openig.fapi.aserror.AmErrorTransformFilter	This filter is transitional only and should not be used - OPENIG-9318
org.forgerock.openig.fapi.authorization.AuthorizationRequest.rationalizeRequest(JwtClaimsSet)	This interface method is transitional only and should not be used - OPENIG-9377, OPENAM-21910
org.forgerock.openig.fapi.dcr.request.AmTransformFilter	This filter is transitional only and should not be used - OPENIG-9312
org.forgerock.openig.filter.FileAttributesFilter(SeparatedValuesFile, String, Expression<String>, LeftValueExpression<Map>)	use the other constructor instead.
org.forgerock.openig.filter.oauth2.client.IssuerRepository.Heaplet
org.forgerock.openig.heap.TokenResolver
org.forgerock.openig.session.jwt.JwtSessionManagerHeaplet.NAME_DEPRECATED
org.forgerock.openig.sql.SqlAttributesFilter(DataSource, LeftValueExpression<Map>, String)	use SqlAttributesFilter(DataSource, String, ScheduledExecutorService) instead.
org.forgerock.secrets.oauth2.AccessTokenSecretStore.Builder.withClientSecretBasicAuth(String, SecretReference<GenericSecret>)	use AccessTokenSecretStore.Builder.withClientSecretBasicAuth(CredentialPair) instead
org.forgerock.secrets.oauth2.AccessTokenSecretStore.Builder.withClientSecretPostAuth(String, SecretReference<GenericSecret>)	use AccessTokenSecretStore.Builder.withClientSecretPostAuth(CredentialPair) instead
org.forgerock.secrets.oauth2.ResourceOwnerPasswordGrantTypeHandler(String, String, SecretReference<GenericSecret>)	Use ResourceOwnerPasswordGrantTypeHandler(String, CredentialPair) instead.
org.forgerock.secrets.oauth2.ResourceOwnerPasswordGrantTypeHandler(String, String, SecretReference<GenericSecret>, Collection<String>)	Use ResourceOwnerPasswordGrantTypeHandler(String, CredentialPair, Collection) instead.
org.forgerock.util.PerItemEvictionStrategyCache(ScheduledExecutorService, AsyncFunction<V, Duration, Exception>)	Use PerItemEvictionStrategyCache.perItemEvictionStrategyCache(ScheduledExecutorService, AsyncFunction) instead.
org.forgerock.util.PerItemEvictionStrategyCache(ScheduledExecutorService, Duration)	Use PerItemEvictionStrategyCache(ScheduledExecutorService, java.time.Duration) instead.
org.forgerock.util.PerItemEvictionStrategyCache.getMaxTimeout()	Use PerItemEvictionStrategyCache.getMaxTimeoutDuration() instead.
org.forgerock.util.PerItemEvictionStrategyCache.getValue(K, Callable<V>, AsyncFunction<V, Duration, E>)	Use PerItemEvictionStrategyCache.getValue2(Object, Callable, AsyncFunction) instead.
org.forgerock.util.PerItemEvictionStrategyCache.setMaxTimeout(Duration)	Use PerItemEvictionStrategyCache.setMaxTimeoutDuration(Duration) instead.
org.forgerock.util.time.Duration	Use Duration instead.

Deprecated Interfaces

Interface	Description
org.forgerock.http.session.SessionManager

Deprecated Classes

Class	Description
org.forgerock.http.header.SetCookie2Header	This header is no longer supported by browsers. Use SetCookieHeader instead.
org.forgerock.http.oauth2.ClientSecretBasicAuthenticationFilter	since 26.2. See Filters.newUrlEncodedHttpBasicAuthFilter(String, SecretReference) for a replacement.
org.forgerock.http.oauth2.resolver.OpenAmAccessTokenResolver	The “/oauth2/tokeninfo” endpoint was deprecated in AM 6.5. OpenAmAccessTokenResolver is deprecated and should not be used.
org.forgerock.json.jose.builders.SignedEncryptedJwsHeaderBuilder	Use EncryptedThenSignedJwtHeaderBuilder instead.
org.forgerock.json.jose.builders.SignedEncryptedJwtBuilder	Use EncryptedThenSignedJwtBuilder instead.
org.forgerock.json.jose.jwe.handlers.encryption.AbstractEncryptionHandler	Use ContentEncryptionHandler instead.
org.forgerock.json.jose.jwe.handlers.encryption.RSA15AES128CBCHS256EncryptionHandler	Use RSAEncryptionHandler and AESCBCHMACSHA2ContentEncryptionHandler instead.
org.forgerock.json.jose.jwe.handlers.encryption.RSA15AES256CBCHS512EncryptionHandler	Use RSAEncryptionHandler and AESCBCHMACSHA2ContentEncryptionHandler instead.
org.forgerock.json.jose.jws.handlers.ECDSASigningHandler	Use SecretECDSASigningHandler instead
org.forgerock.json.jose.jws.handlers.EdDSASigningHandler	Use SecretEdDSASigningHandler instead.
org.forgerock.json.jose.jws.handlers.HmacSigningHandler	Use SecretHmacSigningHandler instead
org.forgerock.json.jose.jws.handlers.NOPSigningHandler	This algorithm is inherently insecure and shouldn't be used.
org.forgerock.json.jose.jws.handlers.RSASigningHandler	Use SecretRSASigningHandler instead
org.forgerock.json.jose.jws.SignedEncryptedJwt	Use EncryptedThenSignedJwt instead.
org.forgerock.json.jose.tokenhandler.JwtTokenHandler	Prefer SecretsJwtTokenHandler instead.
org.forgerock.json.resource.AbstractRequestHandler	RequestHandler now has default methods which implement the not-supported behavior. This class is here for transition from pre-JDK8 impelementations.
org.forgerock.json.resource.http.SecurityContextFactory	This class will be removed once CAF has been migrated fully to CHF, at which point components should create SecurityContexts directly rather than via request attributes.
org.forgerock.openig.fapi.aserror.AmErrorTransformFilter	This filter is transitional only and should not be used - OPENIG-9318
org.forgerock.openig.fapi.dcr.request.AmTransformFilter	This filter is transitional only and should not be used - OPENIG-9312
org.forgerock.openig.filter.oauth2.client.IssuerRepository.Heaplet
org.forgerock.openig.handler.saml.SamlFederationHandlerHeaplet	in 2023.4.0, use SamlFederationFilterHeaplet as a replacement
org.forgerock.openig.heap.TokenResolver
org.forgerock.openig.security.KeyManagerHeaplet	Use SecretsKeyManagerHeaplet instead.
org.forgerock.openig.security.KeyStoreHeaplet	Use KeyStoreSecretStoreHeaplet instead.
org.forgerock.openig.security.TrustManagerHeaplet	Use SecretsTrustManagerHeaplet instead.
org.forgerock.util.time.Duration	Use Duration instead.
org.forgerock.util.Utils	Use Strings, Closeables, Objects or Threads instead.

Deprecated Fields

Field	Description
org.forgerock.audit.batch.CommonAuditBatchConfiguration.POLLING_INTERVAL	Use CommonAuditBatchConfiguration.POLLING_INTERVAL_DURATION instead.
org.forgerock.json.jose.jwk.store.JwksStoreService.JWKS_STORE_DEFAULT_CACHE_MISS_CACHE_TIME_MS	Use JwksStoreService.JWKS_STORE_DEFAULT_CACHE_MISS_CACHE_TIME instead.
org.forgerock.json.jose.jwk.store.JwksStoreService.JWKS_STORE_DEFAULT_CACHE_TIMEOUT_MS	Use JwksStoreService.JWKS_STORE_DEFAULT_CACHE_TIMEOUT instead.
org.forgerock.openig.filter.oauth2.OAuth2ResourceServerFilterHeaplet.NAME_DEPRECATED	OAuth2ResourceServerFilterHeaplet.NAME is more accurate and should be used for all new references
org.forgerock.openig.openam.AbstractConditionAdviceFilter.formatEncoder	Since 2023.6 - supports legacy behaviour only - Tracked by OPENIG-7482
org.forgerock.openig.session.jwt.JwtSessionManagerHeaplet.NAME_DEPRECATED

Deprecated Methods

Method	Description
org.forgerock.audit.events.handlers.buffering.BufferedBatchPublisher.Builder.writeInterval(Duration)	Use BufferedBatchPublisher.Builder.writeInterval(Duration) instead.
org.forgerock.audit.rotation.FixedTimeRotationPolicy.getDailyRotationTimes()	Use FixedTimeRotationPolicy.getDailyRotationTimeDurations() instead.
org.forgerock.audit.rotation.TimeLimitRotationPolicy.getRotationInterval()	Use TimeLimitRotationPolicy.getRotationIntervalDuration() instead.
org.forgerock.audit.util.ElasticsearchUtil.normalizeJson(JsonValue)	Use ElasticsearchUtil.NORMALIZING_OBJECT_MAPPER instead.
org.forgerock.http.filter.Filters.newHttpBasicAuthenticationFilter(String, SecretReference<GenericSecret>)	use Filters.newHttpBasicAuthenticationFilter(CredentialPair) instead
org.forgerock.http.filter.Filters.newHttpBasicAuthenticationFilter(String, SecretReference<GenericSecret>, Charset)	use Filters.newHttpBasicAuthenticationFilter(CredentialPair, Charset) instead
org.forgerock.http.filter.Filters.newSessionFilter(SessionManager)
org.forgerock.http.filter.Filters.newUrlEncodedHttpBasicAuthFilter(String, SecretReference<GenericSecret>)	use Filters.newUrlEncodedHttpBasicAuthFilter(CredentialPair) instead
org.forgerock.http.handler.HttpClientHandler.ProxyInfo.getPassword()	Use HttpClientHandler.ProxyInfo.getCredentials() instead
org.forgerock.http.handler.HttpClientHandler.ProxyInfo.getUsername()	Use HttpClientHandler.ProxyInfo.getCredentials() instead
org.forgerock.http.handler.HttpClientHandler.ProxyInfo.proxyInfo(URI, String, String)	Use HttpClientHandler.ProxyInfo.blockingProxyInfo(URI, CredentialPair)} instead
org.forgerock.http.header.ContentTypeHeader.getAdditionalParameters()	Replaced by ContentTypeHeader.getDirectives()
org.forgerock.http.oauth2.AccessTokenResolver.resolve(Context, String)	Use AccessTokenResolver.resolve(Context, Supplier, String) instead.
org.forgerock.http.oauth2.EncryptedPrivateKeyJwtClientAuthenticationFilter.Builder.buildSecretReferences()	for removal with EncryptedPrivateKeyJwtClientAuthenticationFilter.Builder.withEncryptionPurpose(Purpose). Will be removed in winter 2021 season.
org.forgerock.http.oauth2.EncryptedPrivateKeyJwtClientAuthenticationFilter.Builder.withEncryptionPurpose(Purpose<DataEncryptionKey>)	Please use EncryptedPrivateKeyJwtClientAuthenticationFilter.Builder.withEncryptionSecretReference(SecretReference) instead. Will be removed in winter 2021 season.
org.forgerock.http.oauth2.OAuth2Error.toWWWAuthenticateHeader()	Use OAuth2Error.asWwwAuthenticateHeader() instead.
org.forgerock.http.oauth2.PrivateKeyJwtClientAuthenticationFilter.Builder.buildSecretReferences()	for removal with PrivateKeyJwtClientAuthenticationFilter.Builder.withSigningPurpose(Purpose). Will be removed in winter 2021 season.
org.forgerock.http.oauth2.PrivateKeyJwtClientAuthenticationFilter.Builder.withSecretsProvider(SecretsProvider)	Please use SecretReference API instead. Will be removed in winter 2021 season.
org.forgerock.http.oauth2.PrivateKeyJwtClientAuthenticationFilter.Builder.withSigningPurpose(Purpose<SigningKey>)	Please use PrivateKeyJwtClientAuthenticationFilter.Builder.withSigningSecretReference(SecretReference) instead. Will be removed in winter 2021 season.
org.forgerock.http.protocol.Cookie.getComment()	Only valid for RFC 2965 cookies ("Cookie2"), which have been deprecated and removed by most clients.
org.forgerock.http.protocol.Cookie.getCommentURL()	Only valid for RFC 2965 cookies ("Cookie2"), which have been deprecated and removed by most clients.
org.forgerock.http.protocol.Cookie.getDiscard()	Only valid for RFC 2965 cookies ("Cookie2"), which have been deprecated and removed by most clients.
org.forgerock.http.protocol.Cookie.getPort()	Only valid for RFC 2965 cookies ("Cookie2"), which have been deprecated and removed by most clients.
org.forgerock.http.protocol.Cookie.getVersion()	Only valid for RFC 2965 cookies ("Cookie2"), which have been deprecated and removed by most clients.
org.forgerock.http.protocol.Cookie.setComment(String)	Only valid for RFC 2965 cookies ("Cookie2"), which have been deprecated and removed by most clients.
org.forgerock.http.protocol.Cookie.setCommentURL(String)	Only valid for RFC 2965 cookies ("Cookie2"), which have been deprecated and removed by most clients.
org.forgerock.http.protocol.Cookie.setDiscard(Boolean)	Only valid for RFC 2965 cookies ("Cookie2"), which have been deprecated and removed by most clients.
org.forgerock.http.protocol.Cookie.setPort(List<Integer>)	Only valid for RFC 2965 cookies ("Cookie2"), which have been deprecated and removed by most clients.
org.forgerock.http.protocol.Cookie.setVersion(Integer)	Only valid for RFC 2965 cookies ("Cookie2"), which have been deprecated and removed by most clients.
org.forgerock.http.protocol.Form.fromRequestEntity(Request)	Because Entity content should be read asynchronously. Instead retrieve the Form with Entity.getFormAsync().
org.forgerock.http.protocol.Form.fromString(String)	use Form.fromFormString(String) instead.
org.forgerock.http.protocol.Form.toString()	use Form.toFormString() instead.
org.forgerock.http.protocol.Request.getForm()	Use Request.getQueryParams() or Entity.getForm()
org.forgerock.json.jose.builders.EncryptedJwtBuilder.sign(SigningHandler, JwsAlgorithm)	Use EncryptedJwtBuilder.signedWith(SigningHandler, JwsAlgorithm) instead.
org.forgerock.json.jose.builders.JweHeaderBuilder.epk(String)	Use JweHeaderBuilder.epk(JWK) instead.
org.forgerock.json.jose.builders.JwtBuilderFactory.jwe(Key)	Prefer JwtBuilderFactory.jwe(EncryptionKey) instead.
org.forgerock.json.jose.builders.JwtBuilderFactory.jwt()	This method provides no security at all and shouldn't be used.
org.forgerock.json.jose.builders.SignedJwtBuilderImpl.encrypt(Key)	Prefer SignedJwtBuilderImpl.encrypt(EncryptionKey) instead.
org.forgerock.json.jose.jwe.EncryptedJwt.decrypt(Key)	Prefer EncryptedJwt.decrypt(SecretsProvider, Purpose) instead.
org.forgerock.json.jose.jwe.EncryptedJwt.decryptRawPayload(Key)	Prefer EncryptedJwt.decryptRawPayload(SecretsProvider, Purpose) instead.
org.forgerock.json.jose.jwe.handlers.encryption.EncryptionHandler.decryptContentEncryptionKey(Key, byte[])	Use EncryptionHandler.decryptContentEncryptionKey(Key, byte[], JweHeader) instead.
org.forgerock.json.jose.jwe.handlers.encryption.EncryptionHandler.generateJWEEncryptedKey(Key, Key)	Use EncryptionHandler.generateJWEEncryptedKey(Key, Key, JweHeader) instead.
org.forgerock.json.jose.jwe.SignedThenEncryptedJwt.decryptAndVerify(Key, SigningHandler)	Prefer SignedThenEncryptedJwt.decryptAndVerify(SecretsProvider, Purpose, Purpose) instead.
org.forgerock.json.jose.jwk.EcJWK.getCurve()	replaced by EcJWK.getEllipticCurve().
org.forgerock.json.jose.jwk.JWK.Builder.x509Thumbnail(String)	Use JWK.Builder.x509Thumbprint(String) or JWK.Builder.x509ThumbprintS256(String) instead.
org.forgerock.json.jose.jwk.JWK.getAlgorithm()	replaced by JWK.getJwaAlgorithm()
org.forgerock.json.jose.jwk.JWK.getX509Thumbnail()	Use JWK.getX509Thumbprint() instead.
org.forgerock.json.jose.jwk.JWKSetParser.jwkSet(URL)	Use JWKSetParser.jwkSetAsync(URL) instead.
org.forgerock.json.jose.jwk.store.JwksStore.findJwk(String)	Use JwksStore.findJwkAsync(String) instead.
org.forgerock.json.jose.jwk.store.JwksStore.findJwk(Algorithm, String)	Use JwksStore.findJwkAsync(String) instead.
org.forgerock.json.jose.jwk.store.JwksStore.getCacheMissCacheTime()	Use JwksStore.getCacheMissCacheTimeDuration() instead.
org.forgerock.json.jose.jwk.store.JwksStore.getCacheTimeout()	Use JwksStore.getCacheTimeoutDuration() instead.
org.forgerock.json.jose.jwk.store.JwksStore.newJwksStore(Duration, Duration, URL, JWKSetParser, Clock)	Use JwksStore.newJwksStore(Duration, Duration, URL, JWKSetParser, Clock) instead.
org.forgerock.json.jose.jwk.store.JwksStore.reloadJwks()	Use JwksStore.reloadJwksAsync() instead.
org.forgerock.json.jose.jwk.store.JwksStore.setCacheMissCacheTime(Duration)	Use JwksStore.setCacheMissCacheTime(Duration) instead.
org.forgerock.json.jose.jwk.store.JwksStore.setCacheTimeout(Duration)	Use JwksStore.setCacheTimeout(Duration) instead.
org.forgerock.json.jose.jwk.store.JwksStore.setJwkUrl(URL)	Use JwksStore.setJwkUrlAsync(URL) instead.
org.forgerock.json.jose.jwk.store.JwksStoreService.configureJwksStore(String, Duration, Duration, URL)	Use JwksStoreService.configureJwksStore(String, org.forgerock.util.time.Duration, org.forgerock.util.time.Duration, URL, Clock) with an explicit clock.
org.forgerock.json.jose.jwk.store.JwksStoreService.configureJwksStore(String, Duration, Duration, URL, Clock)	use JwksStoreService.configureJwksStoreAsync(String, Duration, Duration, URL, Clock) instead.
org.forgerock.json.jose.jwk.store.JwksStoreService.configureJwksStoreAsync(String, Duration, Duration, URL, Clock)	use JwksStoreService.configureJwksStoreAsync(String, Duration, Duration, URL, Clock) instead.
org.forgerock.json.jose.jws.EncryptedThenSignedJwt.decrypt(Key)	Prefer EncryptedThenSignedJwt.decrypt(SecretsProvider, Purpose) instead.
org.forgerock.json.jose.jws.JwsAlgorithm.getJwsAlgorithm(String)	Replaced by JwsAlgorithm.parseCryptographicAlgorithm(String)
org.forgerock.json.jose.jws.SigningManager.newEcdsaSigningHandler(ECPrivateKey)	use SigningManager.newEcdsaSigningHandler(SigningKey)} instead
org.forgerock.json.jose.jws.SigningManager.newEcdsaSigningHandler(PrivateKey)	use SigningManager.newEcdsaSigningHandler(SigningKey)} instead
org.forgerock.json.jose.jws.SigningManager.newEcdsaVerificationHandler(ECPublicKey)	use SigningManager.newEcdsaVerificationHandler(VerificationKey) instead
org.forgerock.json.jose.jws.SigningManager.newEdDsaSigningHandler(byte[])	Use SigningManager.newEdDsaSigningHandler(SigningKey) instead
org.forgerock.json.jose.jws.SigningManager.newEdDsaVerificationHandler(byte[])	Use SigningManager.newEdDsaVerificationHandler(VerificationKey) instead.
org.forgerock.json.jose.jws.SigningManager.newHmacSigningHandler(byte[])	use SigningManager.newHmacSigningHandler(SigningKey) instead
org.forgerock.json.jose.jws.SigningManager.newHmacSigningHandler(SecretKey)	use SigningManager.newHmacSigningHandler(SigningKey) instead
org.forgerock.json.jose.jws.SigningManager.newNopSigningHandler()	This method is inherently insecure and shouldn't be used.
org.forgerock.json.jose.jws.SigningManager.newRsaSigningHandler(Key)	use SigningManager.newRsaVerificationHandler(VerificationKey) instead
org.forgerock.json.jose.jws.SigningManager.newSigningHandler(Key)	Use SigningManager.newSigningHandler(SigningKey) instead
org.forgerock.json.jose.jws.SigningManager.newVerificationHandler(Key)	Use SigningManager.newVerificationHandler(VerificationKey) instead
org.forgerock.json.jose.utils.Utils.base64urlDecode(String)	Use Utils.decodeJwtComponent(String).
org.forgerock.json.jose.utils.Utils.base64urlEncode(String)	Use Utils.encodeJwtComponent(String).
org.forgerock.json.JsonValueFunctions.duration()	use JsonValueFunctions.javaDuration() instead
org.forgerock.json.JsonValueFunctions.identity()	use JsonValue::copy directly instead
org.forgerock.json.resource.http.CrestHttp.newHttpHandler(ConnectionFactory)	Use CrestHttp.newHttpHandler(CrestApplication) instead.
org.forgerock.json.resource.http.CrestHttp.newHttpHandler(ConnectionFactory, HttpContextFactory)	Use CrestHttp.newHttpHandler(CrestApplication) instead.
org.forgerock.json.resource.http.CrestHttp.newHttpHandler(ConnectionFactory, Context)	Use CrestHttp.newHttpHandler(CrestApplication) instead.
org.forgerock.json.resource.http.CrestHttp.newHttpHandler(CrestApplication)	Since 25.0.0. Prefer to use CrestHttp.newHttpHandler(CrestApplication, Factory) and provide your own factory instead of the default one.
org.forgerock.json.resource.http.CrestHttp.newHttpHandler(CrestApplication, HttpContextFactory)	Since 25.0.0. Prefer to use CrestHttp.newHttpHandler(CrestApplication, HttpContextFactory, Factory) and provide your own factory instead of the default one.
org.forgerock.json.resource.http.CrestHttp.newHttpHandler(CrestApplication, Context)	Since 25.0.0. Prefer to use CrestHttp.newHttpHandler(CrestApplication, Context, Factory) and provide your own factory instead of the default one.
org.forgerock.json.resource.http.CrestHttp.newHttpHandler(RequestHandler)	Use CrestHttp.newHttpHandler(CrestApplication) instead.
org.forgerock.json.resource.ResourceException.getException(int)	in favor of ResourceException.newResourceException(int)
org.forgerock.json.resource.ResourceException.getException(int, String)	in favor of ResourceException.newResourceException(int, String)
org.forgerock.json.resource.ResourceException.getException(int, String, Throwable)	in favor of ResourceException.newResourceException(int, String, Throwable)
org.forgerock.json.resource.Resources.newAnnotatedRequestHandler(Object)	Use Resources.newHandler(Object) instead.
org.forgerock.json.resource.Resources.newCollection(Object)	Use Resources.newHandler(Object) instead.
org.forgerock.json.resource.Resources.newSingleton(Object)	Use Resources.newHandler(Object) instead.
org.forgerock.json.resource.Responses.newRemainingResultsResponse(String, int)	Use Responses.newQueryResponse(String, CountPolicy, int) instead.
org.forgerock.openig.fapi.authorization.AuthorizationRequest.rationalizeRequest(JwtClaimsSet)	This interface method is transitional only and should not be used - OPENIG-9377, OPENAM-21910
org.forgerock.openig.handler.saml.ChfHttpServletRequestAdapter.getRealPath(String)	As of Version 2.1 of the Java Servlet API, use ServletContext.getRealPath(java.lang.String) instead.
org.forgerock.openig.handler.saml.ChfHttpServletRequestAdapter.isRequestedSessionIdFromUrl()	As of Version 2.1 of the Java Servlet API, use ChfHttpServletRequestAdapter.isRequestedSessionIdFromURL() instead.
org.forgerock.openig.handler.saml.ChfHttpServletResponseAdapter.encodeRedirectUrl(String)	As of version 2.1, use encodeRedirectURL(String url) instead
org.forgerock.openig.handler.saml.ChfHttpServletResponseAdapter.encodeUrl(String)	As of version 2.1, use encodeURL(String url) instead
org.forgerock.openig.handler.saml.ChfHttpServletResponseAdapter.setStatus(int, String)	As of version 2.1, due to ambiguous meaning of the message parameter. To set a status code use setStatus(int), to send an error with a description use sendError(int, String). Sets the status code and message for this response.
org.forgerock.openig.tools.jwt.validation.JwtValidator.Builder.claimSet(String, Function<Optional<JwtClaimsSet>, Optional<T>>, JwtClaimConstraint<T>)	since 2024.3.0, with OPENIG-8029. Use JwtValidator.Builder.claimSet(String, java.util.function.Function, JwtClaimConstraint, boolean) instead.
org.forgerock.secrets.oauth2.AccessTokenSecretStore.Builder.withClientSecretBasicAuth(String, SecretReference<GenericSecret>)	use AccessTokenSecretStore.Builder.withClientSecretBasicAuth(CredentialPair) instead
org.forgerock.secrets.oauth2.AccessTokenSecretStore.Builder.withClientSecretPostAuth(String, SecretReference<GenericSecret>)	use AccessTokenSecretStore.Builder.withClientSecretPostAuth(CredentialPair) instead
org.forgerock.secrets.SecretBuilder.build(Class<T>)	Use SecretBuilder.build(Purpose) instead.
org.forgerock.util.encode.Base64.decodeFast(byte[])	Use Base64.decode(byte[]) instead.
org.forgerock.util.encode.Base64.decodeFast(char[])	Use Base64.decode(char[]) instead.
org.forgerock.util.encode.Base64.decodeFast(String)	Use Base64.decode(String) instead.
org.forgerock.util.PerItemEvictionStrategyCache.getMaxTimeout()	Use PerItemEvictionStrategyCache.getMaxTimeoutDuration() instead.
org.forgerock.util.PerItemEvictionStrategyCache.getValue(K, Callable<V>, AsyncFunction<V, Duration, E>)	Use PerItemEvictionStrategyCache.getValue2(Object, Callable, AsyncFunction) instead.
org.forgerock.util.PerItemEvictionStrategyCache.setMaxTimeout(Duration)	Use PerItemEvictionStrategyCache.setMaxTimeoutDuration(Duration) instead.
org.forgerock.util.promise.Promise.getOrThrowUninterruptibly()	Since 25.0.0. Prefer using Promise.getOrThrow() and handle properly the InterruptedException in the calling code, or use Promise.getOrThrowIfInterrupted().
org.forgerock.util.promise.Promise.getOrThrowUninterruptibly(long, TimeUnit)	Since 25.0.0. Prefer using Promise.get(long, TimeUnit) and handle properly the InterruptedException in the calling code, or use Promise.getOrThrowIfInterrupted().
org.forgerock.util.promise.PromiseImpl.getOrThrowUninterruptibly()
org.forgerock.util.promise.PromiseImpl.getOrThrowUninterruptibly(long, TimeUnit)
org.forgerock.util.Reject.checkNotNull(T)	use Objects.requireNonNull(Object)} instead
org.forgerock.util.Reject.checkNotNull(T, String)	use Objects.requireNonNull(Object, String) instead
org.forgerock.util.Reject.ifFalse(boolean)	Experience has shown that Reject.ifFalse can be hard to read. Prefer to use Reject.unless(boolean) (which works identically) or rewrite to use Reject.ifTrue(boolean) instead.
org.forgerock.util.Reject.ifFalse(boolean, String)	Experience has shown that Reject.ifFalse can be hard to read. Prefer to use Reject.unless(boolean, String) (which works identically) or rewrite to use Reject.ifTrue(boolean, String) instead.
org.forgerock.util.thread.ExecutorServiceFactory.createCachedThreadPool()	ExecutorServiceFactory.createCachedThreadPool(String) or ExecutorServiceFactory.createCachedThreadPool(ThreadFactory) should be used so that threads have meaningful names.
org.forgerock.util.thread.ExecutorServiceFactory.createFixedThreadPool(int)	ExecutorServiceFactory.createFixedThreadPool(int, String) should be used so that threads have meaningful names.
org.forgerock.util.thread.ExecutorServiceFactory.createScheduledService(int)	ExecutorServiceFactory.createScheduledService(int, String) should be used so that threads have meaningful names.
org.forgerock.util.thread.ExecutorServiceFactory.createThreadPool(int, int, long, TimeUnit, BlockingQueue<Runnable>)	ExecutorServiceFactory.createThreadPool(int, int, long, TimeUnit, BlockingQueue, String) should be used so that threads have meaningful names.
org.forgerock.util.Utils.asEnum(String, Class<T>)	Use Strings.asEnum(String, Class)
org.forgerock.util.Utils.closeSilently(Closeable...)	Use Closeables.closeSilently(Closeable...)
org.forgerock.util.Utils.closeSilently(Iterable<? extends Closeable>)	Use Closeables.closeSilently(Iterable)
org.forgerock.util.Utils.compareValues(Object, Object)	Use Objects.compareValues(Object, Object)
org.forgerock.util.Utils.isBlank(CharSequence)	Use Strings.isBlank(CharSequence)
org.forgerock.util.Utils.isCompatible(Object, Object)	Use Objects.isCompatible(Object, Object)
org.forgerock.util.Utils.isNullOrEmpty(String)	Use Strings.isNullOrEmpty(String)
org.forgerock.util.Utils.joinAsString(StringBuilder, String, Iterable<?>)	Use Strings.joinAsString(StringBuilder, String, Iterable)
org.forgerock.util.Utils.joinAsString(StringBuilder, String, Object...)	Use Strings.joinAsString(StringBuilder, String, Object...)
org.forgerock.util.Utils.joinAsString(String, Iterable<?>)	Use Strings.joinAsString(String, Iterable)
org.forgerock.util.Utils.joinAsString(String, Object...)	Use Strings.joinAsString(String, Object...)
org.forgerock.util.Utils.newThreadFactory(ThreadGroup, String, boolean)	Use Threads.newThreadFactory(ThreadGroup, String, boolean)

Deprecated Constructors

Constructor	Description
org.forgerock.audit.rotation.FixedTimeRotationPolicy(List<Duration>)	Use FixedTimeRotationPolicy.fixedTimeRotationPolicy(List) instead.
org.forgerock.audit.rotation.TimeLimitRotationPolicy(Duration)	Use TimeLimitRotationPolicy(java.time.Duration) instead.
org.forgerock.http.filter.TransactionIdInboundFilter()	Replaced by TransactionIdInboundFilter(boolean)
org.forgerock.http.header.ContentTypeHeader(String, String, String)	Replaced by ContentTypeHeader(String, Map)
org.forgerock.http.header.ContentTypeHeader(String, String, String, Map<String, String>)	Replaced by ContentTypeHeader(String, Map)
org.forgerock.http.io.PipeBufferedStream()	Since 25.0.0. Prefer using PipeBufferedStream(Factory) to provide your own Buffer Factory
org.forgerock.http.oauth2.ClientSecretPostAuthenticationFilter(String, SecretReference<GenericSecret>)	Use ClientSecretPostAuthenticationFilter(CredentialPair) instead.
org.forgerock.http.oauth2.ResourceServerFilter(AccessTokenResolver, Clock, ResourceAccess, String)	The clock attribute is not used anymore. Use ResourceServerFilter(AccessTokenResolver, ResourceAccess, String) instead. Deprecated in 25.0.0.
org.forgerock.json.jose.builders.EncryptedJwtBuilder(Key)	Use JwtBuilderFactory.jwe(org.forgerock.secrets.keys.EncryptionKey) instead.
org.forgerock.json.jose.jwk.EcJWK(String, String, String, String, String, String, String, String, String, List<String>)	Use the builder instead.
org.forgerock.json.jose.jwk.EcJWK(String, String, String, String, String, String, String, String, List<String>)	Use the builder instead.
org.forgerock.json.jose.jwk.EcJWK(ECPublicKey, String, String)	Use the builder instead.
org.forgerock.json.jose.jwk.EcJWK(ECPublicKey, ECPrivateKey, String, String)	Use the builder instead.
org.forgerock.json.jose.jwk.JWK(KeyType, String, String, String)	Use the builder instead.
org.forgerock.json.jose.jwk.JWK(KeyType, String, String, String, String, String, List<String>)	Use the builder instead.
org.forgerock.json.jose.jwk.OctJWK(String, String, String, String, String, String, List<String>)	Use the builder instead.
org.forgerock.json.jose.jwk.RsaJWK(String, String, String, String, String, String, String, String, String, String, String, String, List<String>)	Use the builder instead.
org.forgerock.json.jose.jwk.RsaJWK(String, String, String, String, String, String, String, String, String, String, String, List<RsaJWK.PrimesInfo>, String, String, List<String>)	Use the builder instead.
org.forgerock.json.jose.jwk.RsaJWK(String, String, String, String, String, String, String, String, List<String>)	Use the builder instead.
org.forgerock.json.jose.jwk.RsaJWK(String, String, String, String, String, String, String, List<String>)	Use the builder instead.
org.forgerock.json.jose.jwk.RsaJWK(RSAPublicKey, String, String, String, String, String, List<String>)	Use the builder instead.
org.forgerock.json.jose.jwk.RsaJWK(RSAPublicKey, RSAPrivateCrtKey, String, String, String, String, String, List<String>)	Use the builder instead.
org.forgerock.json.jose.jwk.RsaJWK(RSAPublicKey, RSAPrivateKey, String, String, String, String, String, List<String>)	Use the builder instead.
org.forgerock.json.jose.jwk.store.JwksStore(Duration, Duration, URL, JWKSetParser, Clock)	It is recommended to use JwksStore.newJwksStore(Duration, Duration, URL, JWKSetParser, Clock).
org.forgerock.json.jose.jwk.store.JwksStoreService()	Prefer using the constructor JwksStoreService(Client client) in which you provide your own instance of Client. This one does instantiate a specific instance of AsyncHttpClient but does not allow any custom filter processing, nor does it close it properly.
org.forgerock.json.jose.jwk.store.JwksStoreService(int, int)	Prefer using the constructor JwksStoreService(Client client) where timeouts are in control of the client application
org.forgerock.json.jose.jws.handlers.RSASigningHandler(Key, SignatureUtil)	Please use RSASigningHandler(Key).
org.forgerock.json.jose.jws.SigningManager()	use SigningManager(SecretsProvider) instead
org.forgerock.json.jose.tokenhandler.SecretsJwtTokenHandler(JweAlgorithm, EncryptionMethod, JwsAlgorithm, Optional<Long>, KeyPair, SigningManager, Purpose<SigningKey>, Purpose<VerificationKey>, Clock)	Use SecretsJwtTokenHandler.builder() instead.
org.forgerock.json.JsonPointer()	Use JsonPointer.rootPtr() instead.
org.forgerock.openig.filter.FileAttributesFilter(SeparatedValuesFile, String, Expression<String>, LeftValueExpression<Map>)	use the other constructor instead.
org.forgerock.openig.sql.SqlAttributesFilter(DataSource, LeftValueExpression<Map>, String)	use SqlAttributesFilter(DataSource, String, ScheduledExecutorService) instead.
org.forgerock.secrets.keystore.HsmKeyStoreLoader(String)	use HsmKeyStoreLoader(Provider hsmProvider) instead so that management of the provider can be left to the caller.
org.forgerock.secrets.oauth2.ResourceOwnerPasswordGrantTypeHandler(String, String, SecretReference<GenericSecret>)	Use ResourceOwnerPasswordGrantTypeHandler(String, CredentialPair) instead.
org.forgerock.secrets.oauth2.ResourceOwnerPasswordGrantTypeHandler(String, String, SecretReference<GenericSecret>, Collection<String>)	Use ResourceOwnerPasswordGrantTypeHandler(String, CredentialPair, Collection) instead.
org.forgerock.secrets.SecretReference(SecretsProvider, Purpose<T>)	Use SecretsProvider.createActiveReference(Purpose) or SecretReference.active(SecretsProvider, Purpose, Clock) instead.
org.forgerock.secrets.SecretReference(SecretsProvider, Purpose<T>, Clock)	Use SecretsProvider.createActiveReference(Purpose) or SecretReference.active(SecretsProvider, Purpose, Clock) instead.
org.forgerock.secrets.SecretsProvider()	Prefer using SecretsProvider(Clock) and provide your own clock instance.
org.forgerock.services.context.RequestAuditContext(Context)	Prefer using RequestAuditContext(Context, Instant) not to rely on the system clock.
org.forgerock.services.context.RequestAuditContext(Context, Clock)	Prefer using RequestAuditContext(Context, Instant).
org.forgerock.util.PerItemEvictionStrategyCache(ScheduledExecutorService, AsyncFunction<V, Duration, Exception>)	Use PerItemEvictionStrategyCache.perItemEvictionStrategyCache(ScheduledExecutorService, AsyncFunction) instead.
org.forgerock.util.PerItemEvictionStrategyCache(ScheduledExecutorService, Duration)	Use PerItemEvictionStrategyCache(ScheduledExecutorService, java.time.Duration) instead.
org.forgerock.util.time.Duration(Long, TimeUnit)	Prefer the use of Duration.duration(long, TimeUnit).

Deprecated Enum Constants

Enum Constant	Description
org.forgerock.http.handler.HttpClientHandler.HostnameVerifier.ALLOW_ALL	this should never be used as it is a security risk.
org.forgerock.json.jose.jwe.JweAlgorithm.RSAES_PKCS1_V1_5	RSA1_5 is an insecure encryption mode. Use JweAlgorithm.RSA_OAEP_256 instead.
org.forgerock.json.jose.jws.JwsAlgorithm.NONE	This algorithm is inherently insecure and should not be used.
org.forgerock.json.jose.jws.JwsAlgorithmType.NONE	This algorithm is inherently insecure and shouldn't be used.