AM 7.3.1 Public API Javadoc

All Packages ForgeRock Access Management ForgeRock Http Framework ForgeRock Commons REST Resources ForgeRock Authentication and Authorization Framework ForgeRock OAuth Social Authentication ForgeRock Self Service ForgeRock Utilities ForgeRock JSON Web Token ForgeRock Secrets ForgeRock Directory Services Other Packages 
Package Description
com.forgerock.rxjava3.intern.subscriptions
Copy of internal classes from RxJava3.
com.forgerock.rxjava3.intern.util
Copy of internal classes from RxJava3.
com.iplanet.am.sdk
This package contains interfaces and implementation for User/Identity Management.
com.iplanet.am.util
Provides utility classes for use by other OpenAM SDK and custom applications accessing OpenAM SDK.
com.iplanet.dpro.parser
XML parsing utility.
com.iplanet.dpro.session.service
This package contains classes and interfaces that represent methods to validate/update/destroy/persist/retrieve the internal session data
com.iplanet.log
Exception classes for audit logging.
com.iplanet.services.cdm
Provides the classes for implementing services and applications serving multiple clients to OpenAM.
com.iplanet.services.ldap
Deprecated classes for LDAP support.
com.iplanet.services.ldap.event
Classes to handle LDAP persistent searches.
com.iplanet.services.util
Utilities for service management.
com.iplanet.sso
This package contains classes fro accessing the Single Sign On service and representing a SSOToken(Single Sign On) which contains the information related to session.
com.iplanet.sso.providers.dpro
This package contains classes that represent SSOProvider
com.sun.identity.authentication
Provides interfaces and classes for writing a Remote Java client application to authenticate to OpenAM.
com.sun.identity.authentication.modules.hotp
Implementation of the Authentication Framework HOTP module and associated classes.
com.sun.identity.authentication.server
This package contains the classes that represent server side functionality such as the implementation of request for authenticating, user credential callbacks.
com.sun.identity.authentication.spi
Provides interfaces and classes for writing a supplemental authentication module to plug into OpenAM.
com.sun.identity.entitlement
Defines classes and interfaces to work with entitlements.
com.sun.identity.federation.common
Defines Federation Common Utils.
com.sun.identity.idm
Provides classes for accessing the Identity Repository interfaces.
com.sun.identity.jaxrpc
Defines classes to handle JAX-RPC.
com.sun.identity.liberty.ws.common.wsse
Provides interface for Web Service Security X.509 Certificate Token Profile.
com.sun.identity.liberty.ws.paos
Reverse SOAP Binding classes.
com.sun.identity.liberty.ws.security
Provides interface to manage liberty security
com.sun.identity.liberty.ws.soapbinding
Provides classes to manage Liberty SOAP Binding.
com.sun.identity.log
Provides the classes and interfaces of core logging and auditing facilities.
com.sun.identity.log.spi
Provides means for plugging in support for authorization and other security related aspects of logging.
com.sun.identity.plugin.configuration
Contains configuration SPI.
com.sun.identity.plugin.datastore
Contains data store plugin SPIs.
com.sun.identity.plugin.log
Contains Log SPI.
com.sun.identity.plugin.session
Contains session SPI.
com.sun.identity.policy
Provides classes for policy administration and evaluation.
com.sun.identity.policy.interfaces
Deprecated interfaces for writing custom Policy plugins for Conditions, Subjects, Referrals, ResponseProviders and Resources.
com.sun.identity.policy.remote
Classes to handle policies remotely.
com.sun.identity.sae.api
Defines Secure Attribute Exchange (SAE) APIs.
com.sun.identity.saml
Defines SAML Assertion Manager and SAML Client APIs.
com.sun.identity.saml.assertion
Defines SAML assertion.
com.sun.identity.saml.common
Defines common SAML 1.x utilities and constants.
com.sun.identity.saml.xmlsig
Defines KeyProvider interface and default implementation class.
com.sun.identity.saml2.assertion
Defines SAMLv2 assertion.
com.sun.identity.saml2.common
Defines common SAMLv2 utilities and constants.
com.sun.identity.saml2.ecp
Defines classes for SAMLv2 ECP profile.
com.sun.identity.saml2.meta
Package that handles SAML v2 metadata operations.
com.sun.identity.saml2.plugins
Defines SAMLv2 Plugin SPIs.
com.sun.identity.saml2.plugins.scripted
Contains classes to be used by the SAML2 scripted plugins.
com.sun.identity.saml2.profile
Package that handles SAML v2 profiles.
com.sun.identity.saml2.protocol
SAMLv2 Protocol Classes.
com.sun.identity.security
Provides the classes to be used for performing privileged operations (like getting the OpenAM administrator's DN and password).
com.sun.identity.shared.debug
Defines legacy debug logging classes.
com.sun.identity.shared.jaxrpc
Defines classes to handle JAX-RPC.
com.sun.identity.shared.locale
Defines classes to handle localization.
com.sun.identity.shared.stats
Defines classes to interact with statistics.
com.sun.identity.shared.whitelist
Defines classes for basic resource matching.
com.sun.identity.sm
Provides classes for accessing the Service Management Service (SMS).
com.sun.identity.sm.validators
Validator classes for SMS.
com.sun.identity.wsfederation.common
Defines common WS-Federation utilities and constants.
com.sun.identity.wsfederation.plugins
Defines WS-Federation Plugin SPIs
com.sun.identity.xacml.client
Defines classes to handle XACML requests.
com.sun.identity.xacml.common
Defines common XACML Utilities and Constants
com.sun.identity.xacml.context
Defines XACML2 context classes
com.sun.identity.xacml.context.impl
Defines XACML Context implementations.
com.sun.identity.xacml.policy
Defines XACML Policy classes.
com.sun.identity.xacml.policy.impl
Defines XACML Policy implementations.
com.sun.identity.xacml.saml2
Defines XACML interfaces for SAMLv2
com.sun.identity.xacml.saml2.impl
Defines XACML implementations for SAMLv2.
org.forgerock.am.config
This package contains the config API that is used to retrieve and persist configuration for services.
org.forgerock.am.cts  
org.forgerock.am.cts.adapters  
org.forgerock.am.cts.api  
org.forgerock.am.cts.api.fields  
org.forgerock.am.cts.api.filter  
org.forgerock.am.cts.api.query  
org.forgerock.am.cts.api.tokens  
org.forgerock.am.cts.continuous  
org.forgerock.am.cts.continuous.watching  
org.forgerock.am.cts.exceptions  
org.forgerock.am.cts.reaper  
org.forgerock.am.cts.utils  
org.forgerock.am.cts.utils.blob  
org.forgerock.am.cts.utils.blob.strategies  
org.forgerock.am.health
Contains consumable services and endpoints used for monitoring AMs health.
org.forgerock.am.identity.application  
org.forgerock.am.identity.domain  
org.forgerock.am.identity.persistence  
org.forgerock.am.identity.presentation  
org.forgerock.am.iot
This package contains all classes pertaining to AM's IoT functionality.
org.forgerock.am.mail.application  
org.forgerock.am.mail.rest  
org.forgerock.am.oauth2
This package contains the client credentials OAuth2 API.
org.forgerock.am.saml2.api
This package contains the SAML2 SSO APIs.
org.forgerock.am.saml2.impl
This package contains the implementation of the SAML2 client APIs.
org.forgerock.am.saml2.profile  
org.forgerock.api
ForgeRock API Descriptor models, builders, and utilities.
org.forgerock.api.annotations
Annotations that can be used to specify information to be included in the API Descriptor.
org.forgerock.api.commons
Data related to ForgeRock Commons API Descriptor.
org.forgerock.api.enums
API descriptor enums.
org.forgerock.api.jackson
Extensions to Jackson's JSON Schema to support the API Descriptor extensions to standard JSON Schema.
org.forgerock.api.markup
Classes that generate CREST API Descriptor documentation.
org.forgerock.api.markup.asciidoc
AsciiDoc markup builder.
org.forgerock.api.models
ForgeRock API Descriptor models.
org.forgerock.api.transform
Classes that transform ApiDescription into different API representations.
org.forgerock.api.util
API Descriptor utility classes.
org.forgerock.authz.filter.api
This package defines the common authorization API interfaces and classes used by both the CREST API and CHF HTTP API.
org.forgerock.authz.filter.crest
This package defines the authorization framework implementation classes for use in a CREST environment.
org.forgerock.authz.filter.crest.api
This package defines the authorization API interfaces for use in a CREST environment.
org.forgerock.bloomfilter
ForgeRock Bloom Filters
org.forgerock.bloomfilter.monitoring  
org.forgerock.caf.authentication.api
This package defines the core interfaces and classes to provide an asynchronous and improved JASPI-like message authentication API.
org.forgerock.caf.authentication.framework
This package defines the authentication framework classes for the authentication of messages via authentication contexts and modules.
org.forgerock.caf.http
HTTP support for CAF.
org.forgerock.config.resolvers
This package contains the common config property resolvers.
org.forgerock.config.resolvers.template
This package contains the template parser used in property substitution.
org.forgerock.config.util
Contains utility classes for commons config.
org.forgerock.guava.common.collect
A collection of Guava interfaces that were previously packaged as "forgerock-guava".
org.forgerock.http
Models and manages elements of the Hypertext Transfer Protocol.
org.forgerock.http.client
This package contains the classes and interfaces related to the implementation of the HTTP client, and its use in scripted modules.
org.forgerock.http.client.request
This package contains the classes and interfaces related to the requests sent by the HTTP client, and their use in scripted modules.
org.forgerock.http.client.response
This package contains the classes and interfaces related to the responses received by the HTTP client, and their use in scripted modules.
org.forgerock.http.decoder
Decodes HTTP entities that are compressed or encoded.
org.forgerock.http.filter
Core Filter implementations.
org.forgerock.http.filter.cors
Support for CORS.
org.forgerock.http.handler
Core Handler implementations.
org.forgerock.http.header
Processes HTTP message header fields.
org.forgerock.http.header.authorization
Credentials classes for use with the AuthorizationHeader.
org.forgerock.http.io
Provides stream buffering, branching, and storage functions.
org.forgerock.http.oauth2
This package provides APIs for OAuth 2.0 services implementations.
org.forgerock.http.oauth2.resolver
This package defines OpenAM specific logic needed to retrieve an AccessTokenInfo.
org.forgerock.http.protocol
Models and manages elements of the Hypertext Transfer Protocol.
org.forgerock.http.routing
Provides routing functionality for HTTP requests.
org.forgerock.http.session
Provides interfaces for managing and interacting with HTTP Sessions.
org.forgerock.http.spi
HTTP service provider API.
org.forgerock.http.util
Miscellaneous utility classes.
org.forgerock.i18n
A i18n framework for embedding localizable messages in applications.
org.forgerock.i18n.slf4j
This package provides an alternative localization mechanism to org.slf4j.cal10n.
org.forgerock.jaspi.modules.openid
This package contains classes which form the Open ID Connect JASPIc AuthN module.
org.forgerock.jaspi.modules.session.jwt
This package contains classes for the Jwt Session JASPI Authentication Module.
org.forgerock.json
Provides an API for the traversal and manipulation of JSON object model structures in Java.
org.forgerock.json.jose.builders
Classes and interfaces for builder to build JWTs using a fluent API.
org.forgerock.json.jose.common
Common classes and interfaces for all types of JWTs.
org.forgerock.json.jose.exceptions
Exceptions for all possible JWT exception scenarios.
org.forgerock.json.jose.jwe
Classes and interfaces for JWT encryption and JWEs.
org.forgerock.json.jose.jwe.handlers.compression
Compression Handler classes for each possible compression algorithm.
org.forgerock.json.jose.jwe.handlers.encryption
Encryption Handler classes for each possible encryption algorithm.
org.forgerock.json.jose.jwk
Classes and interfaces for creating and manipulating JWKs.
org.forgerock.json.jose.jwk.store
This package contains classes to manage a JWKs URI.
org.forgerock.json.jose.jws
Classes and interfaces for JWT signing and JWS'.
org.forgerock.json.jose.jws.handlers
Signing Handler classes for each possible signing algorithm.
org.forgerock.json.jose.jwt
Classes and interfaces for JWTs.
org.forgerock.json.jose.tokenhandler
JWT implementation(s) of TokenHandler.
org.forgerock.json.jose.utils
Utility classes for JWT creation and manipulation.
org.forgerock.json.resource
Classes and interfaces for core types including connections, request handlers, resources, and their exceptions.
org.forgerock.macaroons
org.forgerock.monitoring
Common utility classes for monitoring.
org.forgerock.oauth
Commons OAuth Framework API.
org.forgerock.oauth.clients.apple
Forgerock Apple Client implementation.
org.forgerock.oauth.clients.facebook
Forgerock Facebook Client Implementation.
org.forgerock.oauth.clients.linkedin
Forgerock LinkedIn Client Implementation.
org.forgerock.oauth.clients.oauth2
OAuth 2.0 ForgeRock Client Implementation.
org.forgerock.oauth.clients.oidc
OpenID Connect ForgeRock Client Implementation.
org.forgerock.oauth.resolvers
This package contains classes to generate Open ID Resolvers, which can validate a supplied JWS against an Open ID Connect provider.
org.forgerock.oauth.resolvers.exceptions
This package contains classes to represent the different exceptions that can be thrown by the OpenID Connect JASPI module.
org.forgerock.oauth.resolvers.service
This package contains classes for a service which can be configured to produce OpenID Connect Resolvers.
org.forgerock.oauth2.core
Defines the core classes to implement OAuth2 for OpenAM.
org.forgerock.oauth2.core.exceptions
This package contains the exception classes that may be thrown by AM OAuth2 classes.
org.forgerock.oauth2.core.plugins
This package contains the API for writing OAuth2 plugins.
org.forgerock.openam.annotations
Contains annotations used by AM.
org.forgerock.openam.annotations.sm
Annotations for defining SMS service configurations.
org.forgerock.openam.auth.node.api
This package contains the API for writing authentication nodes.
org.forgerock.openam.authentication.modules.common.mapping
This package contains the mapping interfaces and default implementations that are common for use by all authentication modules.
org.forgerock.openam.authentication.modules.oath.plugins
Classes in this package provide plugin functionality for the oath module.
org.forgerock.openam.authentication.modules.oauth2
Provides classes for the OAuth 2.0 authentication module.
org.forgerock.openam.authentication.service
A collection of classes which support the authentication service.
org.forgerock.openam.core.realms
Classes to model realms within AM.
org.forgerock.openam.entitlement
Defines classes to handle entitlements.
org.forgerock.openam.federation.plugin.rooturl
Federation plugin root url classes.
org.forgerock.openam.http
This package contains utilities for HTTP connections.
org.forgerock.openam.ldap
This package contains utility methods to ease/unify development when using the OpenDJ LDAP SDK.
org.forgerock.openam.oauth2
Classes that provide AM's features as an OAuth 2.0 Authorization Server.
org.forgerock.openam.oauth2.extensions
Defines the classes and supported interface that customers need to create their own ResourceRegistrationFilter.
org.forgerock.openam.oauth2.token.macaroon
Functionality for issuing access and refresh token as Macaroons.
org.forgerock.openam.plugins
This package contains the API for writing AM plugins.
org.forgerock.openam.rest.resource
This package contains classes for the handling of REST request to CREST Resource endpoints with the concept of realms in OpenAM built in.
org.forgerock.openam.saml2.plugins
This package contains the API for writing SAML federation plugins.
org.forgerock.openam.scripting.api
The classes under this package do not support Localisation.
org.forgerock.openam.scripting.api.identity
Classes to help scripts interact with identities obtained from identity repositories.
org.forgerock.openam.scripting.api.secrets
A package containing a set of script-friendly classes and functionality that are intended to simplify use of the Secrets API from within a scripting context.
org.forgerock.openam.secrets
The AM supporting classes for centrally configuring secrets.
org.forgerock.openam.secrets.config
Classes and interfaces to create configurable secret store backends.
org.forgerock.openam.selfservice.config
Contains classes for handling self service console configuration.
org.forgerock.openam.selfservice.config.beans
Contains self service configuration beans.
org.forgerock.openam.services.email
Service interface for sending email messages and default implementation.
org.forgerock.openam.services.email.rest
REST implementation for sending email messages.
org.forgerock.openam.services.push
Defines classes for the Push Notification service and framework.
org.forgerock.openam.services.push.dispatch.predicates
Classes pertaining to the predicates used by the Push Service's Message Dispatcher.
org.forgerock.openam.session.service
Defines interfaces and classes for the Session Service.
org.forgerock.openam.shared.resourcename
This package contains url resource name utilities for use throughout the OpenAM codebase.
org.forgerock.openam.shared.security.crypto
This package contains security cryptographic utilities for use throughout the OpenAM codebase.
org.forgerock.openam.sm
This package contains exception types for service management error scenarios.
org.forgerock.openam.sm.annotations
Contains classes used to define services and their configuration based on annotations.
org.forgerock.openam.sm.annotations.adapters
Type adapters for converting a type to and from a set of strings, which is the underlying SMS representation for configuration.
org.forgerock.openam.sm.annotations.model
Model classes used in the processing of types of annotated methods.
org.forgerock.openam.sts
Base package for classes shared between the SOAP and REST STS.
org.forgerock.openam.sts.config.user
Contains the classes which encapsulate the user-provided configuration state necessary to publish a STS instance.
org.forgerock.openam.sts.rest.token.provider
Contains classes and interface definitions common to all token provider classes.
org.forgerock.openam.sts.rest.token.provider.oidc
Classes related to producing OpenIdConnect tokens
org.forgerock.openam.sts.rest.token.validator
Token validation occurs in three contexts in the sts: 1.
org.forgerock.openam.sts.token
Contains the classes related to token operations.
org.forgerock.openam.sts.tokengeneration.oidc
This package contains classes defining OpenId Connect Token generation and claim mapping.
org.forgerock.openam.sts.tokengeneration.saml2.statements
This package contains classes defining the interfaces consumed to obtain the various statements contituting SAML2 assertions.
org.forgerock.openam.sts.user.invocation
This package contains classes related to creating the json payloads corresponding to REST-STS and TokenGenerationService invocations.
org.forgerock.openam.uma
Classes that support AM's UMA AS functionality.
org.forgerock.openam.uma.extensions
Extension points for integrating with UMA functionality.
org.forgerock.openam.upgrade
Defines interfaces and classes to perform OpenAM system upgrade.
org.forgerock.openam.utils
This package contains general utilities for use throughout the OpenAM codebase.
org.forgerock.opendj.discovery
Contains the Service Discovery Mechanisms and APIs.
org.forgerock.opendj.io
Classes and interfaces providing I/O functionality.
org.forgerock.opendj.io.rx
Classes and interfaces providing Reactive Streams I/O transports.
org.forgerock.opendj.ldap
Classes and interfaces for core types including connections, entries, and attributes.
org.forgerock.opendj.ldap.controls
Classes and interfaces for common LDAP controls.
org.forgerock.opendj.ldap.messages
Classes and interfaces for core LDAP requests/responses.
org.forgerock.opendj.ldap.schema
Classes and interfaces for constructing and querying LDAP schemas.
org.forgerock.opendj.ldif
Classes and interfaces for reading and writing LDIF.
org.forgerock.opendj.security
An LDAP based security provider having the name "OpenDJ" and exposing an LDAP/LDIF based KeyStore service.
org.forgerock.openidconnect
Classes required for the AM OAuth2 OIDC implementation.
org.forgerock.secrets
Provides a unified API for accessing secrets of various kinds.
org.forgerock.secrets.gcp.sm
Classes for integrating Google Secret Manager into the ForgeRock Secrets API.
org.forgerock.secrets.gcpkms
A secret store implementation that can retrieve keys from a Google Cloud Platform Key Management Service.
org.forgerock.secrets.jwkset
Secret store backend for retrieving keys from a local or remote JWK Set.
org.forgerock.secrets.keys
Contains cryptographic key related API objects.
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.secrets.oauth2
A Secrets API backend that can obtain OAuth 2 access tokens from a token endpoint, along with a collection of grant type handlers.
org.forgerock.secrets.propertyresolver
Provides a SecretStore implementation that loads secrets from a Common Configuration PropertyResolver and then decodes it with a SecretPropertyFormat.
org.forgerock.secrets.vault
Secrets backend that reads secrets from a remote Hashicorp Vault server.
org.forgerock.security.keystore
This package contains classes that load, initialize, and access a managed keystore.
org.forgerock.selfservice.core
This package contains the core implementation for the anonymous process service.
org.forgerock.selfservice.core.annotations
This package contains annotations that allow product detection of Self-Service components.
org.forgerock.selfservice.core.config
This package contains the service configuration.
org.forgerock.selfservice.core.crypto
This package contains crypto related implementations for self-service.
org.forgerock.selfservice.core.snapshot
This package contains the implementation for creating and management of snapshots.
org.forgerock.selfservice.core.util
This package contains core utility methods and classes.
org.forgerock.selfservice.stages
This package contains common predefined anonymous process service parts.
org.forgerock.selfservice.stages.captcha
This package contains captcha stage implementation.
org.forgerock.selfservice.stages.email
This package contains a common email stage implementation.
org.forgerock.selfservice.stages.kba
This package contains a common user kba stage implementation.
org.forgerock.selfservice.stages.parameters
This package contains a parameter passing stage implementation.
org.forgerock.selfservice.stages.registration
This package contains a common user registration stage implementation.
org.forgerock.selfservice.stages.reset
This package contains a common reset password stage implementation.
org.forgerock.selfservice.stages.tokenhandlers
This package contains some common snapshot token handler implementations.
org.forgerock.selfservice.stages.user
This package contains a common user related stage implementation.
org.forgerock.selfservice.stages.utils
This package contains some utility classes helpful for stage creators.
org.forgerock.services
This package contains the classes classes and interfaces used in the services' implementations.
org.forgerock.services.context
This package contains the Context interface and various common protocol independent implementations.
org.forgerock.services.descriptor
Classes that allow services to be described.
org.forgerock.services.routing
This package provides a simple framework for implementing routers.
org.forgerock.tokenhandler
Provides token handler definition.
org.forgerock.util
Provides common interfaces and classes.
org.forgerock.util.annotations
Provides common annotations.
org.forgerock.util.crypto
Provides common crypto constants and classes.
org.forgerock.util.encode
Provides fast and memory efficient Base64, Base64Url, and Hex decoding and encoding.
org.forgerock.util.generator
Provides an abstraction of identifiers generators.
org.forgerock.util.i18n
Utility classes for dealing with internationalization (i18n).
org.forgerock.util.promise
An implementation of the Promise API in Java.
org.forgerock.util.query
Provides a mechanism for implementing query filters.
org.forgerock.util.thread
Provides a mechanism for handling shutdown of ExecutorService instances.
org.forgerock.util.thread.listener
Provides interfaces for handling shutdown.
org.forgerock.util.time
Provides a time service abstraction.
org.forgerock.util.xml
Provides utilities for reading and processing XML.