Skip navigation links
OpenIG 5.5.1 API

OpenIG 5.5.1 API

ForgeRock OpenIG 
Package Description
org.forgerock.openig.alias
Service Provider interface for registering type aliases.
org.forgerock.openig.config
Performs dynamic configuration bootstrap, discovery and input/output functions.
org.forgerock.openig.config.env
Different Environment implementations.
org.forgerock.openig.decoration
Decorator API to ease heap object customization and transformation.
org.forgerock.openig.decoration.baseuri
Contains a decorator which overrides the existing request URI, making requests relative to a new base URI.
org.forgerock.openig.decoration.capture
Capture decoration classes that prints filters and handlers input and output messages..
org.forgerock.openig.decoration.global
This package contains a special decorator that is responsible to invoke other decorators.
org.forgerock.openig.decoration.helper
Contains an abstract decorator dedicated to Filter and Handler.
org.forgerock.openig.decoration.timer
Contains a decorator that log time elapsed in a Filter or a Handler.
org.forgerock.openig.doc
Files for the Sample Application used in the product documentation.
org.forgerock.openig.el
Integrates with the Java Enterprise Edition Unified Expression Language API.
org.forgerock.openig.el.plugins
Plugins that provide expression context.
org.forgerock.openig.filter
Filters the requests and/or responses of HTTP.
org.forgerock.openig.filter.oauth2
This package contains the OAuth2 Token validation filter that acts as an OAuth 2 Resource Server.
org.forgerock.openig.filter.oauth2.client
OAuth 2.0 Client filter implementation.
org.forgerock.openig.filter.throttling
This package contains the components used to implement a throttling rate support.
org.forgerock.openig.handler
Handles HTTP requests by generating responses.
org.forgerock.openig.handler.resources
Contains components and APIs used to serve static resources.
org.forgerock.openig.handler.router
Provides automated router capability that loads its configurations files (called routes) from a given directory.
org.forgerock.openig.handler.saml
OpenIG SAML support.
org.forgerock.openig.heap
Manages collections or "heaps" of associated objects, initialized from declarative configuration artifacts.
org.forgerock.openig.http
Integrates with the ForgeRock HTTP Framework.
org.forgerock.openig.io
Provides stream buffering, branching, and storage functions.
org.forgerock.openig.jwt
Provides JWT capabilities to OpenIG.
org.forgerock.openig.jwt.dirty
Set of collection delegating classes to observes whenever a Map element is removed.
org.forgerock.openig.ldap
Facilitates access to the OpenDJ LDAP SDK from within scripts.
org.forgerock.openig.openam
OpenAM-specific integration classes.
org.forgerock.openig.policy
Service API for performing policy decisions.
org.forgerock.openig.policy.crest
CREST policy service integration classes.
org.forgerock.openig.regex
Matches, extracts and transforms text with regular expression patterns.
org.forgerock.openig.resolver
Performs object resolution for dynamic expression and script integration.
org.forgerock.openig.script
Scripting support.
org.forgerock.openig.security
Provides heap objects for security related types (KeyStore, KeyManagerFactory, ...).
org.forgerock.openig.text
Processes structured text in streams and files.
org.forgerock.openig.thread
Provides heaplets for creating thread pools.
org.forgerock.openig.tools
Common tools used in policy service.
org.forgerock.openig.ui.record
Defines a storage service to be used by the UI to persist its component model.
org.forgerock.openig.uma
This package contains the UMA (User Managed Access) components used to support the Uma Resource Server role.
org.forgerock.openig.util
Miscellaneous utility classes.
ForgeRock Commons Audit 
Package Description
org.forgerock.audit
Package contains the AuditService.
org.forgerock.audit.batch
Package contains common audit batch configuration files.
org.forgerock.audit.events
Package contains audit events.
org.forgerock.audit.events.handlers
This package contains the default AuditEventHandlers.
org.forgerock.audit.events.handlers.buffering
This package contains the batch publisher and its various implementations.
org.forgerock.audit.events.handlers.writers
Utility classes for writing streams of characters.
org.forgerock.audit.filter
Contains the classes for filtering audit events.
org.forgerock.audit.handlers.csv
This package contains the default AuditEventHandler implementations.
org.forgerock.audit.handlers.elasticsearch
This package contains the Elasticsearch AuditEventHandler implementation.
org.forgerock.audit.handlers.jdbc
This package contains a JDBC AuditEventHandler implementation.
org.forgerock.audit.handlers.jms
This package contains a JMS AuditEventHandler implementation.
org.forgerock.audit.handlers.json
This package contains the JSON-file AuditEventHandler implementation.
org.forgerock.audit.handlers.splunk
This package contains the audit handler implementation for Splunk.
org.forgerock.audit.handlers.syslog
This package contains a Syslog AuditEventHandler implementation.
org.forgerock.audit.json
This package contains utilities to build and configure audit service and handlers from JSON configuration.
org.forgerock.audit.providers
Dependencies that can be made available to the AuditService via a DependencyProvider.
org.forgerock.audit.retention
File retention classes.
org.forgerock.audit.rotation
Audit log file rotation classes.
org.forgerock.audit.secure
Classes for handling secure audit logging.
org.forgerock.audit.util
This package contains utility classes used in the audit service.
ForgeRock Http Framework 
Package Description
org.forgerock.http
Models and manages elements of the Hypertext Transfer Protocol.
org.forgerock.http.apache
Base classes for Apache HttpClient (synchronous and asynchronous) HttpClientProvider implementations.
org.forgerock.http.apache.async
Provides HttpClientHandler client integration with Apache HttpComponents Http Async Client.
org.forgerock.http.decoder
Decodes HTTP entities that are compressed or encoded.
org.forgerock.http.filter
Core Filter implementations.
org.forgerock.http.filter.throttling
This package contains the components used to implement a throttling rate support.
org.forgerock.http.handler
Core Handler implementations.
org.forgerock.http.header
Processes HTTP message header fields.
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.servlet
Integrates with the Java Enterprise Edition Servlet API.
org.forgerock.http.session
Provides interfaces for managing and interacting with HTTP Sessions.
org.forgerock.http.spi
HTTP service provider API.
org.forgerock.http.swagger
Classes to support OpenAPI API Descriptions using Swagger.
org.forgerock.http.util
Miscellaneous utility classes.
ForgeRock Utilities 
Package Description
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.json.resource.http
JSON resource Commons HTTP Framework integration.
org.forgerock.json.schema.validator
These classes are the commonly used classes from other applications.
org.forgerock.json.schema.validator.exceptions
Schema validator exceptions.
org.forgerock.json.schema.validator.helpers
These classes are capable of helping the validators to check certain constraints.
org.forgerock.json.schema.validator.validators
These classes are capable of validating the objects against the initially loaded schema.
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 and Base64Url 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.
Other Packages 
Package Description
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.i18n
A common framework for embedding localizable messages in applications.
org.forgerock.i18n.slf4j
This package provides an alternative localization mechanism to org.slf4j.cal10n.
org.forgerock.security.keystore
This package contains classes that load, initialize, and access a managed keystore.
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.
Skip navigation links
OpenIG 5.5.1 API

Copyright 2011-2017 ForgeRock AS.