OpenIG 3.0.0 API
A B C D E F G H I J K L M N O P Q R S T U V W 

A

AbstractScriptableHeapObject - Class in org.forgerock.openig.script
An abstract scriptable heap object which should be used as the base class for implementing filters and handlers.
AbstractScriptableHeapObject(Script) - Constructor for class org.forgerock.openig.script.AbstractScriptableHeapObject
Creates a new scriptable heap object using the provided compiled script.
AbstractScriptableHeapObject.AbstractScriptableHeaplet - Class in org.forgerock.openig.script
Creates and initializes a capture filter in a heap environment.
AbstractScriptableHeapObject.AbstractScriptableHeaplet() - Constructor for class org.forgerock.openig.script.AbstractScriptableHeapObject.AbstractScriptableHeaplet
 
ACCESS_TOKEN_KEY - Static variable in class org.forgerock.openig.filter.oauth2.OAuth2ResourceServerFilter
The key under which downstream handlers will find the access token in the Exchange.
AccessToken - Interface in org.forgerock.openig.filter.oauth2
Represents an OAuth2 Access Token.
AccessTokenResolver - Interface in org.forgerock.openig.filter.oauth2
Resolves a given token against a dedicated OAuth2 Identity Provider (OpenAM, Google, Facebook, ...).
add(AddRequest) - Method in class org.forgerock.openig.ldap.LdapConnection
Adds an entry to the Directory Server using the provided add request.
add(Entry) - Method in class org.forgerock.openig.ldap.LdapConnection
Adds the provided entry to the Directory Server.
add(String...) - Method in class org.forgerock.openig.ldap.LdapConnection
Adds an entry to the Directory Server using the provided lines of LDIF.
add(String) - Method in class org.forgerock.openig.util.CaseInsensitiveSet
 
add(K, V) - Method in class org.forgerock.openig.util.MultiValueMap
Adds the specified value to the list for the specified key.
add(E) - Method in class org.forgerock.openig.util.SetDecorator
Adds the specified element to the set if it is not already present (optional operation).
addAll(Collection<? extends String>) - Method in class org.forgerock.openig.util.CaseInsensitiveSet
 
addAll(K, Collection<? extends V>) - Method in class org.forgerock.openig.util.MultiValueMap
Adds the specified values to the list for the specified key.
addAll(MultiValueMap<K, V>) - Method in class org.forgerock.openig.util.MultiValueMap
Adds the specified keys and values from the specified map into this map.
addAll(Map<? extends K, Collection<? extends V>>) - Method in class org.forgerock.openig.util.MultiValueMap
Adds the specified keys and values from the specified map into this map.
addAll(Collection<? extends E>) - Method in class org.forgerock.openig.util.SetDecorator
Adds all of the elements in the specified collection to the set if they're not already present (optional operation).
addBinding(Expression, Handler, URI) - Method in class org.forgerock.openig.handler.DispatchHandler
Binds an expression to the current handler to dispatch to.
addBinding(Handler, Expression) - Method in class org.forgerock.openig.handler.SequenceHandler
Binds sequenced handlers with sequence processing postconditions.
addFormParameter(String, Expression) - Method in class org.forgerock.openig.filter.StaticRequestFilter
Adds a new form parameter using the given key with the given Expression.
addHeader(String, Expression) - Method in class org.forgerock.openig.handler.StaticResponseHandler
Adds a pair key / expression to the header.
addHeaderValue(String, Expression) - Method in class org.forgerock.openig.filter.StaticRequestFilter
Adds a new header value using the given key with the given Expression.
addProvider(OAuth2Provider) - Method in class org.forgerock.openig.filter.oauth2.client.OAuth2ClientFilter
Adds an authorization provider.
addRequestBinding(Expression) - Method in class org.forgerock.openig.filter.AssignmentFilter
Registers an unconditional (always executed) binding on the request flow.
addRequestBinding(Expression, Expression) - Method in class org.forgerock.openig.filter.AssignmentFilter
Registers an unconditional (always executed) binding on the request flow.
addRequestBinding(Expression, Expression, Expression) - Method in class org.forgerock.openig.filter.AssignmentFilter
Registers a conditional binding on the request flow.
addRequestCase(Expression, Handler) - Method in class org.forgerock.openig.filter.SwitchFilter
Add a request switch case with a condition and the handler to execute if condition yields.
addResponseBinding(Expression) - Method in class org.forgerock.openig.filter.AssignmentFilter
Registers an unconditional (always executed) binding on the response flow.
addResponseBinding(Expression, Expression) - Method in class org.forgerock.openig.filter.AssignmentFilter
Registers an unconditional (always executed) binding on the response flow.
addResponseBinding(Expression, Expression, Expression) - Method in class org.forgerock.openig.filter.AssignmentFilter
Registers a conditional binding on the response flow.
addResponseCase(Expression, Handler) - Method in class org.forgerock.openig.filter.SwitchFilter
Add a response switch case with a condition and the handler to execute if condition yields.
addUnconditionalBinding(Handler, URI) - Method in class org.forgerock.openig.handler.DispatchHandler
Adds an unconditional bindings to the handler.
append(byte[], int, int) - Method in interface org.forgerock.openig.io.Buffer
Appends len bytes from the specified byte array starting at offset off to the end of the buffer.
append(byte[], int, int) - Method in class org.forgerock.openig.io.FileBuffer
 
append(byte[], int, int) - Method in class org.forgerock.openig.io.MemoryBuffer
 
append(byte[], int, int) - Method in class org.forgerock.openig.io.TemporaryBuffer
 
appendExtraAttributes(StringBuilder) - Method in class org.forgerock.openig.filter.oauth2.challenge.AuthenticateChallengeHandler
Permits sub-classes to append extra attributes to the challenge.
appendExtraAttributes(StringBuilder) - Method in class org.forgerock.openig.filter.oauth2.challenge.InsufficientScopeChallengeHandler
 
appendRequestQuery(Request) - Method in class org.forgerock.openig.http.Form
Appends the form as additional query parameters on an existing request URI.
applyTo(MatchResult) - Method in class org.forgerock.openig.regex.PatternTemplate
Performs a transformation of a match result by applying the template.
ArrayResolver - Class in org.forgerock.openig.resolver
Resolves native arrays of objects.
ArrayResolver() - Constructor for class org.forgerock.openig.resolver.ArrayResolver
 
asClass(JsonValue) - Static method in class org.forgerock.openig.util.JsonValueUtil
Returns the class object associated with a named class or interface, using the thread context class loader.
asExpression(JsonValue) - Static method in class org.forgerock.openig.util.JsonValueUtil
Returns a JSON value string value as an expression.
asNewInstance(JsonValue, Class<T>) - Static method in class org.forgerock.openig.util.JsonValueUtil
Creates a new instance of a named class.
AssignmentFilter - Class in org.forgerock.openig.filter
Conditionally assigns values to expressions before and after the exchange is handled.
AssignmentFilter() - Constructor for class org.forgerock.openig.filter.AssignmentFilter
 
AssignmentFilter.Heaplet - Class in org.forgerock.openig.filter
Creates and initializes an assignment filter in a heap environment.
AssignmentFilter.Heaplet() - Constructor for class org.forgerock.openig.filter.AssignmentFilter.Heaplet
 
asString(InputStream, Charset) - Static method in class org.forgerock.openig.util.StringUtil
Reads the provided input stream as a string and then closes the stream.
asURI() - Method in class org.forgerock.openig.util.MutableUri
Returns the equivalent URI instance.
AuthenticateChallengeHandler - Class in org.forgerock.openig.filter.oauth2.challenge
This handler build an authentication challenge to be returned in the Response Authorization HTTP header.
AuthenticateChallengeHandler(String, String, String, String) - Constructor for class org.forgerock.openig.filter.oauth2.challenge.AuthenticateChallengeHandler
Creates a new AuthenticateChallengeHandler.
available() - Method in class org.forgerock.openig.io.BranchingStreamWrapper
Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking by the next invocation of a method for this input stream.
available() - Method in class org.forgerock.openig.io.ByteArrayBranchingStream
Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking by the next invocation of a method for this input stream.
available() - Method in class org.forgerock.openig.io.NullInputStream
Always returns 0 to indicate that no bytes are available.

B

BASE_ENV_VARIABLE - Static variable in class org.forgerock.openig.servlet.WebEnvironment
Environment variable name.
BASE_INIT_PARAM - Static variable in class org.forgerock.openig.servlet.WebEnvironment
Servlet's init-param name.
BASE_SYSTEM_PROPERTY - Static variable in class org.forgerock.openig.servlet.WebEnvironment
System property name that can be specified through command line.
BeanResolver - Class in org.forgerock.openig.resolver
Resolves Java Beans objects.
BeanResolver() - Constructor for class org.forgerock.openig.resolver.BeanResolver
Builds a new BeanResolver around an EL BeanELResolver instance.
BearerTokenExtractor - Class in org.forgerock.openig.filter.oauth2
Extracts the bearer token from the request's authorization header.
BearerTokenExtractor() - Constructor for class org.forgerock.openig.filter.oauth2.BearerTokenExtractor
 
bestEffortResourceServerError(int, OAuth2Error) - Static method in class org.forgerock.openig.filter.oauth2.client.OAuth2Error
Returns an OAuth 2.0 resource server error whose values are determined on a best-effort basis from the provided incomplete error and HTTP status code.
bind(BindRequest) - Method in class org.forgerock.openig.ldap.LdapConnection
Authenticates to the Directory Server using the provided bind request.
bind(String, char[]) - Method in class org.forgerock.openig.ldap.LdapConnection
Authenticates to the Directory Server using simple authentication and the provided user name and password.
branch() - Method in class org.forgerock.openig.io.BranchingInputStream
Creates a new branch at this stream's current position.
branch() - Method in class org.forgerock.openig.io.BranchingStreamWrapper
 
branch() - Method in class org.forgerock.openig.io.ByteArrayBranchingStream
 
BranchingInputStream - Class in org.forgerock.openig.io
An input stream that can branch into separate input streams to perform divergent reads.
BranchingInputStream() - Constructor for class org.forgerock.openig.io.BranchingInputStream
 
BranchingStreamWrapper - Class in org.forgerock.openig.io
Wraps an standard input stream with a stream that can branch to perform divergent reads.
BranchingStreamWrapper(InputStream, Factory<Buffer>) - Constructor for class org.forgerock.openig.io.BranchingStreamWrapper
Constructs a new branching input stream to wrap another input stream.
Buffer - Interface in org.forgerock.openig.io
A dynamically growing data buffer.
build(JsonValue) - Method in class org.forgerock.openig.filter.oauth2.resolver.OpenAmAccessToken.Builder
Builds a OpenAmAccessToken from a raw JSON response returned by the /oauth2/tokeninfo endpoint.
ByteArrayBranchingStream - Class in org.forgerock.openig.io
Wraps a byte array with a stream that can branch to perform divergent reads.
ByteArrayBranchingStream(byte[]) - Constructor for class org.forgerock.openig.io.ByteArrayBranchingStream
Constructs a new branching input stream that wraps a byte array.

C

CachingAccessTokenResolver - Class in org.forgerock.openig.filter.oauth2.cache
A CachingAccessTokenResolver is a delegating AccessTokenResolver that uses a write-through cache to enable fast AccessToken resolution.
CachingAccessTokenResolver(AccessTokenResolver, ThreadSafeCache<String, AccessToken>) - Constructor for class org.forgerock.openig.filter.oauth2.cache.CachingAccessTokenResolver
Builds a CachingAccessTokenResolver delegating to the given AccessTokenResolver using the given (pre-configured) cache.
CaptureFilter - Class in org.forgerock.openig.filter
Captures request and response messages for further analysis.
CaptureFilter() - Constructor for class org.forgerock.openig.filter.CaptureFilter
 
CaptureFilter.FileWriterProvider - Class in org.forgerock.openig.filter
Provides a PrintWriter instance based on a File.
CaptureFilter.FileWriterProvider(File) - Constructor for class org.forgerock.openig.filter.CaptureFilter.FileWriterProvider
Construct a new FileWriterProvider using the given file as destination.
CaptureFilter.FileWriterProvider(File, Charset) - Constructor for class org.forgerock.openig.filter.CaptureFilter.FileWriterProvider
Construct a new FileWriterProvider using the given file as destination and the given Charset.
CaptureFilter.Heaplet - Class in org.forgerock.openig.filter
Creates and initializes a capture filter in a heap environment.
CaptureFilter.Heaplet() - Constructor for class org.forgerock.openig.filter.CaptureFilter.Heaplet
 
CaptureFilter.WriterProvider - Interface in org.forgerock.openig.filter
Provides an abstraction to make PrintWriter plugable.
CaseInsensitiveMap<V> - Class in org.forgerock.openig.util
An implementation of a map whose keys are case-insensitive strings.
CaseInsensitiveMap() - Constructor for class org.forgerock.openig.util.CaseInsensitiveMap
Constructs a new empty case-insensitive map.
CaseInsensitiveMap(Map<String, V>) - Constructor for class org.forgerock.openig.util.CaseInsensitiveMap
Wraps an existing map with a new case insensitive map.
CaseInsensitiveSet - Class in org.forgerock.openig.util
An implementation of a set whose values are case-insensitive strings.
CaseInsensitiveSet() - Constructor for class org.forgerock.openig.util.CaseInsensitiveSet
Constructs a new empty case-insensitive set.
CaseInsensitiveSet(Collection<String>) - Constructor for class org.forgerock.openig.util.CaseInsensitiveSet
Constructs a new case-insensitive set containing the elements in the specified collection.
CaseInsensitiveSet(int, float) - Constructor for class org.forgerock.openig.util.CaseInsensitiveSet
Constructs a new, empty case-insensitive set; the backing HashSet instance has the specified initial capacity and the specified load factor.
CaseInsensitiveSet(int) - Constructor for class org.forgerock.openig.util.CaseInsensitiveSet
Constructs a new, empty case-insensitive set; the backing HashSet instance has the specified initial capacity and default load factor.
Chain - Class in org.forgerock.openig.filter
A chain of exchange zero or more filters and one handler.
Chain(Handler) - Constructor for class org.forgerock.openig.filter.Chain
Builds a chain of filters that will finally dispatch to the given handler.
Chain.Heaplet - Class in org.forgerock.openig.filter
Creates and initializes a filter chain in a heap environment.
Chain.Heaplet() - Constructor for class org.forgerock.openig.filter.Chain.Heaplet
 
ClassAliasResolver - Interface in org.forgerock.openig.alias
This interface has to be implemented by each OpenIG module that wants to register new class aliases.
clear() - Method in class org.forgerock.openig.filter.oauth2.cache.ThreadSafeCache
Clean-up the cache entries.
clear() - Method in class org.forgerock.openig.servlet.ServletSession
 
clear() - Method in class org.forgerock.openig.util.CaseInsensitiveMap
 
clear() - Method in class org.forgerock.openig.util.CaseInsensitiveSet
 
clear() - Method in class org.forgerock.openig.util.ExtensibleFieldMap
 
clear() - Method in class org.forgerock.openig.util.SetDecorator
Removes all of the elements from the set (optional operation).
ClientHandler - Class in org.forgerock.openig.handler
Submits exchange requests to remote servers.
ClientHandler(HttpClient) - Constructor for class org.forgerock.openig.handler.ClientHandler
Creates a new client handler.
ClientHandler.Heaplet - Class in org.forgerock.openig.handler
Creates and initializes a client handler in a heap environment.
ClientHandler.Heaplet() - Constructor for class org.forgerock.openig.handler.ClientHandler.Heaplet
 
close() - Method in class org.forgerock.openig.http.Entity
Closes all resources associated with this entity.
close() - Method in class org.forgerock.openig.http.Message
Closes all resources associated with the entity.
close() - Method in class org.forgerock.openig.io.BranchingInputStream
Closes this branching stream and all of the branches created from it.
close() - Method in class org.forgerock.openig.io.BranchingStreamWrapper
 
close() - Method in interface org.forgerock.openig.io.Buffer
Closes the buffer and releases any system resources associated with it.
close() - Method in class org.forgerock.openig.io.ByteArrayBranchingStream
Has no effect.
close() - Method in class org.forgerock.openig.io.FileBuffer
 
close() - Method in class org.forgerock.openig.io.MemoryBuffer
 
close() - Method in class org.forgerock.openig.io.TemporaryBuffer
 
close() - Method in class org.forgerock.openig.ldap.LdapConnection
Releases any resources associated with this connection.
close() - Method in class org.forgerock.openig.regex.StreamPatternMatches
Closes this character stream, as well as the the reader it its iterating over.
close() - Method in class org.forgerock.openig.text.SeparatedValuesReader
Closes the reader and releases any system resources associated with it.
compare(CompareRequest) - Method in class org.forgerock.openig.ldap.LdapConnection
Compares an entry in the Directory Server using the provided compare request.
compare(String, String, String) - Method in class org.forgerock.openig.ldap.LdapConnection
Compares the named entry in the Directory Server against the provided attribute value assertion.
compareTo(MutableUri) - Method in class org.forgerock.openig.util.MutableUri
 
config - Variable in class org.forgerock.openig.heap.GenericHeaplet
The heaplet's object configuration object.
config(String) - Method in class org.forgerock.openig.log.Logger
Logs the specified message at the CONFIG log level.
config(T) - Method in class org.forgerock.openig.log.Logger
Logs the specified exception at the CONFIG log level.
connect(String, int) - Method in class org.forgerock.openig.ldap.LdapClient
Returns an LDAP connection for the specified LDAP server.
connect(String, int, LDAPOptions) - Method in class org.forgerock.openig.ldap.LdapClient
Returns an LDAP connection for the specified LDAP server using the provided LDAP options.
ConnectionHeader - Class in org.forgerock.openig.header
Processes the Connection message header.
ConnectionHeader() - Constructor for class org.forgerock.openig.header.ConnectionHeader
Constructs a new empty header.
ConnectionHeader(Message<?>) - Constructor for class org.forgerock.openig.header.ConnectionHeader
Constructs a new header, initialized from the specified message.
ConnectionHeader(String) - Constructor for class org.forgerock.openig.header.ConnectionHeader
Constructs a new header, initialized from the specified string value.
ConsoleLogSink - Class in org.forgerock.openig.log
A sink that writes log entries to the standard error stream.
ConsoleLogSink() - Constructor for class org.forgerock.openig.log.ConsoleLogSink
 
ConsoleLogSink.Heaplet - Class in org.forgerock.openig.log
Creates and initializes a console sink in a heap environment.
ConsoleLogSink.Heaplet() - Constructor for class org.forgerock.openig.log.ConsoleLogSink.Heaplet
 
contains(Object, Object) - Static method in class org.forgerock.openig.el.Functions
Returns true if the object contains the value.
contains(Object) - Method in class org.forgerock.openig.util.CaseInsensitiveSet
 
contains(Object) - Method in class org.forgerock.openig.util.SetDecorator
Returns true if the set contains the specified element.
containsAll(Collection<?>) - Method in class org.forgerock.openig.util.CaseInsensitiveSet
 
containsAll(Collection<?>) - Method in class org.forgerock.openig.util.SetDecorator
Returns true if the set contains all of the elements of the specified collection.
containsKey(Object) - Method in class org.forgerock.openig.http.RequestCookies
 
containsKey(Object) - Method in class org.forgerock.openig.servlet.ServletSession
 
containsKey(Object) - Method in class org.forgerock.openig.util.CaseInsensitiveMap
 
containsKey(Object) - Method in class org.forgerock.openig.util.ExtensibleFieldMap
 
containsValue(Object) - Method in class org.forgerock.openig.http.RequestCookies
 
ContentEncodingHeader - Class in org.forgerock.openig.header
Processes the Content-Encoding message header.
ContentEncodingHeader() - Constructor for class org.forgerock.openig.header.ContentEncodingHeader
Constructs a new empty header.
ContentEncodingHeader(Message<?>) - Constructor for class org.forgerock.openig.header.ContentEncodingHeader
Constructs a new header, initialized from the specified message.
ContentEncodingHeader(String) - Constructor for class org.forgerock.openig.header.ContentEncodingHeader
Constructs a new header, initialized from the specified string value.
ContentLengthHeader - Class in org.forgerock.openig.header
Processes the Content-Length message header.
ContentLengthHeader() - Constructor for class org.forgerock.openig.header.ContentLengthHeader
Constructs a new empty header.
ContentLengthHeader(Message<?>) - Constructor for class org.forgerock.openig.header.ContentLengthHeader
Constructs a new header, initialized from the specified message.
ContentLengthHeader(String) - Constructor for class org.forgerock.openig.header.ContentLengthHeader
Constructs a new header, initialized from the specified string value.
ContentTypeHeader - Class in org.forgerock.openig.header
Processes the Content-Type message header.
ContentTypeHeader() - Constructor for class org.forgerock.openig.header.ContentTypeHeader
Constructs a new empty header.
ContentTypeHeader(Message<?>) - Constructor for class org.forgerock.openig.header.ContentTypeHeader
Constructs a new header, initialized from the specified message.
ContentTypeHeader(String) - Constructor for class org.forgerock.openig.header.ContentTypeHeader
Constructs a new header, initialized from the specified string value.
convertTo(TimeUnit) - Method in class org.forgerock.openig.util.Duration
Convert the current duration to a given TimeUnit.
Cookie - Class in org.forgerock.openig.http
An HTTP cookie.
Cookie() - Constructor for class org.forgerock.openig.http.Cookie
Creates a new uninitialized cookie.
CookieFilter - Class in org.forgerock.openig.filter
Suppresses, relays and manages cookies.
CookieFilter() - Constructor for class org.forgerock.openig.filter.CookieFilter
 
CookieFilter.Action - Enum in org.forgerock.openig.filter
Action to be performed for a cookie.
CookieFilter.Heaplet - Class in org.forgerock.openig.filter
Creates and initializes a cookie filter in a heap environment.
CookieFilter.Heaplet() - Constructor for class org.forgerock.openig.filter.CookieFilter.Heaplet
 
CookieHeader - Class in org.forgerock.openig.header
Processes the Cookie request message header.
CookieHeader() - Constructor for class org.forgerock.openig.header.CookieHeader
Constructs a new empty header.
CookieHeader(Message<?>) - Constructor for class org.forgerock.openig.header.CookieHeader
Constructs a new header, initialized from the specified message.
CookieHeader(String) - Constructor for class org.forgerock.openig.header.CookieHeader
Constructs a new header, initialized from the specified string value.
copyDecodedContentTo(OutputStream) - Method in class org.forgerock.openig.http.Entity
Copies the decoded content of this entity to the provided writer.
copyDecodedContentTo(Writer) - Method in class org.forgerock.openig.http.Entity
Copies the decoded content of this entity to the provided writer.
copyRawContentTo(OutputStream) - Method in class org.forgerock.openig.http.Entity
Copies the raw content of this entity to the provided output stream.
CoreClassAliasResolver - Class in org.forgerock.openig.alias
Register all the aliases supported by the openig-core module.
CoreClassAliasResolver() - Constructor for class org.forgerock.openig.alias.CoreClassAliasResolver
 
create() - Method in class org.forgerock.openig.filter.AssignmentFilter.Heaplet
 
create() - Method in class org.forgerock.openig.filter.CaptureFilter.Heaplet
 
create() - Method in class org.forgerock.openig.filter.Chain.Heaplet
 
create() - Method in class org.forgerock.openig.filter.CookieFilter.Heaplet
 
create() - Method in class org.forgerock.openig.filter.CryptoHeaderFilter.Heaplet
 
create() - Method in class org.forgerock.openig.filter.EntityExtractFilter.Heaplet
 
create() - Method in class org.forgerock.openig.filter.ExceptionFilter.Heaplet
 
create() - Method in class org.forgerock.openig.filter.FileAttributesFilter.Heaplet
 
create() - Method in class org.forgerock.openig.filter.HeaderFilter.Heaplet
 
create() - Method in class org.forgerock.openig.filter.HttpBasicAuthFilter.Heaplet
 
create() - Method in class org.forgerock.openig.filter.oauth2.client.OAuth2ClientFilter.Heaplet
 
create() - Method in class org.forgerock.openig.filter.oauth2.OAuth2ResourceServerFilter.Heaplet
 
create() - Method in class org.forgerock.openig.filter.RedirectFilter.Heaplet
 
create() - Method in class org.forgerock.openig.filter.SqlAttributesFilter.Heaplet
 
create() - Method in class org.forgerock.openig.filter.StaticRequestFilter.Heaplet
 
create() - Method in class org.forgerock.openig.filter.SwitchFilter.Heaplet
 
create() - Method in class org.forgerock.openig.handler.ClientHandler.Heaplet
 
create() - Method in class org.forgerock.openig.handler.DispatchHandler.Heaplet
 
create() - Method in class org.forgerock.openig.handler.router.RouterHandler.Heaplet
 
create() - Method in class org.forgerock.openig.handler.saml.SamlFederationHandler.Heaplet
 
create() - Method in class org.forgerock.openig.handler.SequenceHandler.Heaplet
 
create() - Method in class org.forgerock.openig.handler.StaticResponseHandler.Heaplet
 
create() - Method in class org.forgerock.openig.handler.WelcomeHandler.Heaplet
 
create(String, JsonValue, Heap) - Method in class org.forgerock.openig.heap.GenericHeaplet
 
create() - Method in class org.forgerock.openig.heap.GenericHeaplet
Called to request the heaplet create an object.
create(String, JsonValue, Heap) - Method in interface org.forgerock.openig.heap.Heaplet
Called to request the heaplet create an object.
create() - Method in class org.forgerock.openig.http.HttpClient.Heaplet
 
create() - Method in class org.forgerock.openig.io.TemporaryStorage.Heaplet
 
create() - Method in class org.forgerock.openig.log.ConsoleLogSink.Heaplet
 
create() - Method in class org.forgerock.openig.log.FileLogSink.Heaplet
 
create() - Method in class org.forgerock.openig.script.AbstractScriptableHeapObject.AbstractScriptableHeaplet
 
create(String, String, String, int, String, String, String) - Static method in class org.forgerock.openig.util.URIUtil
Returns a hierarchical URI constructed from the given components.
createResponse() - Method in class org.forgerock.openig.filter.oauth2.challenge.AuthenticateChallengeHandler
Creates a Response with the appropriate status code and reason.
createResponse() - Method in class org.forgerock.openig.filter.oauth2.challenge.InsufficientScopeChallengeHandler
 
createResponse() - Method in class org.forgerock.openig.filter.oauth2.challenge.InvalidRequestChallengeHandler
 
createResponse() - Method in class org.forgerock.openig.filter.oauth2.challenge.InvalidTokenChallengeHandler
 
createResponse() - Method in class org.forgerock.openig.filter.oauth2.challenge.NoAuthenticationChallengeHandler
 
CryptoHeaderFilter - Class in org.forgerock.openig.filter
Encrypts and decrypts header fields.
CryptoHeaderFilter() - Constructor for class org.forgerock.openig.filter.CryptoHeaderFilter
 
CryptoHeaderFilter.Heaplet - Class in org.forgerock.openig.filter
Creates and initializes a header filter in a heap environment.
CryptoHeaderFilter.Heaplet() - Constructor for class org.forgerock.openig.filter.CryptoHeaderFilter.Heaplet
 
CryptoHeaderFilter.Operation - Enum in org.forgerock.openig.filter
Should the filter encrypt or decrypt the given headers ?

D

debug(String) - Method in class org.forgerock.openig.log.Logger
Logs the specified message at the DEBUG log level.
debug(T) - Method in class org.forgerock.openig.log.Logger
Logs the specified exception at the DEBUG log level.
decode(InputStream) - Method in interface org.forgerock.openig.decoder.Decoder
Returns an instance of an input stream that decodes the specified input.
decode(InputStream) - Method in class org.forgerock.openig.decoder.DeflateDecoder
 
decode(InputStream) - Method in class org.forgerock.openig.decoder.GzipDecoder
 
decode(InputStream) - Method in class org.forgerock.openig.header.ContentEncodingHeader
Returns an input stream that decodes the specified input stream, given the content-codings that are specified in the codings list.
decodeBase64(String) - Static method in class org.forgerock.openig.el.Functions
Decode the given Base64 String input.
Decoder - Interface in org.forgerock.openig.decoder
Decodes an HTTP message entity input stream.
DEFAULT_ALGORITHM - Static variable in class org.forgerock.openig.filter.CryptoHeaderFilter
Default Cipher algorithm to be used when none is specified.
DEFAULT_CONNECTION_TIMEOUT - Static variable in class org.forgerock.openig.http.HttpClient
Default connection timeout as a Duration.
DEFAULT_CONNECTIONS - Static variable in class org.forgerock.openig.http.HttpClient
Default maximum number of collections through HTTP client.
DEFAULT_REALM_NAME - Static variable in class org.forgerock.openig.filter.oauth2.OAuth2ResourceServerFilter
Name of the realm when none is specified in the heaplet.
DEFAULT_RESTORE - Static variable in class org.forgerock.openig.filter.StaticRequestFilter
By default, do not restore the original Request back into exchange.request.
DEFAULT_SO_TIMEOUT - Static variable in class org.forgerock.openig.http.HttpClient
Default socket timeout as a Duration.
DefaultEnvironment - Class in org.forgerock.openig.config.env
Reify the normal environment structure with pre-configured shortcuts.
DefaultEnvironment(File) - Constructor for class org.forgerock.openig.config.env.DefaultEnvironment
Builds a new file based Environment using the given file as the base directory.
DeflateDecoder - Class in org.forgerock.openig.decoder
Decodes an entity encoded with deflate encoding.
DeflateDecoder() - Constructor for class org.forgerock.openig.decoder.DeflateDecoder
 
delegate() - Method in class org.forgerock.openig.config.env.EnvironmentDelegate
Returns the environment delegatee.
delegate() - Method in class org.forgerock.openig.config.env.PlatformEnvironment
 
delegate() - Method in class org.forgerock.openig.config.env.UnixEnvironment
 
delegate() - Method in class org.forgerock.openig.config.env.WindowsEnvironment
 
delegate() - Method in class org.forgerock.openig.servlet.WebEnvironment
 
delete(DeleteRequest) - Method in class org.forgerock.openig.ldap.LdapConnection
Deletes an entry from the Directory Server using the provided delete request.
delete(String) - Method in class org.forgerock.openig.ldap.LdapConnection
Deletes the named entry from the Directory Server.
deleteSubtree(String) - Method in class org.forgerock.openig.ldap.LdapConnection
Deletes the named entry and all of its subordinates from the Directory Server.
destroy() - Method in class org.forgerock.openig.filter.oauth2.OAuth2ResourceServerFilter.Heaplet
 
destroy() - Method in class org.forgerock.openig.handler.router.RouterHandler.Heaplet
 
destroy() - Method in class org.forgerock.openig.handler.saml.SamlFederationHandler.Heaplet
 
destroy() - Method in class org.forgerock.openig.heap.GenericHeaplet
 
destroy() - Method in class org.forgerock.openig.heap.HeapImpl
Destroys the objects on the heap and dereferences all associated objects.
destroy() - Method in interface org.forgerock.openig.heap.Heaplet
Called to indicate that the object created by the heaplet is going to be dereferenced.
destroy() - Method in class org.forgerock.openig.servlet.GatewayServlet
 
DISABLE_CONNECTION_REUSE - Static variable in class org.forgerock.openig.http.HttpClient
Reuse of Http connection is disabled by default.
DISABLE_RETRIES - Static variable in class org.forgerock.openig.http.HttpClient
Http connection retries are disabled by default.
disableConnectionReuse() - Method in class org.forgerock.openig.http.HttpClient
Disables connection caching.
disableRetries(Logger) - Method in class org.forgerock.openig.http.HttpClient
Disables automatic retrying of failed requests.
DispatchHandler - Class in org.forgerock.openig.handler
Dispatches to one of a list of handlers.
DispatchHandler() - Constructor for class org.forgerock.openig.handler.DispatchHandler
 
DispatchHandler.Heaplet - Class in org.forgerock.openig.handler
Creates and initializes a dispatch handler in a heap environment.
DispatchHandler.Heaplet() - Constructor for class org.forgerock.openig.handler.DispatchHandler.Heaplet
 
dn(String, Object...) - Method in class org.forgerock.openig.ldap.LdapClient
Formats an LDAP distinguished name using the provided template and attribute values.
Duration - Class in org.forgerock.openig.util
Represents a duration in english.
Duration(Long, TimeUnit) - Constructor for class org.forgerock.openig.util.Duration
Builds a new Duration.
duration(String) - Static method in class org.forgerock.openig.util.Duration
Builds a new Duration that will represents the given duration expressed in english.

E

E_ACCESS_DENIED - Static variable in class org.forgerock.openig.filter.oauth2.client.OAuth2Error
The resource owner or authorization server denied the request.
E_INSUFFICIENT_SCOPE - Static variable in class org.forgerock.openig.filter.oauth2.client.OAuth2Error
The request requires higher privileges than provided by the access token.
E_INVALID_CLIENT - Static variable in class org.forgerock.openig.filter.oauth2.client.OAuth2Error
Client authentication failed (e.g., unknown client, no client authentication included, or unsupported authentication method).
E_INVALID_GRANT - Static variable in class org.forgerock.openig.filter.oauth2.client.OAuth2Error
The provided authorization grant (e.g., authorization code, resource owner credentials) or refresh token is invalid, expired, revoked, does not match the redirection URI used in the authorization request, or was issued to another client.
E_INVALID_REQUEST - Static variable in class org.forgerock.openig.filter.oauth2.client.OAuth2Error
The request is missing a required parameter, includes an unsupported parameter value (other than grant type), repeats a parameter, includes multiple credentials, utilizes more than one mechanism for authenticating the client, or is otherwise malformed.
E_INVALID_SCOPE - Static variable in class org.forgerock.openig.filter.oauth2.client.OAuth2Error
The requested scope is invalid, unknown, malformed, or exceeds the scope granted by the resource owner.
E_INVALID_TOKEN - Static variable in class org.forgerock.openig.filter.oauth2.client.OAuth2Error
The access token provided is expired, revoked, malformed, or invalid for other reasons.
E_SERVER_ERROR - Static variable in class org.forgerock.openig.filter.oauth2.client.OAuth2Error
The authorization server encountered an unexpected condition that prevented it from fulfilling the request.
E_TEMPORARILY_UNAVAILABLE - Static variable in class org.forgerock.openig.filter.oauth2.client.OAuth2Error
The authorization server is currently unable to handle the request due to a temporary overloading or maintenance of the server.
E_UNAUTHORIZED_CLIENT - Static variable in class org.forgerock.openig.filter.oauth2.client.OAuth2Error
The authenticated client is not authorized to use this authorization grant type.
E_UNSUPPORTED_GRANT_TYPE - Static variable in class org.forgerock.openig.filter.oauth2.client.OAuth2Error
The authorization grant type is not supported by the authorization server.
E_UNSUPPORTED_RESPONSE_TYPE - Static variable in class org.forgerock.openig.filter.oauth2.client.OAuth2Error
The authorization server does not support obtaining an authorization code using this method.
encodeBase64(String) - Static method in class org.forgerock.openig.el.Functions
Encode the given String input into Base 64.
EnforcerFilter - Class in org.forgerock.openig.filter.oauth2
A EnforcerFilter makes sure that the handled Exchange verifies a condition.
EnforcerFilter(Expression, Filter) - Constructor for class org.forgerock.openig.filter.oauth2.EnforcerFilter
Creates a new EnforcerFilter delegating to the given Filter if the enforcement expression yields true.
Entity - Class in org.forgerock.openig.http
Message content.
EntityExtractFilter - Class in org.forgerock.openig.filter
Extracts regular expression patterns from a message entity.
EntityExtractFilter(MessageType, Expression) - Constructor for class org.forgerock.openig.filter.EntityExtractFilter
Builds an EntityExtractFilter that will act either on MessageType.REQUEST or MessageType.RESPONSE flow, extracting patterns into the given target Expression.
EntityExtractFilter(MessageType, Expression, Charset) - Constructor for class org.forgerock.openig.filter.EntityExtractFilter
Builds an EntityExtractFilter that will act either on MessageType.REQUEST or MessageType.RESPONSE flow, extracting patterns into the given target Expression.
EntityExtractFilter.Heaplet - Class in org.forgerock.openig.filter
Creates and initializes an entity extract handler in a heap environment.
EntityExtractFilter.Heaplet() - Constructor for class org.forgerock.openig.filter.EntityExtractFilter.Heaplet
 
entrySet() - Method in class org.forgerock.openig.http.RequestCookies
 
entrySet() - Method in class org.forgerock.openig.servlet.ServletSession
 
entrySet() - Method in class org.forgerock.openig.util.ExtensibleFieldMap
 
EnumUtil - Class in org.forgerock.openig.util
Utility class for accessing Java enum types.
Environment - Interface in org.forgerock.openig.config
Encapsulate logic to access configuration files and other directories of the OpenIG base directory.
ENVIRONMENT_HEAP_KEY - Static variable in interface org.forgerock.openig.config.Environment
Key to retrieve an Environment instance from the Heap.
EnvironmentDelegate - Class in org.forgerock.openig.config.env
Environment delegate, particularly useful to share a default implementation.
EnvironmentDelegate() - Constructor for class org.forgerock.openig.config.env.EnvironmentDelegate
 
equals(Object) - Method in class org.forgerock.openig.filter.oauth2.client.OAuth2BearerWWWAuthenticateHeader
 
equals(Object) - Method in class org.forgerock.openig.filter.oauth2.client.OAuth2Error
 
equals(Object) - Method in class org.forgerock.openig.header.ConnectionHeader
 
equals(Object) - Method in class org.forgerock.openig.header.ContentEncodingHeader
 
equals(Object) - Method in class org.forgerock.openig.header.ContentLengthHeader
 
equals(Object) - Method in class org.forgerock.openig.header.ContentTypeHeader
 
equals(Object) - Method in class org.forgerock.openig.header.CookieHeader
 
equals(Object) - Method in class org.forgerock.openig.header.LocationHeader
 
equals(Object) - Method in class org.forgerock.openig.http.Cookie
 
equals(Object) - Method in class org.forgerock.openig.text.Separator
Indicates whether some other object is equal to this one.
equals(Object) - Method in class org.forgerock.openig.util.MutableUri
 
equals(Object) - Method in class org.forgerock.openig.util.SetDecorator
Compares the specified object with the set for equality.
error(String) - Method in class org.forgerock.openig.log.Logger
Logs the specified message at the ERROR log level.
error(T) - Method in class org.forgerock.openig.log.Logger
Logs the specified exception at the ERROR log level.
eval(Object) - Method in class org.forgerock.openig.el.Expression
Evaluates the expression within the specified scope and returns the resulting object, or null if it does not resolve a value.
eval(Object, Class<T>) - Method in class org.forgerock.openig.el.Expression
Evaluates the expression within the specified scope and returns the resulting object if it matches the specified type, or null if it does not resolve or match.
evaluate(JsonValue) - Static method in class org.forgerock.openig.util.JsonValueUtil
Evaluates the given JSON value string as an Expression.
ExceptionFilter - Class in org.forgerock.openig.filter
Catches any exceptions thrown during handing of a request.
ExceptionFilter(Handler) - Constructor for class org.forgerock.openig.filter.ExceptionFilter
Build a new exception filter that will divert the flow to the given handler in case of exception.
ExceptionFilter.Heaplet - Class in org.forgerock.openig.filter
Creates and initializes an exception filter in a heap environment.
ExceptionFilter.Heaplet() - Constructor for class org.forgerock.openig.filter.ExceptionFilter.Heaplet
 
Exchange - Class in org.forgerock.openig.http
An HTTP exchange of request and response, and the root object for the exchange object model.
Exchange() - Constructor for class org.forgerock.openig.http.Exchange
 
exchange - Variable in class org.forgerock.openig.http.Exchange
Self-referential value to make this the root object in the exchange object model.
execute(Exchange) - Method in class org.forgerock.openig.http.HttpClient
Submits the exchange request to the remote server.
execute(Request) - Method in class org.forgerock.openig.http.HttpClient
Submits the request to the remote server.
Expression - Class in org.forgerock.openig.el
An Unified Expression Language expression.
Expression(String) - Constructor for class org.forgerock.openig.el.Expression
Constructs an expression for later evaluation.
ExpressionException - Exception in org.forgerock.openig.el
An exception that is thrown during expression operations.
ExpressionException() - Constructor for exception org.forgerock.openig.el.ExpressionException
Constructs a new exception with null as its detail message.
ExpressionException(String) - Constructor for exception org.forgerock.openig.el.ExpressionException
Constructs a new exception with the specified detail message.
ExpressionException(Throwable) - Constructor for exception org.forgerock.openig.el.ExpressionException
Constructs a new exception with the specified cause.
ExpressionException(String, Throwable) - Constructor for exception org.forgerock.openig.el.ExpressionException
Constructs a new exception with the specified detail message and cause.
ExtensibleFieldMap - Class in org.forgerock.openig.util
A FieldMap that can be extended with arbitrary keys.
ExtensibleFieldMap() - Constructor for class org.forgerock.openig.util.ExtensibleFieldMap
Constructs a new extensible field map, using this object's field members as keys.
ExtensibleFieldMap(Object) - Constructor for class org.forgerock.openig.util.ExtensibleFieldMap
Constructs a new extensible field map, using the specified object's field members as keys.
extract(Reader) - Method in class org.forgerock.openig.regex.StreamPatternExtractor
Extracts regular expression patterns from a character streams.

F

F_ERROR - Static variable in class org.forgerock.openig.filter.oauth2.client.OAuth2Error
The name of the field which communicates the error code.
F_ERROR_DESCRIPTION - Static variable in class org.forgerock.openig.filter.oauth2.client.OAuth2Error
The name of the field which communicates the error description.
F_ERROR_URI - Static variable in class org.forgerock.openig.filter.oauth2.client.OAuth2Error
The name of the field which communicates the error uri.
F_REALM - Static variable in class org.forgerock.openig.filter.oauth2.client.OAuth2Error
The name of the field which communicates the realm.
F_SCOPE - Static variable in class org.forgerock.openig.filter.oauth2.client.OAuth2Error
The name of the field which communicates the scope.
FileAttributesFilter - Class in org.forgerock.openig.filter
Retrieves and exposes a record from a delimier-separated file.
FileAttributesFilter(SeparatedValuesFile, String, Expression, Expression) - Constructor for class org.forgerock.openig.filter.FileAttributesFilter
Builds a new FileAttributesFilter extracting values from the given separated values file.
FileAttributesFilter.Heaplet - Class in org.forgerock.openig.filter
Creates and initializes a separated values file attribute provider in a heap environment.
FileAttributesFilter.Heaplet() - Constructor for class org.forgerock.openig.filter.FileAttributesFilter.Heaplet
 
FileBuffer - Class in org.forgerock.openig.io
A buffer that uses a local file for data storage.
FileBuffer(File, int) - Constructor for class org.forgerock.openig.io.FileBuffer
Constructs a new file buffer.
FileLogSink - Class in org.forgerock.openig.log
A sink that writes log entries to a file.
FileLogSink(File) - Constructor for class org.forgerock.openig.log.FileLogSink
Builds a new FileLogSink writing entries in the given log file.
FileLogSink(File, Charset) - Constructor for class org.forgerock.openig.log.FileLogSink
Builds a new FileLogSink writing entries in the given log file using the specified Charset.
FileLogSink.Heaplet - Class in org.forgerock.openig.log
Creates and initializes a console sink in a heap environment.
FileLogSink.Heaplet() - Constructor for class org.forgerock.openig.log.FileLogSink.Heaplet
 
filter(Exchange, Handler) - Method in class org.forgerock.openig.filter.AssignmentFilter
 
filter(Exchange, Handler) - Method in class org.forgerock.openig.filter.CaptureFilter
 
filter(Exchange, Handler) - Method in class org.forgerock.openig.filter.CookieFilter
 
filter(Exchange, Handler) - Method in class org.forgerock.openig.filter.CryptoHeaderFilter
 
filter(Exchange, Handler) - Method in class org.forgerock.openig.filter.EntityExtractFilter
 
filter(Exchange, Handler) - Method in class org.forgerock.openig.filter.ExceptionFilter
 
filter(Exchange, Handler) - Method in class org.forgerock.openig.filter.FileAttributesFilter
 
Filter - Interface in org.forgerock.openig.filter
Filters the request and/or response of an HTTP exchange.
filter(Exchange, Handler) - Method in interface org.forgerock.openig.filter.Filter
Filters the request and/or response of an exchange.
filter(Exchange, Handler) - Method in class org.forgerock.openig.filter.HeaderFilter
 
filter(Exchange, Handler) - Method in class org.forgerock.openig.filter.HttpBasicAuthFilter
 
filter(Exchange, Handler) - Method in class org.forgerock.openig.filter.oauth2.client.OAuth2ClientFilter
 
filter(Exchange, Handler) - Method in class org.forgerock.openig.filter.oauth2.EnforcerFilter
 
filter(Exchange, Handler) - Method in class org.forgerock.openig.filter.oauth2.OAuth2ResourceServerFilter
 
filter(Exchange, Handler) - Method in class org.forgerock.openig.filter.RedirectFilter
 
filter(Exchange, Handler) - Method in class org.forgerock.openig.filter.ScriptableFilter
 
filter(Exchange, Handler) - Method in class org.forgerock.openig.filter.SqlAttributesFilter
 
filter(Exchange, Handler) - Method in class org.forgerock.openig.filter.StaticRequestFilter
 
filter(Exchange, Handler) - Method in class org.forgerock.openig.filter.SwitchFilter
 
filter(String, Object...) - Method in class org.forgerock.openig.ldap.LdapClient
Formats an LDAP filter using the provided template and assertion values.
finalize() - Method in class org.forgerock.openig.io.BranchingStreamWrapper
Closes this branching stream and all of the branches created from it.
finalize() - Method in class org.forgerock.openig.io.FileBuffer
 
finalize() - Method in class org.forgerock.openig.io.MemoryBuffer
 
finalize() - Method in class org.forgerock.openig.ldap.LdapClient
 
Form - Class in org.forgerock.openig.http
Form fields, a case-sensitive multi-string-valued map.
Form() - Constructor for class org.forgerock.openig.http.Form
Constructs a new, empty form object.
format(Date) - Static method in class org.forgerock.openig.util.ISO8601
Returns an ISO8601 compliant string representing a date from a Java Date object.
format(long) - Static method in class org.forgerock.openig.util.ISO8601
Returns an ISO8601 compliant string representing a date from a long.
fromFile(Environment, String, String) - Static method in class org.forgerock.openig.script.Script
Loads a script having the provided content type and file name.
fromMessage(Message<?>) - Method in class org.forgerock.openig.filter.oauth2.client.OAuth2BearerWWWAuthenticateHeader
 
fromMessage(Message<?>) - Method in class org.forgerock.openig.header.ConnectionHeader
 
fromMessage(Message<?>) - Method in class org.forgerock.openig.header.ContentEncodingHeader
 
fromMessage(Message<?>) - Method in class org.forgerock.openig.header.ContentLengthHeader
 
fromMessage(Message<?>) - Method in class org.forgerock.openig.header.ContentTypeHeader
 
fromMessage(Message<?>) - Method in class org.forgerock.openig.header.CookieHeader
 
fromMessage(Message<?>) - Method in interface org.forgerock.openig.header.Header
Populates the content of the header from the specified message.
fromMessage(Message<?>) - Method in class org.forgerock.openig.header.LocationHeader
 
fromRequestEntity(Request) - Method in class org.forgerock.openig.http.Form
Parses the URL-encoded form entity of a request and stores them in this object.
fromRequestQuery(Request) - Method in class org.forgerock.openig.http.Form
Parses the query parameters of a request and stores them in this object.
fromSource(Environment, String, String...) - Static method in class org.forgerock.openig.script.Script
Loads a script having the provided content type and content.
fromSource(Environment, String, String) - Static method in class org.forgerock.openig.script.Script
Loads a script having the provided content type and content.
fromString(String) - Method in class org.forgerock.openig.filter.oauth2.client.OAuth2BearerWWWAuthenticateHeader
 
fromString(String) - Method in class org.forgerock.openig.header.ConnectionHeader
 
fromString(String) - Method in class org.forgerock.openig.header.ContentEncodingHeader
 
fromString(String) - Method in class org.forgerock.openig.header.ContentLengthHeader
 
fromString(String) - Method in class org.forgerock.openig.header.ContentTypeHeader
 
fromString(String) - Method in class org.forgerock.openig.header.CookieHeader
 
fromString(String) - Method in interface org.forgerock.openig.header.Header
Populates the content of the header from the specified string value.
fromString(String) - Method in class org.forgerock.openig.header.LocationHeader
 
fromString(String) - Method in class org.forgerock.openig.http.Form
Parses a URL-encoded string containing form parameters and stores them in this object.
Functions - Class in org.forgerock.openig.el
Maps between EL function names and methods.
Functions() - Constructor for class org.forgerock.openig.el.Functions
 

G

GatewayServlet - Class in org.forgerock.openig.servlet
The main OpenIG HTTP Servlet which is responsible for bootstrapping the configuration and delegating all request processing to the configured handler implementation (for example, a DispatchHandler).
GatewayServlet() - Constructor for class org.forgerock.openig.servlet.GatewayServlet
Default constructor invoked from web container.
GatewayServlet(Environment) - Constructor for class org.forgerock.openig.servlet.GatewayServlet
Creates a new servlet using the provided environment.
GenericFilter - Class in org.forgerock.openig.filter
A generic base class for filters with handy injected heap objects.
GenericFilter() - Constructor for class org.forgerock.openig.filter.GenericFilter
 
GenericHandler - Class in org.forgerock.openig.handler
A generic base class for handlers with handy injected heap objects.
GenericHandler() - Constructor for class org.forgerock.openig.handler.GenericHandler
 
GenericHeaplet - Class in org.forgerock.openig.heap
A generic base class for heaplets with automatically injected fields.
GenericHeaplet() - Constructor for class org.forgerock.openig.heap.GenericHeaplet
 
GenericHeapObject - Class in org.forgerock.openig.heap
A generic base class for heap objects with handy injected heap objects.
GenericHeapObject() - Constructor for class org.forgerock.openig.heap.GenericHeapObject
 
get(String) - Method in interface org.forgerock.openig.heap.Heap
Returns an object from the heap with a specified name, or null if no such object exists.
get(String) - Method in class org.forgerock.openig.heap.HeapImpl
 
get(Object) - Method in class org.forgerock.openig.http.RequestCookies
 
get(Object, Object) - Method in class org.forgerock.openig.resolver.ArrayResolver
 
get(Object, Object) - Method in class org.forgerock.openig.resolver.BeanResolver
 
get(Object, Object) - Method in class org.forgerock.openig.resolver.ListResolver
 
get(Object, Object) - Method in class org.forgerock.openig.resolver.MapResolver
 
get(Object, Object) - Method in class org.forgerock.openig.resolver.PrincipalResolver
 
get(Object, Object) - Method in interface org.forgerock.openig.resolver.Resolver
Attempts to resolve an element of an object.
get(Object, Object) - Static method in class org.forgerock.openig.resolver.Resolvers
Attempts to resolve an element of an object.
get(Object, Object) - Method in class org.forgerock.openig.resolver.Unresolver
 
get(Object) - Method in class org.forgerock.openig.servlet.ServletSession
 
get(Object) - Method in class org.forgerock.openig.util.CaseInsensitiveMap
 
get(Object) - Method in class org.forgerock.openig.util.ExtensibleFieldMap
 
getAccessToken(String) - Method in class org.forgerock.openig.filter.oauth2.BearerTokenExtractor
Pulls the access token off of the request, by looking for the Authorization header containing a Bearer token.
getAddedHeaders() - Method in class org.forgerock.openig.filter.HeaderFilter
Returns the header fields to add to the message.
getAuthority() - Method in class org.forgerock.openig.util.MutableUri
Returns the authority compound element.
getBaseDirectory() - Method in class org.forgerock.openig.config.env.DefaultEnvironment
 
getBaseDirectory() - Method in class org.forgerock.openig.config.env.EnvironmentDelegate
 
getBaseDirectory() - Method in interface org.forgerock.openig.config.Environment
Returns the base directory of the OpenIG file system.
getBoundary() - Method in class org.forgerock.openig.header.ContentTypeHeader
Returns the encapsulation boundary or null if none specified.
getBytes() - Method in class org.forgerock.openig.http.Entity
Returns a byte array containing a copy of the decoded content of this entity.
getCharacter() - Method in class org.forgerock.openig.text.Separator
Returns the character used to separate values.
getCharset() - Method in class org.forgerock.openig.header.ContentTypeHeader
Returns the character set encoding used to encode the message, or null if no character set was specified.
getClass(String) - Static method in class org.forgerock.openig.util.Loader
Returns the Class object associated with the class or interface with the given name, or null if the class could not be returned for any reason.
getClassLoader() - Static method in class org.forgerock.openig.util.Loader
Returns the class loader that should be used consistently throughout the application.
getCodings() - Method in class org.forgerock.openig.header.ContentEncodingHeader
Returns the content-coding(s).
getComment() - Method in class org.forgerock.openig.http.Cookie
Returns the intended use of a cookie.
getCommentURL() - Method in class org.forgerock.openig.http.Cookie
Returns the URL identifying the intended use of a cookie.
getConfigDirectory() - Method in class org.forgerock.openig.config.env.DefaultEnvironment
 
getConfigDirectory() - Method in class org.forgerock.openig.config.env.EnvironmentDelegate
 
getConfigDirectory() - Method in interface org.forgerock.openig.config.Environment
Returns the directory that contains the configuration files.
getCookies() - Method in class org.forgerock.openig.header.CookieHeader
Returns the cookies' request list.
getCookies() - Method in class org.forgerock.openig.http.Request
Returns the incoming request cookies.
getData() - Method in class org.forgerock.openig.log.LogEntry
Returns the data being logged or null if no data.
getDescription() - Method in exception org.forgerock.openig.filter.oauth2.OAuth2TokenException
Returns the error description (may be null).
getDiscard() - Method in class org.forgerock.openig.http.Cookie
Returns true if the user agent should discard the cookie unconditionally when it terminates.
getDomain() - Method in class org.forgerock.openig.http.Cookie
Returns the domain for which the cookie is valid.
getEntity() - Method in class org.forgerock.openig.http.Message
Returns the entity.
getError() - Method in class org.forgerock.openig.filter.oauth2.client.OAuth2Error
Returns the error code specifying the cause of the failure.
getError() - Method in exception org.forgerock.openig.filter.oauth2.OAuth2TokenException
Returns the error code.
getErrorDescription() - Method in class org.forgerock.openig.filter.oauth2.client.OAuth2Error
Returns the human-readable ASCII text providing additional information, used to assist the client developer in understanding the error that occurred.
getErrorUri() - Method in class org.forgerock.openig.filter.oauth2.client.OAuth2Error
Returns a URI identifying a human-readable web page with information about the error, used to provide the client developer with additional information about the error.
getEscape() - Method in class org.forgerock.openig.text.Separator
Returns the character used to escape character literals, or -1 if none.
getExpires() - Method in class org.forgerock.openig.http.Cookie
Returns the lifetime of the cookie, expressed as the date and time of expiration.
getExpiresAt() - Method in interface org.forgerock.openig.filter.oauth2.AccessToken
Returns the time (expressed as a timestamp in milliseconds since epoch) when this token will be expired.
getExpiresAt() - Method in class org.forgerock.openig.filter.oauth2.resolver.OpenAmAccessToken
 
getExtractor() - Method in class org.forgerock.openig.filter.EntityExtractFilter
Returns the regular expression patterns extractor.
getFields() - Method in class org.forgerock.openig.text.SeparatedValuesFile
Returns the explicit field keys in the order they appear in a record, overriding any existing field header, or empty to use field header.
getFilters() - Method in class org.forgerock.openig.filter.Chain
Returns the list of filters, in the order they are to be dispatched by the chain.
getFirst(K) - Method in class org.forgerock.openig.util.MultiValueMap
Returns the first value in the list of values for the matching key, or null if no such value exists.
getForm() - Method in class org.forgerock.openig.http.Request
Returns a copy of the query parameters and application/x-www-form-urlencoded entity decoded as a form.
getFragment() - Method in class org.forgerock.openig.util.MutableUri
Returns the fragment element.
getHeaders() - Method in class org.forgerock.openig.filter.CryptoHeaderFilter
Returns the headers whose values should be processed for encryption or decryption.
getHeaders() - Method in class org.forgerock.openig.http.Message
Returns the headers.
getHeaplet(Class<?>) - Static method in class org.forgerock.openig.heap.Heaplets
Returns the heaplet that creates an instance of the specified class, or null if no such heaplet could be found.
getHost() - Method in class org.forgerock.openig.util.MutableUri
Returns the host element.
getHttpOnly() - Method in class org.forgerock.openig.http.Cookie
Returns true if the user agent should make the cookie inaccessible to client side script.
getInstance() - Static method in class org.forgerock.openig.ldap.LdapClient
Returns an instance of an LdapClient.
getJson() - Method in class org.forgerock.openig.http.Entity
Returns the content of this entity decoded as a JSON object.
getKey() - Method in interface org.forgerock.openig.decoder.Decoder
Returns the coding that the decoder supports, as it would appear in the Content-Encoding header.
getKey() - Method in class org.forgerock.openig.decoder.DeflateDecoder
 
getKey() - Method in class org.forgerock.openig.decoder.GzipDecoder
 
getKey() - Method in class org.forgerock.openig.filter.oauth2.client.OAuth2BearerWWWAuthenticateHeader
 
getKey() - Method in class org.forgerock.openig.header.ConnectionHeader
 
getKey() - Method in class org.forgerock.openig.header.ContentEncodingHeader
 
getKey() - Method in class org.forgerock.openig.header.ContentLengthHeader
 
getKey() - Method in class org.forgerock.openig.header.ContentTypeHeader
 
getKey() - Method in class org.forgerock.openig.header.CookieHeader
 
getKey() - Method in interface org.forgerock.openig.header.Header
Returns the name of the header, as it would canonically appear within an HTTP message.
getKey() - Method in class org.forgerock.openig.header.LocationHeader
 
getKey() - Method in class org.forgerock.openig.heap.GenericHeaplet
 
getKey() - Method in interface org.forgerock.openig.heap.Heaplet
Returns the class of object that the heaplet will create.
getKey() - Method in class org.forgerock.openig.heap.NestedHeaplet
 
getKey() - Method in class org.forgerock.openig.resolver.ArrayResolver
Returns null, as arrays are not resolved through type discovery.
getKey() - Method in class org.forgerock.openig.resolver.BeanResolver
 
getKey() - Method in class org.forgerock.openig.resolver.ListResolver
 
getKey() - Method in class org.forgerock.openig.resolver.MapResolver
 
getKey() - Method in class org.forgerock.openig.resolver.PrincipalResolver
 
getKey() - Method in interface org.forgerock.openig.resolver.Resolver
Returns the type of object that the resolver supports.
getKey() - Method in class org.forgerock.openig.resolver.Unresolver
 
getKey() - Method in interface org.forgerock.openig.util.Indexed
Returns the unique key to index the object by.
getLength() - Method in class org.forgerock.openig.header.ContentLengthHeader
Returns the content length.
getLevel() - Method in class org.forgerock.openig.log.LogEntry
Returns the logging level of the entry.
getLocationURI() - Method in class org.forgerock.openig.header.LocationHeader
Returns the location URI or null if empty.
getManaged() - Method in class org.forgerock.openig.filter.CookieFilter
Returns the set of cookie names that will be managed.
getMaxAge() - Method in class org.forgerock.openig.http.Cookie
Returns the lifetime of the cookie, expressed in seconds.
getMessage() - Method in class org.forgerock.openig.log.LogEntry
Returns Human-readable message text, suitable for display in any entry listings.
getMethod() - Method in class org.forgerock.openig.http.Request
Returns the method to be performed on the resource.
getName() - Method in class org.forgerock.openig.http.Cookie
Returns name of the cookie.
getOAuth2Error() - Method in class org.forgerock.openig.filter.oauth2.client.OAuth2BearerWWWAuthenticateHeader
Returns the OAuth 2.0 error represented by this header.
getOAuth2Error() - Method in exception org.forgerock.openig.filter.oauth2.client.OAuth2ErrorException
Returns the OAuth 2.0 error represented by this exception.
getObject(Heap, JsonValue, Class<T>) - Static method in class org.forgerock.openig.heap.HeapUtil
Retrieves an object from a heap with the specified name and type, or null if the name is null.
getParameters() - Method in class org.forgerock.openig.filter.SqlAttributesFilter
Returns the list of parameters to evaluate and include in the execution of the prepared statement.
getPath() - Method in class org.forgerock.openig.http.Cookie
Returns the subset of URLs on the origin server to which this cookie applies.
getPath() - Method in class org.forgerock.openig.util.MutableUri
Returns the path element.
getPatterns() - Method in class org.forgerock.openig.regex.StreamPatternExtractor
Mapping of names to regular expression patterns to extract from the stream.
getPort() - Method in class org.forgerock.openig.http.Cookie
Returns the restricted list of port(s) to which a cookie may be returned.
getPort() - Method in class org.forgerock.openig.util.MutableUri
Returns the port element.
getQuery() - Method in class org.forgerock.openig.util.MutableUri
Returns the path element.
getQuote() - Method in class org.forgerock.openig.text.Separator
Returns the character used to quote string literals, or -1 if none.
getRawAuthority() - Method in class org.forgerock.openig.util.MutableUri
Returns the raw (encoded) authority compound element.
getRawFragment() - Method in class org.forgerock.openig.util.MutableUri
Returns the raw (encoded) fragment element.
getRawInfo() - Method in interface org.forgerock.openig.filter.oauth2.AccessToken
Returns the raw JSON as returned by the tokeninfo endpoint.
getRawInfo() - Method in class org.forgerock.openig.filter.oauth2.resolver.OpenAmAccessToken
 
getRawInputStream() - Method in class org.forgerock.openig.http.Entity
Returns an input stream representing the raw content of this entity.
getRawPath() - Method in class org.forgerock.openig.util.MutableUri
Returns the raw (encoded) path element.
getRawQuery() - Method in class org.forgerock.openig.util.MutableUri
Returns the raw (encoded) query element.
getRawUserInfo() - Method in class org.forgerock.openig.util.MutableUri
Returns the raw (encoded) user info element.
getRealm() - Method in class org.forgerock.openig.filter.oauth2.client.OAuth2Error
Returns the scope of protection required to access the protected resource.
getReason(int) - Static method in class org.forgerock.openig.http.HttpUtil
Returns the example reason phrase for the corresponding status code, per RFC 2616 ยง6.1.1.
getReason() - Method in class org.forgerock.openig.http.Response
Returns the response status reason.
getRecord(String, String) - Method in class org.forgerock.openig.text.SeparatedValuesFile
Returns a record from the file where the specified key is equal to the specified value.
getRelayed() - Method in class org.forgerock.openig.filter.CookieFilter
Returns the set of cookie names that will be relayed (Cookie transmitted from the client to the next handler in the context of a request, and Set-Cookie2 transmitted from the next handler to the client in the context of a response).
getRemovedHeaders() - Method in class org.forgerock.openig.filter.HeaderFilter
Returns the names of header fields to remove from the message.
getRequiredObject(Heap, JsonValue, Class<T>) - Static method in class org.forgerock.openig.heap.HeapUtil
Retrieves an object from a heap with the specified name and type.
getResource(String) - Static method in class org.forgerock.openig.util.Loader
Finds the resource with the given name.
getScheme() - Method in class org.forgerock.openig.util.MutableUri
Returns the scheme name.
getScope() - Method in class org.forgerock.openig.filter.oauth2.client.OAuth2Error
Returns the required scope of the access token for accessing the requested resource.
getScope() - Method in class org.forgerock.openig.ldap.LdapClient
Returns the SearchScope available.
getScopes() - Method in interface org.forgerock.openig.filter.oauth2.AccessToken
Returns the scopes associated to this token.
getScopes() - Method in class org.forgerock.openig.filter.oauth2.resolver.OpenAmAccessToken
 
getScriptDirectory(String) - Method in class org.forgerock.openig.config.env.DefaultEnvironment
 
getScriptDirectory(String) - Method in class org.forgerock.openig.config.env.EnvironmentDelegate
 
getScriptDirectory(String) - Method in interface org.forgerock.openig.config.Environment
Returns the directory that contains the files of the given type.
getSecure() - Method in class org.forgerock.openig.http.Cookie
Returns true if the user agent should use only secure means to send back this cookie.
getSeparator() - Method in enum org.forgerock.openig.text.Separators
Returns the Separator specification that the enum constant represents.
getSource() - Method in class org.forgerock.openig.log.LogEntry
Returns the subject and/or event being logged, in hierarchical dot-delimited notation.
getStatus() - Method in class org.forgerock.openig.http.Response
Returns the response status code.
getString() - Method in class org.forgerock.openig.http.Entity
Returns the content of this entity decoded as a string.
getSuppressed() - Method in class org.forgerock.openig.filter.CookieFilter
Returns the set of cookie names that will be suppressed from the request and from the response.
getTempDirectory() - Method in class org.forgerock.openig.config.env.DefaultEnvironment
 
getTempDirectory() - Method in class org.forgerock.openig.config.env.EnvironmentDelegate
 
getTempDirectory() - Method in interface org.forgerock.openig.config.Environment
Returns the temporary directory of OpenIG (where we have read+write permissions).
getTemplates() - Method in class org.forgerock.openig.regex.StreamPatternExtractor
Mapping of names to optional templates to use for yielding pattern match results.
getTime() - Method in class org.forgerock.openig.log.LogEntry
Returns the time of the event being logged (milliseconds since the 1970 epoch).
getTimer() - Method in class org.forgerock.openig.log.Logger
Returns a new timer to measure elapsed time.
getTimer(String) - Method in class org.forgerock.openig.log.Logger
Returns a new timer to measure elapsed time for a specified event.
getToken() - Method in interface org.forgerock.openig.filter.oauth2.AccessToken
Returns the access token identifier issued from the authorization server.
getToken() - Method in class org.forgerock.openig.filter.oauth2.resolver.OpenAmAccessToken
 
getTokens() - Method in class org.forgerock.openig.header.ConnectionHeader
Returns the list of connection-tokens.
getType() - Method in class org.forgerock.openig.header.ContentTypeHeader
Returns the media type of the underlying data or null if none specified.
getUnit() - Method in class org.forgerock.openig.util.Duration
Returns the TimeUnit this duration is expressed in.
getUnits() - Method in class org.forgerock.openig.log.LogMetric
Returns the unit of measurement the metric is expressed in.
getUri() - Method in class org.forgerock.openig.http.Request
Returns the fully-qualified URI of the resource being accessed.
getUserInfo() - Method in class org.forgerock.openig.util.MutableUri
Returns the user info element.
getValue(K, Callable<V>) - Method in class org.forgerock.openig.filter.oauth2.cache.ThreadSafeCache
Borrow (and create before hand if absent) a cache entry.
getValue() - Method in class org.forgerock.openig.http.Cookie
Returns the value of the cookie.
getValue() - Method in class org.forgerock.openig.log.LogMetric
Returns the numeric value of the metric.
getValue() - Method in class org.forgerock.openig.util.Duration
Returns the number of TimeUnit this duration represents.
getVersion() - Method in class org.forgerock.openig.http.Cookie
Returns the version of the state management mechanism to which this cookie conforms.
getVersion() - Method in class org.forgerock.openig.http.Message
Returns the protocol version.
getWriter() - Method in class org.forgerock.openig.filter.CaptureFilter.FileWriterProvider
 
getWriter() - Method in interface org.forgerock.openig.filter.CaptureFilter.WriterProvider
Returns a valid PrintWriter.
GROOVY_MIME_TYPE - Static variable in class org.forgerock.openig.script.Script
The mime-type for Groovy scripts.
GzipDecoder - Class in org.forgerock.openig.decoder
Decodes an entity encoded with gzip encoding.
GzipDecoder() - Constructor for class org.forgerock.openig.decoder.GzipDecoder
 

H

H_BEARER - Static variable in class org.forgerock.openig.filter.oauth2.client.OAuth2Error
The WWW-Authenticate header prefix, 'Bearer'.
handle(Exchange) - Method in class org.forgerock.openig.filter.Chain
 
handle(Exchange) - Method in class org.forgerock.openig.filter.oauth2.challenge.AuthenticateChallengeHandler
 
handle(Exchange) - Method in class org.forgerock.openig.handler.ClientHandler
 
handle(Exchange) - Method in class org.forgerock.openig.handler.DispatchHandler
 
handle(Exchange) - Method in interface org.forgerock.openig.handler.Handler
Called to request the handler respond to the request.
handle(Exchange) - Method in class org.forgerock.openig.handler.router.RouterHandler
 
handle(Exchange) - Method in class org.forgerock.openig.handler.saml.SamlFederationHandler
 
handle(Exchange) - Method in class org.forgerock.openig.handler.ScriptableHandler
 
handle(Exchange) - Method in class org.forgerock.openig.handler.SequenceHandler
 
handle(Exchange) - Method in class org.forgerock.openig.handler.StaticResponseHandler
 
handle(Exchange) - Method in class org.forgerock.openig.handler.WelcomeHandler
 
Handler - Interface in org.forgerock.openig.handler
Handles an HTTP exchange request by producing an associated response.
HandlerException - Exception in org.forgerock.openig.handler
An exception that is thrown during handler operations.
HandlerException() - Constructor for exception org.forgerock.openig.handler.HandlerException
Constructs a new exception with null as its detail message.
HandlerException(String) - Constructor for exception org.forgerock.openig.handler.HandlerException
Constructs a new exception with the specified detail message.
HandlerException(Throwable) - Constructor for exception org.forgerock.openig.handler.HandlerException
Constructs a new exception with the specified cause.
HandlerException(String, Throwable) - Constructor for exception org.forgerock.openig.handler.HandlerException
Constructs a new exception with the specified detail message and cause.
hashCode() - Method in class org.forgerock.openig.filter.oauth2.client.OAuth2BearerWWWAuthenticateHeader
 
hashCode() - Method in class org.forgerock.openig.filter.oauth2.client.OAuth2Error
 
hashCode() - Method in class org.forgerock.openig.header.ConnectionHeader
 
hashCode() - Method in class org.forgerock.openig.header.ContentEncodingHeader
 
hashCode() - Method in class org.forgerock.openig.header.ContentLengthHeader
 
hashCode() - Method in class org.forgerock.openig.header.ContentTypeHeader
 
hashCode() - Method in class org.forgerock.openig.header.CookieHeader
 
hashCode() - Method in class org.forgerock.openig.header.LocationHeader
 
hashCode() - Method in class org.forgerock.openig.http.Cookie
 
hashCode() - Method in class org.forgerock.openig.text.Separator
 
hashCode() - Method in class org.forgerock.openig.util.MutableUri
 
hashCode() - Method in class org.forgerock.openig.util.SetDecorator
 
hasNext() - Method in class org.forgerock.openig.regex.StreamPatternMatches
Returns true if the character stream has more matches.
hasNext() - Method in class org.forgerock.openig.regex.StringPatternMatches
Returns true if the character sequence has more matches.
Header - Interface in org.forgerock.openig.header
An HTTP message header.
HeaderFilter - Class in org.forgerock.openig.filter
Removes headers from and adds headers to a message.
HeaderFilter(MessageType) - Constructor for class org.forgerock.openig.filter.HeaderFilter
Builds a HeaderFilter processing either the incoming or outgoing message.
HeaderFilter.Heaplet - Class in org.forgerock.openig.filter
Creates and initializes a header filter in a heap environment.
HeaderFilter.Heaplet() - Constructor for class org.forgerock.openig.filter.HeaderFilter.Heaplet
 
Headers - Class in org.forgerock.openig.http
Message headers, a case-insensitive multiple-value map.
Headers() - Constructor for class org.forgerock.openig.http.Headers
Constructs a new instance of message headers.
HeaderUtil - Class in org.forgerock.openig.header
Utility class for processing values in HTTP header fields.
heap - Variable in class org.forgerock.openig.heap.GenericHeaplet
Where objects should be put and where object dependencies should be retrieved.
Heap - Interface in org.forgerock.openig.heap
Manages a collection of associated objects created and initialized by Heaplet objects.
HeapException - Exception in org.forgerock.openig.heap
An exception that is thrown during heap operations.
HeapException() - Constructor for exception org.forgerock.openig.heap.HeapException
Constructs a new exception with null as its detail message.
HeapException(String) - Constructor for exception org.forgerock.openig.heap.HeapException
Constructs a new exception with the specified detail message.
HeapException(Throwable) - Constructor for exception org.forgerock.openig.heap.HeapException
Constructs a new exception with the specified cause.
HeapException(String, Throwable) - Constructor for exception org.forgerock.openig.heap.HeapException
Constructs a new exception with the specified detail message and cause.
HeapImpl - Class in org.forgerock.openig.heap
The concrete implementation of a heap.
HeapImpl() - Constructor for class org.forgerock.openig.heap.HeapImpl
Builds a root heap (will be referenced by children but has no parent itself).
HeapImpl(Heap) - Constructor for class org.forgerock.openig.heap.HeapImpl
Builds a new heap that is a child of the given heap.
Heaplet - Interface in org.forgerock.openig.heap
Creates and initializes an object that is stored in a Heap.
Heaplets - Class in org.forgerock.openig.heap
Loads Heaplet classes based on the class of object they create.
HeapUtil - Class in org.forgerock.openig.heap
Utility methods for managing objects in the heap.
HEIGHT_KB - Static variable in class org.forgerock.openig.io.TemporaryStorage
8 KiB.
HTTP_CLIENT_HEAP_KEY - Static variable in class org.forgerock.openig.http.HttpClient
Key to retrieve an HttpClient instance from the Heap.
HttpBasicAuthFilter - Class in org.forgerock.openig.filter
Performs authentication through the HTTP Basic authentication scheme.
HttpBasicAuthFilter(Expression, Expression, Handler) - Constructor for class org.forgerock.openig.filter.HttpBasicAuthFilter
Builds a HttpBasicAuthFilter with required expressions and error handler.
HttpBasicAuthFilter.Heaplet - Class in org.forgerock.openig.filter
Creates and initializes an HTTP basic authentication filter in a heap environment.
HttpBasicAuthFilter.Heaplet() - Constructor for class org.forgerock.openig.filter.HttpBasicAuthFilter.Heaplet
 
HttpClient - Class in org.forgerock.openig.http
Submits requests to remote servers.
HttpClient(TemporaryStorage) - Constructor for class org.forgerock.openig.http.HttpClient
Creates a new client handler which will cache at most 64 connections, allow all host names for SSL requests and has a both a default connection and so timeout.
HttpClient(TemporaryStorage, int, KeyManagerFactory, TrustManagerFactory, HttpClient.Verifier, Duration, Duration) - Constructor for class org.forgerock.openig.http.HttpClient
Creates a new client handler with the specified maximum number of cached connections.
HttpClient.Heaplet - Class in org.forgerock.openig.http
Creates and initializes a http client object in a heap environment.
HttpClient.Heaplet() - Constructor for class org.forgerock.openig.http.HttpClient.Heaplet
 
HttpUtil - Class in org.forgerock.openig.http
Utility class for processing HTTP messages.

I

Indexed<T> - Interface in org.forgerock.openig.util
Interface of an object that can be indexed with a unique key.
indexOf(String, String) - Static method in class org.forgerock.openig.el.Functions
Returns the index within a string of the first occurrence of a specified substring.
info(String) - Method in class org.forgerock.openig.log.Logger
Logs the specified message at the INFO log level.
info(T) - Method in class org.forgerock.openig.log.Logger
Logs the specified exception at the INFO log level.
init(JsonValue) - Method in class org.forgerock.openig.heap.HeapImpl
Initializes the heap using the given configuration.
init(ServletConfig) - Method in class org.forgerock.openig.servlet.GatewayServlet
 
InsufficientScopeChallengeHandler - Class in org.forgerock.openig.filter.oauth2.challenge
Builds an error Response when the request is missing some required scope.
InsufficientScopeChallengeHandler(String) - Constructor for class org.forgerock.openig.filter.oauth2.challenge.InsufficientScopeChallengeHandler
Builds a new InsufficientScopeChallengeHandler with a default description, no error URI page and no scopes.
InsufficientScopeChallengeHandler(String, Set<String>) - Constructor for class org.forgerock.openig.filter.oauth2.challenge.InsufficientScopeChallengeHandler
Builds a new InsufficientScopeChallengeHandler with a default description and no error URI page.
InsufficientScopeChallengeHandler(String, Set<String>, String) - Constructor for class org.forgerock.openig.filter.oauth2.challenge.InsufficientScopeChallengeHandler
Builds a new InsufficientScopeChallengeHandler with a default description.
InsufficientScopeChallengeHandler(String, String, Set<String>, String) - Constructor for class org.forgerock.openig.filter.oauth2.challenge.InsufficientScopeChallengeHandler
Builds a new InsufficientScopeChallengeHandler.
InvalidRequestChallengeHandler - Class in org.forgerock.openig.filter.oauth2.challenge
Builds an error Response when the request is invalid (missing param, malformed, ...).
InvalidRequestChallengeHandler(String) - Constructor for class org.forgerock.openig.filter.oauth2.challenge.InvalidRequestChallengeHandler
Builds a new InvalidRequestChallengeHandler with a default error description and no error page URI.
InvalidRequestChallengeHandler(String, String) - Constructor for class org.forgerock.openig.filter.oauth2.challenge.InvalidRequestChallengeHandler
Builds a new InvalidRequestChallengeHandler with a default error description.
InvalidRequestChallengeHandler(String, String, String) - Constructor for class org.forgerock.openig.filter.oauth2.challenge.InvalidRequestChallengeHandler
Builds a new InvalidRequestChallengeHandler.
InvalidTokenChallengeHandler - Class in org.forgerock.openig.filter.oauth2.challenge
Builds an error Response when the token extracted from the request is invalid (expired, revoked, ...).
InvalidTokenChallengeHandler(String) - Constructor for class org.forgerock.openig.filter.oauth2.challenge.InvalidTokenChallengeHandler
Builds a new InvalidTokenChallengeHandler with a default description and no error page URI.
InvalidTokenChallengeHandler(String, String) - Constructor for class org.forgerock.openig.filter.oauth2.challenge.InvalidTokenChallengeHandler
Builds a new InvalidTokenChallengeHandler with a default description.
InvalidTokenChallengeHandler(String, String, String) - Constructor for class org.forgerock.openig.filter.oauth2.challenge.InvalidTokenChallengeHandler
Builds a new InvalidTokenChallengeHandler.
is(String) - Method in class org.forgerock.openig.filter.oauth2.client.OAuth2Error
Returns true if this error includes an error code and it matches the provided error code.
isEmpty() - Method in class org.forgerock.openig.http.Entity
Returns true if the entity is empty.
isEmpty() - Method in class org.forgerock.openig.http.RequestCookies
 
isEmpty() - Method in class org.forgerock.openig.servlet.ServletSession
 
isEmpty() - Method in class org.forgerock.openig.util.ExtensibleFieldMap
 
isEmpty() - Method in class org.forgerock.openig.util.SetDecorator
 
isLoggable(String, LogLevel) - Method in class org.forgerock.openig.log.ConsoleLogSink
 
isLoggable(String, LogLevel) - Method in class org.forgerock.openig.log.FileLogSink
 
isLoggable(String, LogLevel) - Method in class org.forgerock.openig.log.Logger
Returns true if the entry may be logged, given the specified event and log level.
isLoggable(LogLevel) - Method in class org.forgerock.openig.log.Logger
Returns true if the entry may be logged, given the source of this logger and the specified log level.
isLoggable(String, LogLevel) - Method in interface org.forgerock.openig.log.LogSink
Returns true if the entry may be logged based on its source and/or level.
isLoggable(String, LogLevel) - Method in class org.forgerock.openig.log.NullLogSink
 
ISO8601 - Class in org.forgerock.openig.util
ISO8601 compliant representation of dates and times.
isUnlimited() - Method in class org.forgerock.openig.util.Duration
Returns true if this Duration represents at unlimited duration.
iterator() - Method in class org.forgerock.openig.util.SetDecorator
 

J

join(String[], String) - Static method in class org.forgerock.openig.el.Functions
Joins an array of strings into a single string value, with a specified separator.
join(Collection<String>, char) - Static method in class org.forgerock.openig.header.HeaderUtil
Joins a collection of header values into a single header value, with a specified specified separator.
join(String, Iterable<?>) - Static method in class org.forgerock.openig.util.StringUtil
Joins a collection of elements into a single string value, with a specified separator.
join(String, Object...) - Static method in class org.forgerock.openig.util.StringUtil
Joins an array of strings into a single string value, with a specified separator.
JS_MIME_TYPE - Static variable in class org.forgerock.openig.script.Script
The mime-type for Javascript scripts.
JsonValueUtil - Class in org.forgerock.openig.util
Provides additional functionality to JsonValue.

K

keyMatch(Object, String) - Static method in class org.forgerock.openig.el.Functions
Returns the first key found in a map that matches the specified regular expression pattern, or null if no such match is found.
keySet() - Method in class org.forgerock.openig.http.RequestCookies
 

L

LdapClient - Class in org.forgerock.openig.ldap
This class acts as a simplified access point into the OpenDJ LDAP SDK.
LdapConnection - Class in org.forgerock.openig.ldap
Provides an adapted view of an OpenDJ LDAP connection exposing only the synchronous methods and protecting against future evolution of the Connection interface (e.g.
length(Object) - Static method in class org.forgerock.openig.el.Functions
Returns the number of items in a collection, or the number of characters in a string.
length() - Method in interface org.forgerock.openig.io.Buffer
Returns the current length of the buffer.
length() - Method in class org.forgerock.openig.io.FileBuffer
 
length() - Method in class org.forgerock.openig.io.MemoryBuffer
 
length() - Method in class org.forgerock.openig.io.TemporaryBuffer
 
ListResolver - Class in org.forgerock.openig.resolver
Resolves List objects.
ListResolver() - Constructor for class org.forgerock.openig.resolver.ListResolver
 
Loader - Class in org.forgerock.openig.util
Provides methods for dynamically loading classes.
loadList(Class<E>) - Static method in class org.forgerock.openig.util.Loader
Loads services of a particualr type into a list.
loadMap(Class<K>, Class<V>) - Static method in class org.forgerock.openig.util.Loader
Loads services of a particular type into a map.
LocationHeader - Class in org.forgerock.openig.header
Processes the Location message header.
LocationHeader() - Constructor for class org.forgerock.openig.header.LocationHeader
Constructs a new empty LocationHeader.
LocationHeader(Message<?>) - Constructor for class org.forgerock.openig.header.LocationHeader
Constructs a new LocationHeader, initialized from the specified message.
LocationHeader(String) - Constructor for class org.forgerock.openig.header.LocationHeader
Constructs a new LocationHeader, initialized from the specified String value.
log(LogEntry) - Method in class org.forgerock.openig.log.ConsoleLogSink
 
log(LogEntry) - Method in class org.forgerock.openig.log.FileLogSink
 
log(LogEntry) - Method in class org.forgerock.openig.log.Logger
Logs an entry.
log(LogEntry) - Method in interface org.forgerock.openig.log.LogSink
Logs an entry.
log(LogEntry) - Method in class org.forgerock.openig.log.NullLogSink
 
LogEntry - Class in org.forgerock.openig.log
The log entry data structure.
logException(LogLevel, T) - Method in class org.forgerock.openig.log.Logger
Logs the specified exception.
logger - Variable in class org.forgerock.openig.heap.GenericHeaplet
Provides methods for logging activities.
logger - Variable in class org.forgerock.openig.heap.GenericHeapObject
Provides methods for various logging activities.
Logger - Class in org.forgerock.openig.log
Wraps a log sink and exposes a set of convenience methods for various logging activities.
Logger(LogSink, String) - Constructor for class org.forgerock.openig.log.Logger
Constructs a new logger.
LogLevel - Enum in org.forgerock.openig.log
Levels used for categorizing log entries.
logMessage(LogLevel, String) - Method in class org.forgerock.openig.log.Logger
Logs the message at the specified log level.
LogMetric - Class in org.forgerock.openig.log
Log entry data that provides a measurement.
LogMetric(Number, String) - Constructor for class org.forgerock.openig.log.LogMetric
Constructs a new metric with the specific value and units.
LogSink - Interface in org.forgerock.openig.log
Receives and handles log entries.
LOGSINK_HEAP_KEY - Static variable in interface org.forgerock.openig.log.LogSink
Key to retrieve a LogSink instance from the Heap.
LogTimer - Class in org.forgerock.openig.log
Records elapsed time in a log in milliseconds.
LogTimer(LogSink) - Constructor for class org.forgerock.openig.log.LogTimer
Constructs a new timer with a logging level of STAT.
LogTimer(LogSink, LogLevel) - Constructor for class org.forgerock.openig.log.LogTimer
Constructs a new timer to log events at a specified logging level.
LogTimer(LogSink, LogLevel, String) - Constructor for class org.forgerock.openig.log.LogTimer
Constructs a new timer to log events of a specific type at a specific logging level.

M

main(String[]) - Static method in class org.forgerock.openig.doc.SampleServer
Start an HTTP server.
MapResolver - Class in org.forgerock.openig.resolver
Resolves Map objects.
MapResolver() - Constructor for class org.forgerock.openig.resolver.MapResolver
 
mark(int) - Method in class org.forgerock.openig.io.ByteArrayBranchingStream
Marks the current position in this input stream.
markSupported() - Method in class org.forgerock.openig.io.ByteArrayBranchingStream
Returns true unconditionally; mark and reset are supported.
matches(String, String) - Static method in class org.forgerock.openig.el.Functions
Returns true if the string contains the specified regular expression pattern.
matchingGroups(String, String) - Static method in class org.forgerock.openig.el.Functions
Returns an array containing the matches of a regular expression pattern against a string, or null if no match is found.
MemoryBuffer - Class in org.forgerock.openig.io
A buffer that uses a byte array for data storage.
MemoryBuffer(int, int) - Constructor for class org.forgerock.openig.io.MemoryBuffer
Constructs a new memory buffer.
Message<T extends Message<T>> - Class in org.forgerock.openig.http
Elements common to requests and responses.
MessageType - Enum in org.forgerock.openig.http
Indicates a type of HTTP message.
modify(ModifyRequest) - Method in class org.forgerock.openig.ldap.LdapConnection
Modifies an entry in the Directory Server using the provided modify request.
modify(String...) - Method in class org.forgerock.openig.ldap.LdapConnection
Modifies an entry in the Directory Server using the provided lines of LDIF.
modifyDN(ModifyDNRequest) - Method in class org.forgerock.openig.ldap.LdapConnection
Renames an entry in the Directory Server using the provided modify DN request.
modifyDN(String, String) - Method in class org.forgerock.openig.ldap.LdapConnection
Renames the named entry in the Directory Server using the provided new RDN.
MultiValueMap<K,V> - Class in org.forgerock.openig.util
Wraps a map for which the values are lists, providing a set of convenience methods for handling list values.
MultiValueMap(Map<K, List<V>>) - Constructor for class org.forgerock.openig.util.MultiValueMap
Creates a new multi-value map, wrapping an existing map with list values.
MutableUri - Class in org.forgerock.openig.util
A MutableUri is a modifiable URI substitute.
MutableUri(URI) - Constructor for class org.forgerock.openig.util.MutableUri
Builds a new MutableUri using the given URI.
MutableUri(MutableUri) - Constructor for class org.forgerock.openig.util.MutableUri
Builds a new MutableUri with deep copy.
MutableUri(String) - Constructor for class org.forgerock.openig.util.MutableUri
Builds a new MutableUri using the given URL encoded String URI.
MutableUri(String, String, String, int, String, String, String) - Constructor for class org.forgerock.openig.util.MutableUri
Builds a new MutableUri using the given fields values (decoded values).

N

NAME - Static variable in class org.forgerock.openig.filter.oauth2.client.OAuth2BearerWWWAuthenticateHeader
The name of the header that this object represents.
NAME - Static variable in class org.forgerock.openig.header.ConnectionHeader
The name of the header that this object represents.
NAME - Static variable in class org.forgerock.openig.header.ContentEncodingHeader
The name of the header that this object represents.
NAME - Static variable in class org.forgerock.openig.header.ContentLengthHeader
The name of the header that this object represents.
NAME - Static variable in class org.forgerock.openig.header.ContentTypeHeader
The name of the header that this object represents.
NAME - Static variable in class org.forgerock.openig.header.CookieHeader
The name of the header that this object represents.
NAME - Static variable in class org.forgerock.openig.header.LocationHeader
The name of the header that this object represents.
name - Variable in class org.forgerock.openig.heap.GenericHeaplet
The name of the object to be created and stored in the heap by this heaplet.
names(Class<T>) - Static method in class org.forgerock.openig.util.EnumUtil
Returns a set of the names of the enum constants of the specified enum type.
NestedHeaplet - Class in org.forgerock.openig.heap
A generic base class for a heaplet nested within the class it creates.
NestedHeaplet() - Constructor for class org.forgerock.openig.heap.NestedHeaplet
 
NEVER_EXPIRES - Static variable in interface org.forgerock.openig.filter.oauth2.AccessToken
Marker for never ending tokens.
newAuthorizationServerError(String, String) - Static method in class org.forgerock.openig.filter.oauth2.client.OAuth2Error
Returns an OAuth 2.0 error suitable for inclusion in authorization call-back responses and access token and refresh token responses.
newAuthorizationServerError(String, String, String) - Static method in class org.forgerock.openig.filter.oauth2.client.OAuth2Error
Returns an OAuth 2.0 error suitable for inclusion in authorization call-back responses and access token and refresh token responses.
newDecodedContentInputStream() - Method in class org.forgerock.openig.http.Entity
Returns a branched input stream representing the decoded content of this entity.
newDecodedContentReader(Charset) - Method in class org.forgerock.openig.http.Entity
Returns a branched reader representing the decoded content of this entity.
newInstance(Script) - Method in class org.forgerock.openig.filter.ScriptableFilter.Heaplet
 
newInstance(Script) - Method in class org.forgerock.openig.handler.ScriptableHandler.Heaplet
 
newInstance() - Method in class org.forgerock.openig.io.TemporaryStorage
Creates and returns a new instance of a temporary buffer.
newInstance(Script) - Method in class org.forgerock.openig.script.AbstractScriptableHeapObject.AbstractScriptableHeaplet
Creates the new heap object instance using the provided script.
newInstance(String) - Static method in class org.forgerock.openig.util.Loader
Creates a new instance of a named class.
newInstance(String, Class<T>) - Static method in class org.forgerock.openig.util.Loader
Creates a new instance of a named class.
newResourceServerError(String, List<String>, String, String, String) - Static method in class org.forgerock.openig.filter.oauth2.client.OAuth2Error
Returns an OAuth 2.0 error suitable for inclusion in resource server WWW-Authenticate response headers.
next() - Method in class org.forgerock.openig.regex.StreamPatternMatches
Returns the next match from the character stream.
next() - Method in class org.forgerock.openig.regex.StringPatternMatches
Returns the next match from the character sequence.
next() - Method in class org.forgerock.openig.text.SeparatedValuesReader
Reads the next record from the character input stream.
NoAuthenticationChallengeHandler - Class in org.forgerock.openig.filter.oauth2.challenge
Builds an error Response when the request does not contains any OAuth 2.0 Bearer token.
NoAuthenticationChallengeHandler(String) - Constructor for class org.forgerock.openig.filter.oauth2.challenge.NoAuthenticationChallengeHandler
Builds a new NoAuthenticationChallengeHandler.
NoRetryHttpRequestRetryHandler - Class in org.forgerock.openig.util
A very simple implementation that always returns false for every exception which effectively turns off any request retries.
NoRetryHttpRequestRetryHandler(Logger) - Constructor for class org.forgerock.openig.util.NoRetryHttpRequestRetryHandler
Constructs a new NoRetryHttpRequestRetryHandler.
NullInputStream - Class in org.forgerock.openig.io
An input stream that holds no data.
NullInputStream() - Constructor for class org.forgerock.openig.io.NullInputStream
 
NullLogSink - Class in org.forgerock.openig.log
A sink that discards all log entries.
NullLogSink() - Constructor for class org.forgerock.openig.log.NullLogSink
 
NullOutputStream - Class in org.forgerock.openig.io
An output stream that discards all data written to it.
NullOutputStream() - Constructor for class org.forgerock.openig.io.NullOutputStream
 

O

OAuth2BearerWWWAuthenticateHeader - Class in org.forgerock.openig.filter.oauth2.client
Processes the OAuth 2.0 Bearer WWW-Authenticate message header.
OAuth2BearerWWWAuthenticateHeader() - Constructor for class org.forgerock.openig.filter.oauth2.client.OAuth2BearerWWWAuthenticateHeader
Constructs a new empty header.
OAuth2BearerWWWAuthenticateHeader(Message<?>) - Constructor for class org.forgerock.openig.filter.oauth2.client.OAuth2BearerWWWAuthenticateHeader
Constructs a new header, initialized from the specified message.
OAuth2BearerWWWAuthenticateHeader(String) - Constructor for class org.forgerock.openig.filter.oauth2.client.OAuth2BearerWWWAuthenticateHeader
Constructs a new header, initialized from the specified string value.
OAuth2ClassAliasResolver - Class in org.forgerock.openig.filter.oauth2
Register all the aliases supported by the openig-oauth2 module.
OAuth2ClassAliasResolver() - Constructor for class org.forgerock.openig.filter.oauth2.OAuth2ClassAliasResolver
 
OAuth2ClientFilter - Class in org.forgerock.openig.filter.oauth2.client
A filter which is responsible for authenticating the end-user using OAuth 2.0 delegated authorization.
OAuth2ClientFilter() - Constructor for class org.forgerock.openig.filter.oauth2.client.OAuth2ClientFilter
 
OAuth2ClientFilter.Heaplet - Class in org.forgerock.openig.filter.oauth2.client
Creates and initializes the filter in a heap environment.
OAuth2ClientFilter.Heaplet() - Constructor for class org.forgerock.openig.filter.oauth2.client.OAuth2ClientFilter.Heaplet
 
OAuth2Error - Class in org.forgerock.openig.filter.oauth2.client
Describes an error which occurred during an OAuth 2.0 authorization request or when performing an authorized request.
OAuth2ErrorException - Exception in org.forgerock.openig.filter.oauth2.client
An exception that is thrown when OAuth 2.0 request fails.
OAuth2ErrorException(OAuth2Error) - Constructor for exception org.forgerock.openig.filter.oauth2.client.OAuth2ErrorException
Creates a new exception with the provided OAuth 2.0 error.
OAuth2ErrorException(OAuth2Error, String) - Constructor for exception org.forgerock.openig.filter.oauth2.client.OAuth2ErrorException
Creates a new exception with the provided OAuth 2.0 error.
OAuth2ErrorException(OAuth2Error, String, Throwable) - Constructor for exception org.forgerock.openig.filter.oauth2.client.OAuth2ErrorException
Creates a new exception with the provided OAuth 2.0 error.
OAuth2ErrorException(OAuth2Error, Throwable) - Constructor for exception org.forgerock.openig.filter.oauth2.client.OAuth2ErrorException
Creates a new exception with the provided OAuth 2.0 error.
OAuth2ErrorException(String, String) - Constructor for exception org.forgerock.openig.filter.oauth2.client.OAuth2ErrorException
Creates a new exception with the provided OAuth 2.0 error code and optional description.
OAuth2ErrorException(String, String, Throwable) - Constructor for exception org.forgerock.openig.filter.oauth2.client.OAuth2ErrorException
Creates a new exception with the provided OAuth 2.0 error code, optional description, and cause.
OAuth2Provider - Class in org.forgerock.openig.filter.oauth2.client
An OAuth 2.0 authorization server or OpenID Connect Provider.
OAuth2Provider(String) - Constructor for class org.forgerock.openig.filter.oauth2.client.OAuth2Provider
Creates a new provider having the specified name.
OAuth2ResourceServerFilter - Class in org.forgerock.openig.filter.oauth2
Validates an Exchange that contains an OAuth 2.0 access token.
OAuth2ResourceServerFilter(AccessTokenResolver, BearerTokenExtractor, TimeService) - Constructor for class org.forgerock.openig.filter.oauth2.OAuth2ResourceServerFilter
Creates a new OAuth2Filter.
OAuth2ResourceServerFilter(AccessTokenResolver, BearerTokenExtractor, TimeService, Set<String>, String) - Constructor for class org.forgerock.openig.filter.oauth2.OAuth2ResourceServerFilter
Creates a new OAuth2Filter.
OAuth2ResourceServerFilter.Heaplet - Class in org.forgerock.openig.filter.oauth2
Creates and initializes an OAuth2 filter in a heap environment.
OAuth2ResourceServerFilter.Heaplet() - Constructor for class org.forgerock.openig.filter.oauth2.OAuth2ResourceServerFilter.Heaplet
 
OAuth2TokenException - Exception in org.forgerock.openig.filter.oauth2
Represents an exception whilst retrieving an OAuth2 access token.
OAuth2TokenException(String) - Constructor for exception org.forgerock.openig.filter.oauth2.OAuth2TokenException
Builds an OAuth2TokenException with a given error message.
OAuth2TokenException(String, String) - Constructor for exception org.forgerock.openig.filter.oauth2.OAuth2TokenException
Builds an OAuth2TokenException with a given error message and description.
OAuth2TokenException(String, String, Exception) - Constructor for exception org.forgerock.openig.filter.oauth2.OAuth2TokenException
Builds an OAuth2TokenException with a given error message, description and cause.
object - Variable in class org.forgerock.openig.heap.GenericHeaplet
The object created by the heaplet's GenericHeaplet.create() method.
ofExpression() - Static method in class org.forgerock.openig.util.JsonValueUtil
Returns a function for transforming JsonValues to expressions.
onChanges(FileChangeSet) - Method in class org.forgerock.openig.handler.router.RouterHandler
 
ONE_MB - Static variable in class org.forgerock.openig.io.TemporaryStorage
1 MiB.
OpenAmAccessToken - Class in org.forgerock.openig.filter.oauth2.resolver
Models an AccessToken as returned by the OpenAM tokeninfo endpoint.
OpenAmAccessToken(JsonValue, String, Set<String>, long) - Constructor for class org.forgerock.openig.filter.oauth2.resolver.OpenAmAccessToken
Builds a AccessToken with the result of a call to the tokeninfo endpoint.
OpenAmAccessToken.Builder - Class in org.forgerock.openig.filter.oauth2.resolver
Build helper for OpenAmAccessToken.
OpenAmAccessToken.Builder(TimeService) - Constructor for class org.forgerock.openig.filter.oauth2.resolver.OpenAmAccessToken.Builder
Creates a new Builder with the given TimeService.
OpenAmAccessTokenResolver - Class in org.forgerock.openig.filter.oauth2.resolver
An OpenAmAccessTokenResolver knows how to resolve a given token identifier against an OpenAm instance.
OpenAmAccessTokenResolver(Handler, TimeService, String) - Constructor for class org.forgerock.openig.filter.oauth2.resolver.OpenAmAccessTokenResolver
Creates a new OpenAmAccessTokenResolver configured to access the given /oauth2/tokeninfo OpenAm endpoint.
OpenAmAccessTokenResolver(Handler, OpenAmAccessToken.Builder, String) - Constructor for class org.forgerock.openig.filter.oauth2.resolver.OpenAmAccessTokenResolver
Creates a new OpenAmAccessTokenResolver configured to access the given /oauth2/tokeninfo OpenAm endpoint.
org.forgerock.openig.alias - package org.forgerock.openig.alias
Service Provider interface for registering type aliases.
org.forgerock.openig.config - package org.forgerock.openig.config
Performs dynamic configuration bootstrap, discovery and input/output functions.
org.forgerock.openig.config.env - package org.forgerock.openig.config.env
Different Environment implementations.
org.forgerock.openig.decoder - package org.forgerock.openig.decoder
Decodes HTTP entities that are compressed or encoded.
org.forgerock.openig.doc - package org.forgerock.openig.doc
Simple server for use when getting started, intended for those following along with the product documentation.
org.forgerock.openig.el - package org.forgerock.openig.el
Integrates with the Java Enterprise Edition Unified Expression Language API.
org.forgerock.openig.filter - package org.forgerock.openig.filter
Filters the requests and/or responses of HTTP exchanges.
org.forgerock.openig.filter.oauth2 - package 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.cache - package org.forgerock.openig.filter.oauth2.cache
This package contains classes used to implement an AccessToken cache.
org.forgerock.openig.filter.oauth2.challenge - package org.forgerock.openig.filter.oauth2.challenge
This package contains handlers implementations that return challenging responses in case of OAuth2 processing errors.
org.forgerock.openig.filter.oauth2.client - package org.forgerock.openig.filter.oauth2.client
OAuth 2.0 Client filter implementation.
org.forgerock.openig.filter.oauth2.resolver - package org.forgerock.openig.filter.oauth2.resolver
This package defines OpenAM specific logic needed to retrieve an .AccessToken.
org.forgerock.openig.handler - package org.forgerock.openig.handler
Handles HTTP exchange requests by generating responses.
org.forgerock.openig.handler.router - package 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 - package org.forgerock.openig.handler.saml
OpenIG SAML support.
org.forgerock.openig.header - package org.forgerock.openig.header
Processes HTTP message header fields.
org.forgerock.openig.heap - package org.forgerock.openig.heap
Manages collections or "heaps" of associated objects, initialized from declarative configuration artifacts.
org.forgerock.openig.http - package org.forgerock.openig.http
Models and manages elements of the Hypertext Transfer Protocol.
org.forgerock.openig.io - package org.forgerock.openig.io
Provides stream buffering, branching, and storage functions.
org.forgerock.openig.ldap - package org.forgerock.openig.ldap
Facilitates access to the OpenDJ LDAP SDK from within scripts.
org.forgerock.openig.log - package org.forgerock.openig.log
Facility for logging and real-time performance monitoring.
org.forgerock.openig.regex - package org.forgerock.openig.regex
Matches, extracts and transforms text with regular expression patterns.
org.forgerock.openig.resolver - package org.forgerock.openig.resolver
Performs object resolution for dynamic expression and script integration.
org.forgerock.openig.script - package org.forgerock.openig.script
Scripting support.
org.forgerock.openig.servlet - package org.forgerock.openig.servlet
Integrates with the Java Enterprise Edition Servlet API.
org.forgerock.openig.text - package org.forgerock.openig.text
Processes structured text in streams and files.
org.forgerock.openig.util - package org.forgerock.openig.util
Miscellaneous utility classes.
OverflowException - Exception in org.forgerock.openig.io
An exception that is thrown if a buffer would overflow as a result of a write operation.
OverflowException() - Constructor for exception org.forgerock.openig.io.OverflowException
Constructs a new exception with null as its detail message.
OverflowException(String) - Constructor for exception org.forgerock.openig.io.OverflowException
Constructs a new exception with the specified detail message.
OverflowException(Throwable) - Constructor for exception org.forgerock.openig.io.OverflowException
Constructs a new exception with the specified cause.
OverflowException(String, Throwable) - Constructor for exception org.forgerock.openig.io.OverflowException
Constructs a new exception with the specified detail message and cause.

P

parent() - Method in class org.forgerock.openig.io.BranchingInputStream
Returns the parent branching input stream from which this branch was created, or null if this is the trunk.
parent() - Method in class org.forgerock.openig.io.BranchingStreamWrapper
 
parent() - Method in class org.forgerock.openig.io.ByteArrayBranchingStream
 
parseParameter(String) - Static method in class org.forgerock.openig.header.HeaderUtil
Splits a single HTTP header parameter name and value from an input string value.
parseParameters(Collection<String>) - Static method in class org.forgerock.openig.header.HeaderUtil
Parses a set of HTTP header parameters from a collection of values.
PatternTemplate - Class in org.forgerock.openig.regex
Expresses a transformation to be applied to a regular expression pattern match.
PatternTemplate(String) - Constructor for class org.forgerock.openig.regex.PatternTemplate
Constructs a new template with the specified value.
PlatformEnvironment - Class in org.forgerock.openig.config.env
Delegates to a unix or windows type environment depending on the OS.
PlatformEnvironment() - Constructor for class org.forgerock.openig.config.env.PlatformEnvironment
Builds a new platform specific Environment depending on the os.name system property.
pop() - Method in class org.forgerock.openig.http.Entity
Restores the underlying input stream to the state it had immediately before the last call to Entity.push().
principal - Variable in class org.forgerock.openig.http.Exchange
The principal associated with the request, or null if unknown.
PrincipalResolver - Class in org.forgerock.openig.resolver
Resolves Principal objects.
PrincipalResolver() - Constructor for class org.forgerock.openig.resolver.PrincipalResolver
 
push() - Method in class org.forgerock.openig.http.Entity
Saves the current position of the underlying input stream and creates a new buffered input stream.
put(String, Object) - Method in class org.forgerock.openig.heap.HeapImpl
Puts an object into the heap.
put(Object, Object, Object) - Method in class org.forgerock.openig.resolver.ArrayResolver
 
put(Object, Object, Object) - Method in class org.forgerock.openig.resolver.BeanResolver
 
put(Object, Object, Object) - Method in class org.forgerock.openig.resolver.ListResolver
 
put(Object, Object, Object) - Method in class org.forgerock.openig.resolver.MapResolver
 
put(Object, Object, Object) - Method in class org.forgerock.openig.resolver.PrincipalResolver
 
put(Object, Object, Object) - Method in interface org.forgerock.openig.resolver.Resolver
Attempts to set the value of an element of an object.
put(Object, Object, Object) - Static method in class org.forgerock.openig.resolver.Resolvers
Attempts to set the value of an element of an object.
put(Object, Object, Object) - Method in class org.forgerock.openig.resolver.Unresolver
 
put(String, Object) - Method in class org.forgerock.openig.servlet.ServletSession
 
put(String, V) - Method in class org.forgerock.openig.util.CaseInsensitiveMap
 
put(String, Object) - Method in class org.forgerock.openig.util.ExtensibleFieldMap
 
putAll(Map<? extends String, ? extends V>) - Method in class org.forgerock.openig.util.CaseInsensitiveMap
 
putSingle(K, V) - Method in class org.forgerock.openig.util.MultiValueMap
Maps a single value to the specified key, replacing any value(s) that are already mapped to that key.

Q

quote(String) - Static method in class org.forgerock.openig.header.HeaderUtil
Encloses a string in quotation marks.

R

read(String) - Static method in class org.forgerock.openig.el.Functions
Returns the content of the given file as a plain String.
read() - Method in class org.forgerock.openig.io.BranchingStreamWrapper
Reads the next byte of data from the input stream.
read(byte[]) - Method in class org.forgerock.openig.io.BranchingStreamWrapper
Reads some number of bytes from the input stream and stores them into the buffer array b.
read(byte[], int, int) - Method in class org.forgerock.openig.io.BranchingStreamWrapper
Reads up to len bytes of data from the input stream into an array of bytes.
read(int, byte[], int, int) - Method in interface org.forgerock.openig.io.Buffer
Reads up to len bytes of data from the buffer into an array of bytes.
read() - Method in class org.forgerock.openig.io.ByteArrayBranchingStream
Reads the next byte of data from the input stream.
read(byte[]) - Method in class org.forgerock.openig.io.ByteArrayBranchingStream
Reads some number of bytes from the input stream and stores them into the buffer array b.
read(byte[], int, int) - Method in class org.forgerock.openig.io.ByteArrayBranchingStream
Reads up to len bytes of data from the input stream into an array of bytes.
read(int, byte[], int, int) - Method in class org.forgerock.openig.io.FileBuffer
 
read(int, byte[], int, int) - Method in class org.forgerock.openig.io.MemoryBuffer
 
read() - Method in class org.forgerock.openig.io.NullInputStream
Unconditionally returns -1 to indicate the end of stream has been reached.
read(byte[]) - Method in class org.forgerock.openig.io.NullInputStream
Unconditionally returns -1 to indicate the end of stream has been reached.
read(byte[], int, int) - Method in class org.forgerock.openig.io.NullInputStream
Unconditionally returns -1 to indicate the end of stream has been reached.
read(int, byte[], int, int) - Method in class org.forgerock.openig.io.TemporaryBuffer
 
readEntry(DN, String...) - Method in class org.forgerock.openig.ldap.LdapConnection
Reads the named entry from the Directory Server.
readEntry(String, String...) - Method in class org.forgerock.openig.ldap.LdapConnection
Reads the named entry from the Directory Server.
readProperties(String) - Static method in class org.forgerock.openig.el.Functions
Returns the content of the given file as a Properties.
rebase(MutableUri) - Method in class org.forgerock.openig.util.MutableUri
Changes the base scheme, host and port of this MutableUri to that specified in a base URI, or leaves them unchanged if the base URI is null.
rebase(URI) - Method in class org.forgerock.openig.util.MutableUri
Changes the base scheme, host and port of this MutableUri to that specified in a base URI, or leaves them unchanged if the base URI is null.
rebase(URI, URI) - Static method in class org.forgerock.openig.util.URIUtil
Changes the base scheme, host and port of a request to that specified in a base URI, or leaves them unchanged if the base URI is null.
REDIRECT_STATUS_302 - Static variable in class org.forgerock.openig.filter.RedirectFilter
The status code of a HTTP 302 Redirect.
RedirectFilter - Class in org.forgerock.openig.filter
Specialised header filter that deals with rewriting Location headers on responses that generate a redirect that would take the user directly to the application being proxied rather than via OpenIG.
RedirectFilter() - Constructor for class org.forgerock.openig.filter.RedirectFilter
 
RedirectFilter.Heaplet - Class in org.forgerock.openig.filter
Creates and initialises a RedirectFilter in a heap environment.
RedirectFilter.Heaplet() - Constructor for class org.forgerock.openig.filter.RedirectFilter.Heaplet
 
relativize(MutableUri) - Method in class org.forgerock.openig.util.MutableUri
Relativizes the given URI against this URI.
remove(Object) - Method in class org.forgerock.openig.servlet.ServletSession
 
remove(Object) - Method in class org.forgerock.openig.util.CaseInsensitiveMap
 
remove(Object) - Method in class org.forgerock.openig.util.CaseInsensitiveSet
 
remove(Object) - Method in class org.forgerock.openig.util.ExtensibleFieldMap
 
remove(Object) - Method in class org.forgerock.openig.util.SetDecorator
Removes the specified element from the set if it is present (optional operation).
removeAll(Collection<?>) - Method in class org.forgerock.openig.util.CaseInsensitiveSet
 
removeAll(Collection<?>) - Method in class org.forgerock.openig.util.SetDecorator
Removes from the set all of its elements that are contained in the specified collection (optional operation).
request - Variable in class org.forgerock.openig.http.Exchange
The request portion of the HTTP exchange.
Request - Class in org.forgerock.openig.http
A request message.
Request() - Constructor for class org.forgerock.openig.http.Request
Creates a new request message.
RequestCookies - Class in org.forgerock.openig.http
Exposes incoming request cookies.
RequestCookies(Request) - Constructor for class org.forgerock.openig.http.RequestCookies
Constructs a new request cookies object that reads cookies from the specified request.
reset() - Method in class org.forgerock.openig.io.ByteArrayBranchingStream
Repositions this stream to the position at the time the mark method was last called on this input stream.
resolve(String) - Method in interface org.forgerock.openig.alias.ClassAliasResolver
Returns the Class mapped to the given alias or null if the alias is unknown.
resolve(String) - Method in class org.forgerock.openig.alias.CoreClassAliasResolver
 
resolve(String) - Method in interface org.forgerock.openig.filter.oauth2.AccessTokenResolver
Resolves a given access token against a authorization server.
resolve(String) - Method in class org.forgerock.openig.filter.oauth2.cache.CachingAccessTokenResolver
 
resolve(String) - Method in class org.forgerock.openig.filter.oauth2.OAuth2ClassAliasResolver
 
resolve(String) - Method in class org.forgerock.openig.filter.oauth2.resolver.OpenAmAccessTokenResolver
 
resolve(String) - Method in class org.forgerock.openig.handler.saml.SamlClassAliasResolver
 
resolve(MutableUri) - Method in class org.forgerock.openig.util.MutableUri
Resolves the given URI against this URI.
resolveFunction(String, String) - Method in class org.forgerock.openig.el.Functions
Resolves the specified prefix and local name into a method.
Resolver - Interface in org.forgerock.openig.resolver
Exposes an object's elements for access through dynamic expressions and scripts.
Resolvers - Class in org.forgerock.openig.resolver
Performs object resolution by object type.
resolvers(Object) - Static method in class org.forgerock.openig.resolver.Resolvers
Provides an iterable object over the resolvers that are appropriate for a particular object.
response - Variable in class org.forgerock.openig.http.Exchange
The response portion of the HTTP exchange.
Response - Class in org.forgerock.openig.http
A response message.
Response() - Constructor for class org.forgerock.openig.http.Response
Creates a new response.
retainAll(Collection<?>) - Method in class org.forgerock.openig.util.CaseInsensitiveSet
 
retainAll(Collection<?>) - Method in class org.forgerock.openig.util.SetDecorator
Retains only the elements in the set that are contained in the specified collection (optional operation).
retryRequest(IOException, int, HttpContext) - Method in class org.forgerock.openig.util.NoRetryHttpRequestRetryHandler
Log the IOException message (when logger at LogLevel.DEBUG level) and return false for every request.
RouterHandler - Class in org.forgerock.openig.handler.router
Auto-configured DispatchHandler.
RouterHandler(RouteBuilder, DirectoryScanner) - Constructor for class org.forgerock.openig.handler.router.RouterHandler
Builds a router that loads its configuration from the given directory.
RouterHandler.Heaplet - Class in org.forgerock.openig.handler.router
Creates and initializes a routing handler in a heap environment.
RouterHandler.Heaplet() - Constructor for class org.forgerock.openig.handler.router.RouterHandler.Heaplet
 
run(Map<String, Object>) - Method in class org.forgerock.openig.script.Script
Runs this script using the provided named variable bindings.
runScript(Exchange, Handler) - Method in class org.forgerock.openig.script.AbstractScriptableHeapObject
Runs the compiled script using the provided exchange and optional forwarding handler.

S

SamlClassAliasResolver - Class in org.forgerock.openig.handler.saml
Register all the aliases supported by the openig-saml module.
SamlClassAliasResolver() - Constructor for class org.forgerock.openig.handler.saml.SamlClassAliasResolver
 
SamlFederationHandler - Class in org.forgerock.openig.handler.saml
The federation servlet adapter.
SamlFederationHandler() - Constructor for class org.forgerock.openig.handler.saml.SamlFederationHandler
 
SamlFederationHandler.Heaplet - Class in org.forgerock.openig.handler.saml
Reads the actual federation servlet from the JSON configuration file.
SamlFederationHandler.Heaplet() - Constructor for class org.forgerock.openig.handler.saml.SamlFederationHandler.Heaplet
 
SampleServer - Class in org.forgerock.openig.doc
Simple servlet allowing user-agents to get a home page, and to post form-based login to access a protected profile page.
Script - Class in org.forgerock.openig.script
A compiled script.
ScriptableFilter - Class in org.forgerock.openig.filter
A scriptable filter.
ScriptableFilter.Heaplet - Class in org.forgerock.openig.filter
Creates and initializes a scriptable filter in a heap environment.
ScriptableFilter.Heaplet() - Constructor for class org.forgerock.openig.filter.ScriptableFilter.Heaplet
 
ScriptableHandler - Class in org.forgerock.openig.handler
A scriptable handler.
ScriptableHandler.Heaplet - Class in org.forgerock.openig.handler
Creates and initializes a scriptable handler in a heap environment.
ScriptableHandler.Heaplet() - Constructor for class org.forgerock.openig.handler.ScriptableHandler.Heaplet
 
search(SearchRequest) - Method in class org.forgerock.openig.ldap.LdapConnection
Searches the Directory Server using the provided search parameters.
search(SearchRequest, Collection<? super SearchResultEntry>) - Method in class org.forgerock.openig.ldap.LdapConnection
Searches the Directory Server using the provided search request.
search(SearchRequest, Collection<? super SearchResultEntry>, Collection<? super SearchResultReference>) - Method in class org.forgerock.openig.ldap.LdapConnection
Searches the Directory Server using the provided search request.
search(String, SearchScope, String, String...) - Method in class org.forgerock.openig.ldap.LdapConnection
Searches the Directory Server using the provided search parameters.
searchSingleEntry(SearchRequest) - Method in class org.forgerock.openig.ldap.LdapConnection
Searches the Directory Server for a single entry using the provided search request.
searchSingleEntry(String, SearchScope, String, String...) - Method in class org.forgerock.openig.ldap.LdapConnection
Searches the Directory Server for a single entry using the provided search parameters.
SeparatedValuesFile - Class in org.forgerock.openig.text
Allows records to be retrieved from a delimiter-separated file using key and value.
SeparatedValuesFile(File) - Constructor for class org.forgerock.openig.text.SeparatedValuesFile
Builds a new SeparatedValuesFile reading the given file using a the Separators.COMMA separator specification and UTF-8 charset.
SeparatedValuesFile(File, Charset) - Constructor for class org.forgerock.openig.text.SeparatedValuesFile
Builds a new SeparatedValuesFile reading the given file using a the Separators.COMMA separator specification.
SeparatedValuesFile(File, Charset, Separator) - Constructor for class org.forgerock.openig.text.SeparatedValuesFile
Builds a new SeparatedValuesFile reading the given file.
SeparatedValuesFile(File, Charset, Separator, boolean) - Constructor for class org.forgerock.openig.text.SeparatedValuesFile
Builds a new SeparatedValuesFile reading the given file.
SeparatedValuesReader - Class in org.forgerock.openig.text
Reads records with delimiter-separated values from a character stream.
SeparatedValuesReader(Reader, Separator) - Constructor for class org.forgerock.openig.text.SeparatedValuesReader
Constructs a new separated values reader, to read a character stream from the specified reader and use the specified separator specification.
Separator - Class in org.forgerock.openig.text
A field separator specification, used to parse delimiter-separated values.
Separator(char, int, int) - Constructor for class org.forgerock.openig.text.Separator
Constructs a new field separator specification.
Separators - Enum in org.forgerock.openig.text
Commonly used field separator specifications.
SequenceHandler - Class in org.forgerock.openig.handler
Processes an exchange through a sequence of handlers.
SequenceHandler() - Constructor for class org.forgerock.openig.handler.SequenceHandler
 
SequenceHandler.Heaplet - Class in org.forgerock.openig.handler
Creates and initializes a sequence handler in a heap environment.
SequenceHandler.Heaplet() - Constructor for class org.forgerock.openig.handler.SequenceHandler.Heaplet
 
serialVersionUID - Static variable in exception org.forgerock.openig.filter.oauth2.OAuth2TokenException
Serial Version UID.
service(HttpServletRequest, HttpServletResponse) - Method in class org.forgerock.openig.servlet.GatewayServlet
Handles a servlet request by dispatching it to a handler.
SERVICES - Static variable in interface org.forgerock.openig.decoder.Decoder
Mapping of supported codings to associated decoders.
SERVICES - Static variable in class org.forgerock.openig.resolver.Resolvers
Mapping of supported classes to associated resolvers.
ServletSession - Class in org.forgerock.openig.servlet
Exposes the session managed by the servlet container as an exchange session.
ServletSession(HttpServletRequest) - Constructor for class org.forgerock.openig.servlet.ServletSession
Creates a new session object which manages sessions through the provided servlet request object.
session - Variable in class org.forgerock.openig.http.Exchange
Session context associated with the remote client.
Session - Interface in org.forgerock.openig.http
An interface for managing attributes across multiple requests from the same user agent.
set(Object, Object) - Method in class org.forgerock.openig.el.Expression
Sets the result of an evaluated expression to a specified value.
set - Variable in class org.forgerock.openig.util.SetDecorator
The set wrapped by this decorator.
setAlgorithm(String) - Method in class org.forgerock.openig.filter.CryptoHeaderFilter
Sets the cryptographic algorithm.
setAuthorizeEndpoint(Expression) - Method in class org.forgerock.openig.filter.oauth2.client.OAuth2Provider
Sets the expression which will be used for obtaining the authorization server's authorize end-point.
setBaseURI(Expression) - Method in class org.forgerock.openig.filter.RedirectFilter
Sets the base URI used to rewrite Location headers.
setBytes(byte[]) - Method in class org.forgerock.openig.http.Entity
Sets the content of this entity to the raw data contained in the provided byte array.
setCacheHeader(boolean) - Method in class org.forgerock.openig.filter.HttpBasicAuthFilter
Decide if we cache the password header result (defaults to true).
setCaptureEntity(boolean) - Method in class org.forgerock.openig.filter.CaptureFilter
If set to true, the message's entity will be captured as part of the output.
setCharset(Charset) - Method in class org.forgerock.openig.filter.CryptoHeaderFilter
The Charset to use for decrypted values.
setClientEndpoint(Expression) - Method in class org.forgerock.openig.filter.oauth2.client.OAuth2ClientFilter
Sets the expression which will be used for obtaining the base URI for the following client end-points: {endpoint}/callback - called by the authorization server once authorization has completed {endpoint}/login?provider={name}[&goto={url}] - user end-point for performing user initiated authentication, such as from a "login" link or "NASCAR" login page.
setClientId(Expression) - Method in class org.forgerock.openig.filter.oauth2.client.OAuth2Provider
Sets the expression which will be used for obtaining the OAuth 2 client ID.
setClientSecret(Expression) - Method in class org.forgerock.openig.filter.oauth2.client.OAuth2Provider
Sets the expression which will be used for obtaining the OAuth 2 client secret.
setComment(String) - Method in class org.forgerock.openig.http.Cookie
Sets the intended use of a cookie.
setCommentURL(String) - Method in class org.forgerock.openig.http.Cookie
Sets the URL identifying the intended use of a cookie.
setCondition(Expression) - Method in class org.forgerock.openig.filter.CaptureFilter
Used to conditionally capture the exchange.
SetDecorator<E> - Class in org.forgerock.openig.util
Contains another set, which is uses as its basic source of data, possibly transforming the data along the way.
SetDecorator(Set<E>) - Constructor for class org.forgerock.openig.util.SetDecorator
Constructs a new set decorator, wrapping the specified set.
setDefaultAction(CookieFilter.Action) - Method in class org.forgerock.openig.filter.CookieFilter
Set the action to perform for cookies that do not match an action set.
setDefaultHandler(Handler) - Method in class org.forgerock.openig.handler.router.RouterHandler
Sets the handler which should be invoked when no routes match the request.
setDefaultLoginGoto(Expression) - Method in class org.forgerock.openig.filter.oauth2.client.OAuth2ClientFilter
Sets the expression which will be used for obtaining the default login "goto" URI.
setDefaultLogoutGoto(Expression) - Method in class org.forgerock.openig.filter.oauth2.client.OAuth2ClientFilter
Sets the expression which will be used for obtaining the default logout "goto" URI.
setDiscard(Boolean) - Method in class org.forgerock.openig.http.Cookie
Sets the value indicating whether the user agent should discard the cookie unconditionally when it terminates.
setDomain(String) - Method in class org.forgerock.openig.http.Cookie
Sets the domain for which the cookie is valid.
setEntity(Object) - Method in class org.forgerock.openig.http.Message
Sets the content of the entity to the provided value.
setExpires(Date) - Method in class org.forgerock.openig.http.Cookie
Sets the lifetime of the cookie, expressed as the date and time of expiration.
setFailureHandler(Handler) - Method in class org.forgerock.openig.filter.oauth2.client.OAuth2ClientFilter
Sets the handler which will be invoked when authentication fails.
setFragment(String) - Method in class org.forgerock.openig.util.MutableUri
Update the fragment (not encoded) of this MutableUri.
setHost(String) - Method in class org.forgerock.openig.util.MutableUri
Update the host name of this MutableUri.
setHttpClient(HttpClient) - Method in class org.forgerock.openig.script.AbstractScriptableHeapObject
Sets the HTTP client which should be made available to scripts.
setHttpOnly(Boolean) - Method in class org.forgerock.openig.http.Cookie
Sets the value indicating whether the user agent should make the cookie inaccessible to client side script.
setJson(Object) - Method in class org.forgerock.openig.http.Entity
Sets the content of this entity to the JSON representation of the provided object.
setKey(Key) - Method in class org.forgerock.openig.filter.CryptoHeaderFilter
Sets the encryption key.
setLevel(LogLevel) - Method in class org.forgerock.openig.log.ConsoleLogSink
Sets the level of log entries to display in the console.
setLevel(LogLevel) - Method in class org.forgerock.openig.log.FileLogSink
Sets the level of log entries to display in the file.
setLoginHandler(Handler) - Method in class org.forgerock.openig.filter.oauth2.client.OAuth2ClientFilter
Sets the handler which will be invoked when the user needs to authenticate.
setMaxAge(Integer) - Method in class org.forgerock.openig.http.Cookie
Sets the lifetime of the cookie, expressed in seconds.
setMessageType(MessageType) - Method in class org.forgerock.openig.filter.CryptoHeaderFilter
Sets the type of message in the exchange to process headers for.
setMethod(String) - Method in class org.forgerock.openig.http.Request
Sets the method to be performed on the resource.
setName(String) - Method in class org.forgerock.openig.http.Cookie
Sets the name of the cookie.
setOperation(CryptoHeaderFilter.Operation) - Method in class org.forgerock.openig.filter.CryptoHeaderFilter
Sets the operation (encryption/decryption) to apply to the headers.
setPath(String) - Method in class org.forgerock.openig.http.Cookie
Sets the subset of URLs on the origin server to which this cookie applies.
setPath(String) - Method in class org.forgerock.openig.util.MutableUri
Update the path (not encoded) of this MutableUri.
setPersistenceStrategy(OAuth2SessionPersistenceStrategy) - Method in class org.forgerock.openig.filter.oauth2.client.OAuth2ClientFilter
Specifies how OAuth2 session state information will be persisted between successive HTTP requests.
setPolicy(CookiePolicy) - Method in class org.forgerock.openig.filter.CookieFilter
Set the policy for managed cookies.
setPort(int) - Method in class org.forgerock.openig.util.MutableUri
Update the port of this MutableUri.
setProviderHandler(Handler) - Method in class org.forgerock.openig.filter.oauth2.client.OAuth2ClientFilter
Sets the handler which will be used for communicating with the authorization server.
setQuery(String) - Method in class org.forgerock.openig.util.MutableUri
Update the query string (not encoded) of this MutableUri.
setRawFragment(String) - Method in class org.forgerock.openig.util.MutableUri
Update the fragment (encoded) of this MutableUri.
setRawInputStream(BranchingInputStream) - Method in class org.forgerock.openig.http.Entity
Sets the content of this entity to the provided input stream.
setRawPath(String) - Method in class org.forgerock.openig.util.MutableUri
Update the pah (encoded) of this MutableUri.
setRawQuery(String) - Method in class org.forgerock.openig.util.MutableUri
Update the query (encoded) of this MutableUri.
setRawUserInfo(String) - Method in class org.forgerock.openig.util.MutableUri
Update the user info (encoded) of this MutableUri.
setReason(String) - Method in class org.forgerock.openig.http.Response
Sets the response status reason.
setRequireHttps(boolean) - Method in class org.forgerock.openig.filter.oauth2.client.OAuth2ClientFilter
Specifies whether all incoming requests must use TLS.
setRequireLogin(boolean) - Method in class org.forgerock.openig.filter.oauth2.client.OAuth2ClientFilter
Specifies whether authentication is required for all incoming requests.
setRestore(boolean) - Method in class org.forgerock.openig.filter.StaticRequestFilter
Sets to false if this filter should not restore the original Request after execution.
setRouteComparator(Comparator<Route>) - Method in class org.forgerock.openig.handler.router.RouterHandler
Changes the ordering of the managed routes.
setScheme(String) - Method in class org.forgerock.openig.util.MutableUri
Update the scheme of this MutableUri.
setScopes(List<Expression>) - Method in class org.forgerock.openig.filter.oauth2.client.OAuth2ClientFilter
Sets the expressions which will be used for obtaining the OAuth 2 scopes.
setScopes(List<Expression>) - Method in class org.forgerock.openig.filter.oauth2.client.OAuth2Provider
Sets the expressions which will be used for obtaining the OAuth 2 scopes for this provider.
setSecure(Boolean) - Method in class org.forgerock.openig.http.Cookie
Sets the value indicating whether the user agent should use only secure means to send back this cookie.
setStatus(Integer) - Method in class org.forgerock.openig.http.Response
Sets the response status code.
setString(String) - Method in class org.forgerock.openig.http.Entity
Sets the content of this entity to the provided string.
setTarget(Expression) - Method in class org.forgerock.openig.filter.oauth2.client.OAuth2ClientFilter
Sets the expression which will be used for storing authorization information in the exchange.
setTimeout(Duration) - Method in class org.forgerock.openig.filter.oauth2.cache.ThreadSafeCache
Sets the cache entry expiration delay.
setTokenEndpoint(Expression) - Method in class org.forgerock.openig.filter.oauth2.client.OAuth2Provider
Sets the expression which will be used for obtaining the authorization server's access token end-point.
setUri(Expression) - Method in class org.forgerock.openig.filter.StaticRequestFilter
Sets the target URI as an expression to allow dynamic URI construction.
setUri(String) - Method in class org.forgerock.openig.http.Request
Sets the fully-qualified string URI of the resource being accessed.
setUri(URI) - Method in class org.forgerock.openig.http.Request
Sets the fully-qualified URI of the resource being accessed.
setUserInfo(String) - Method in class org.forgerock.openig.util.MutableUri
Update the user info (not encoded) of this MutableUri.
setUserInfoEndpoint(Expression) - Method in class org.forgerock.openig.filter.oauth2.client.OAuth2Provider
Sets the expression which will be used for obtaining the authorization server's OpenID Connect user info end-point.
setValue(String) - Method in class org.forgerock.openig.http.Cookie
Sets the value of the cookie.
setVersion(String) - Method in class org.forgerock.openig.filter.StaticRequestFilter
Sets the new request message's version.
setVersion(Integer) - Method in class org.forgerock.openig.http.Cookie
Sets the version of the state management mechanism to which this cookie conforms.
setVersion(String) - Method in class org.forgerock.openig.http.Message
Sets the protocol version.
setWellKnownConfiguration(JsonValue) - Method in class org.forgerock.openig.filter.oauth2.client.OAuth2Provider
Configures this provider using the specified OpenID Connect Well Known configuration.
setWriterProvider(CaptureFilter.WriterProvider) - Method in class org.forgerock.openig.filter.CaptureFilter
Assign the given provider.
SIXTY_FOUR_KB - Static variable in class org.forgerock.openig.io.TemporaryStorage
64 KiB.
size() - Method in class org.forgerock.openig.http.RequestCookies
 
size() - Method in class org.forgerock.openig.servlet.ServletSession
 
size() - Method in class org.forgerock.openig.util.ExtensibleFieldMap
 
size() - Method in class org.forgerock.openig.util.SetDecorator
 
skip(long) - Method in class org.forgerock.openig.io.BranchingStreamWrapper
Skips over and discards n bytes of data from this input stream.
skip(long) - Method in class org.forgerock.openig.io.ByteArrayBranchingStream
Skips over and discards n bytes of data from this input stream.
skip(long) - Method in class org.forgerock.openig.io.NullInputStream
Always returns 0 to indicate that no bytes were skipped.
split(String, String) - Static method in class org.forgerock.openig.el.Functions
Splits a string into an array of substrings around matches of the given regular expression.
split(String, char) - Static method in class org.forgerock.openig.header.HeaderUtil
Parses an HTTP header value, splitting it into multiple values around the specified separator.
SqlAttributesFilter - Class in org.forgerock.openig.filter
Executes a SQL query through a prepared statement and exposes its first result.
SqlAttributesFilter(DataSource, Expression, String) - Constructor for class org.forgerock.openig.filter.SqlAttributesFilter
Builds a new SqlAttributesFilter that will execute the given SQL statement on the given DataSource, placing the results in a Map in the specified target.
SqlAttributesFilter.Heaplet - Class in org.forgerock.openig.filter
Creates and initializes a static attribute provider in a heap environment.
SqlAttributesFilter.Heaplet() - Constructor for class org.forgerock.openig.filter.SqlAttributesFilter.Heaplet
 
start() - Method in class org.forgerock.openig.handler.router.RouterHandler.Heaplet
 
start() - Method in class org.forgerock.openig.handler.router.RouterHandler
Starts this handler, executes an initial directory scan.
start() - Method in class org.forgerock.openig.heap.GenericHeaplet
Called to request the heaplet start an object.
start() - Method in class org.forgerock.openig.log.LogTimer
Starts the timer.
StaticRequestFilter - Class in org.forgerock.openig.filter
Creates a new request with in the exchange object.
StaticRequestFilter(String) - Constructor for class org.forgerock.openig.filter.StaticRequestFilter
Builds a new StaticRequestFilter that will uses the given HTTP method on the resource.
StaticRequestFilter.Heaplet - Class in org.forgerock.openig.filter
Creates and initializes a request filter in a heap environment.
StaticRequestFilter.Heaplet() - Constructor for class org.forgerock.openig.filter.StaticRequestFilter.Heaplet
 
StaticResponseHandler - Class in org.forgerock.openig.handler
Creates a static response in an HTTP exchange.
StaticResponseHandler(Integer, String) - Constructor for class org.forgerock.openig.handler.StaticResponseHandler
Constructor.
StaticResponseHandler(Integer, String, String, Expression) - Constructor for class org.forgerock.openig.handler.StaticResponseHandler
Constructor.
StaticResponseHandler.Heaplet - Class in org.forgerock.openig.handler
Creates and initializes a static response handler in a heap environment.
StaticResponseHandler.Heaplet() - Constructor for class org.forgerock.openig.handler.StaticResponseHandler.Heaplet
 
stop() - Method in class org.forgerock.openig.handler.router.RouterHandler
Stops this handler, shutting down and clearing all the managed routes.
stop() - Method in class org.forgerock.openig.log.LogTimer
Stops the timer and records the elapsed time in a metric.
storage - Variable in class org.forgerock.openig.heap.GenericHeaplet
Allocates temporary buffers for caching streamed content during processing.
storage - Variable in class org.forgerock.openig.heap.GenericHeapObject
Allocates temporary buffers for caching streamed content during processing.
stream(InputStream, OutputStream) - Static method in class org.forgerock.openig.io.Streamer
Streams all data from an input stream to an output stream.
stream(InputStream, OutputStream, int) - Static method in class org.forgerock.openig.io.Streamer
Streams data from an input stream to an output stream, up to a specified length.
stream(Reader, Writer) - Static method in class org.forgerock.openig.io.Streamer
Streams all characters from a reader to a writer.
Streamer - Class in org.forgerock.openig.io
Utility class that can stream to and from streams.
StreamPatternExtractor - Class in org.forgerock.openig.regex
Extracts regular expression patterns and/or applied templates from character streams.
StreamPatternExtractor() - Constructor for class org.forgerock.openig.regex.StreamPatternExtractor
 
StreamPatternMatches - Class in org.forgerock.openig.regex
Iterates through multiple regular expression matches within a character stream.
StreamPatternMatches(Reader, Collection<Pattern>, boolean) - Constructor for class org.forgerock.openig.regex.StreamPatternMatches
Constructs a new stream pattern match iterator.
StringPatternMatches - Class in org.forgerock.openig.regex
Iterates through multiple regular expression matches within a character sequence.
StringPatternMatches(CharSequence, Collection<Pattern>, boolean) - Constructor for class org.forgerock.openig.regex.StringPatternMatches
Constructs a new string pattern match iterator.
StringUtil - Class in org.forgerock.openig.util
Miscellaneous string utility methods.
SwitchFilter - Class in org.forgerock.openig.filter
Conditionally diverts the exchange to another handler.
SwitchFilter() - Constructor for class org.forgerock.openig.filter.SwitchFilter
 
SwitchFilter.Heaplet - Class in org.forgerock.openig.filter
Creates and initializes an expect filter in a heap environment.
SwitchFilter.Heaplet() - Constructor for class org.forgerock.openig.filter.SwitchFilter.Heaplet
 
sync() - Method in class org.forgerock.openig.util.CaseInsensitiveMap
Synchronizes the keys of this case insensitive map and those of the map it is wrapping.

T

TEMPORARY_STORAGE_HEAP_KEY - Static variable in class org.forgerock.openig.io.TemporaryStorage
Key to retrieve a TemporaryStorage instance from the Heap.
TemporaryBuffer - Class in org.forgerock.openig.io
A buffer that fist uses memory, then a temporary file for data storage.
TemporaryBuffer(int, int, int, File) - Constructor for class org.forgerock.openig.io.TemporaryBuffer
Constructs a new temporary buffer.
TemporaryStorage - Class in org.forgerock.openig.io
Allocates temporary buffers for caching streamed content during request processing.
TemporaryStorage() - Constructor for class org.forgerock.openig.io.TemporaryStorage
Builds a storage using the system dependent default temporary directory and default sizes.
TemporaryStorage(File) - Constructor for class org.forgerock.openig.io.TemporaryStorage
Builds a storage using the given directory (may be null) and default sizes.
TemporaryStorage(File, int, int, int) - Constructor for class org.forgerock.openig.io.TemporaryStorage
Builds a storage using the given directory (may be null) and provided sizes.
TemporaryStorage.Heaplet - Class in org.forgerock.openig.io
Creates and initializes a temporary storage object in a heap environment.
TemporaryStorage.Heaplet() - Constructor for class org.forgerock.openig.io.TemporaryStorage.Heaplet
 
TEN_SECONDS - Static variable in class org.forgerock.openig.http.HttpClient
Value of the default timeout.
ThreadSafeCache<K,V> - Class in org.forgerock.openig.filter.oauth2.cache
ThreadSafeCache is a thread-safe write-through cache.
ThreadSafeCache(ScheduledExecutorService) - Constructor for class org.forgerock.openig.filter.oauth2.cache.ThreadSafeCache
Build a new ThreadSafeCache using the given scheduled executor.
to(TimeUnit) - Method in class org.forgerock.openig.util.Duration
Convert the current duration to a number of given TimeUnit.
toArray() - Method in class org.forgerock.openig.util.SetDecorator
 
toArray(T[]) - Method in class org.forgerock.openig.util.SetDecorator
Returns an array containing all of the elements in the set; the runtime type of the returned array is that of the specified array.
toASCIIString() - Method in class org.forgerock.openig.util.MutableUri
Returns the content of this URI as a US-ASCII string.
toForm() - Method in class org.forgerock.openig.filter.oauth2.client.OAuth2Error
Returns the form representation of this error suitable for inclusion in an authorization call-back query.
toJsonContent() - Method in class org.forgerock.openig.filter.oauth2.client.OAuth2Error
Returns the JSON representation of this error formatted as an access token error response.
toLowerCase(String) - Static method in class org.forgerock.openig.el.Functions
Converts all of the characters in a string to lower case.
toMessage(Message<?>) - Method in class org.forgerock.openig.filter.oauth2.client.OAuth2BearerWWWAuthenticateHeader
 
toMessage(Message<?>) - Method in class org.forgerock.openig.header.ConnectionHeader
 
toMessage(Message<?>) - Method in class org.forgerock.openig.header.ContentEncodingHeader
 
toMessage(Message<?>) - Method in class org.forgerock.openig.header.ContentLengthHeader
 
toMessage(Message<?>) - Method in class org.forgerock.openig.header.ContentTypeHeader
 
toMessage(Message<?>) - Method in class org.forgerock.openig.header.CookieHeader
 
toMessage(Message<?>) - Method in interface org.forgerock.openig.header.Header
Sets the header in the specified message.
toMessage(Message<?>) - Method in class org.forgerock.openig.header.LocationHeader
 
toRequestEntity(Request) - Method in class org.forgerock.openig.http.Form
Populates a request with the necessary headers and entity for the form to be submitted as a POST with application/x-www-form-urlencoded content type.
toRequestQuery(Request) - Method in class org.forgerock.openig.http.Form
Sets a request URI with query parameters.
toString(Object) - Static method in class org.forgerock.openig.el.Functions
Returns the string value of an arbitrary object.
toString() - Method in class org.forgerock.openig.filter.oauth2.client.OAuth2BearerWWWAuthenticateHeader
 
toString() - Method in class org.forgerock.openig.filter.oauth2.client.OAuth2Error
 
toString() - Method in class org.forgerock.openig.header.ConnectionHeader
 
toString() - Method in class org.forgerock.openig.header.ContentEncodingHeader
 
toString() - Method in class org.forgerock.openig.header.ContentLengthHeader
 
toString() - Method in class org.forgerock.openig.header.ContentTypeHeader
 
toString() - Method in class org.forgerock.openig.header.CookieHeader
 
toString() - Method in interface org.forgerock.openig.header.Header
Returns the header as a single string value.
toString() - Method in class org.forgerock.openig.header.LocationHeader
 
toString() - Method in class org.forgerock.openig.http.Cookie
 
toString() - Method in class org.forgerock.openig.http.Entity
Returns the content of this entity decoded as a string.
toString() - Method in class org.forgerock.openig.http.Form
Returns this form in a URL-encoded format string.
toString() - Method in class org.forgerock.openig.http.RequestCookies
 
toString() - Method in class org.forgerock.openig.log.LogMetric
Returns the metric in the form value SP units.
toString() - Method in class org.forgerock.openig.regex.PatternTemplate
Returns the literal template value.
toString() - Method in class org.forgerock.openig.util.MutableUri
 
toUpperCase(String) - Static method in class org.forgerock.openig.el.Functions
Converts all of the characters in a string to upper case.
toWWWAuthenticateHeader() - Method in class org.forgerock.openig.filter.oauth2.client.OAuth2Error
Returns the string representation of this error formatted as a WWW-Authenticate header.
trace(String) - Method in class org.forgerock.openig.log.Logger
Logs the specified message at the TRACE log level.
trace(T) - Method in class org.forgerock.openig.log.Logger
Logs the specified exception at the TRACE log level.
trim(String) - Static method in class org.forgerock.openig.el.Functions
Returns a copy of a string with leading and trailing whitespace omitted.

U

UnixEnvironment - Class in org.forgerock.openig.config.env
Represents a UNIX default environment.
UnixEnvironment() - Constructor for class org.forgerock.openig.config.env.UnixEnvironment
Builds a new UNIX environment that will be located in the user's directory.
UnmodifiableCollection - Interface in org.forgerock.openig.util
An marker interface for tagging collection implementations as read-only.
UNRESOLVED - Static variable in interface org.forgerock.openig.resolver.Resolver
Singleton that is returned to indicate an element is not resolved by a resolver.
Unresolver - Class in org.forgerock.openig.resolver
Unconditionally resolves to UNRESOLVED.
Unresolver() - Constructor for class org.forgerock.openig.resolver.Unresolver
 
uri(String) - Static method in class org.forgerock.openig.util.MutableUri
Factory method for avoiding typing new MutableUri("http://...").
URIUtil - Class in org.forgerock.openig.util
Utility class for performing operations on universal resource identifiers.
urlDecode(String) - Static method in class org.forgerock.openig.el.Functions
Returns the URL decoding of the provided string.
urlEncode(String) - Static method in class org.forgerock.openig.el.Functions
Returns the URL encoding of the provided string.
UTF_8 - Static variable in class org.forgerock.openig.log.FileLogSink
Default Charset to use on the output file.

V

valueOf(String) - Static method in enum org.forgerock.openig.filter.CookieFilter.Action
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.openig.filter.CryptoHeaderFilter.Operation
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in class org.forgerock.openig.filter.oauth2.client.OAuth2Error
Parses the provided OAuth2Error.toString() representation as an OAuth 2.0 error.
valueOf(String) - Static method in enum org.forgerock.openig.http.MessageType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.openig.log.LogLevel
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.openig.text.Separators
Returns the enum constant of this type with the specified name.
valueOf(Class<T>, Object) - Static method in class org.forgerock.openig.util.EnumUtil
Returns the enum constant of the specified enum type with the specified name, or null if the specified enum type has no constant with the specified name, or if the specified class object does not represent an enum type.
valueOfForm(Form) - Static method in class org.forgerock.openig.filter.oauth2.client.OAuth2Error
Parses the Form representation of an authorization call-back error as an OAuth 2.0 error.
valueOfJsonContent(Map<String, Object>) - Static method in class org.forgerock.openig.filter.oauth2.client.OAuth2Error
Parses the JSON representation of an access token error response as an OAuth 2.0 error.
valueOfWWWAuthenticateHeader(String) - Static method in class org.forgerock.openig.filter.oauth2.client.OAuth2Error
Parses the provided WWW-Authenticate header content as an OAuth 2.0 error.
values() - Static method in enum org.forgerock.openig.filter.CookieFilter.Action
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.openig.filter.CryptoHeaderFilter.Operation
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.openig.http.MessageType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Method in class org.forgerock.openig.http.RequestCookies
 
values() - Static method in enum org.forgerock.openig.log.LogLevel
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.openig.text.Separators
Returns an array containing the constants of this enum type, in the order they are declared.

W

warning(String) - Method in class org.forgerock.openig.log.Logger
Logs the specified message at the WARNING log level.
warning(T) - Method in class org.forgerock.openig.log.Logger
Logs the specified exception at the WARNING log level.
WebEnvironment - Class in org.forgerock.openig.servlet
Represents an Environment built from a webapp.
WebEnvironment(ServletConfig) - Constructor for class org.forgerock.openig.servlet.WebEnvironment
Builds a new web environment.
WelcomeHandler - Class in org.forgerock.openig.handler
Creates a static response containing a simple HTML welcome page.
WelcomeHandler() - Constructor for class org.forgerock.openig.handler.WelcomeHandler
Creates a new welcome page handler.
WelcomeHandler.Heaplet - Class in org.forgerock.openig.handler
Creates and initializes a static response handler in a heap environment.
WelcomeHandler.Heaplet() - Constructor for class org.forgerock.openig.handler.WelcomeHandler.Heaplet
 
WindowsEnvironment - Class in org.forgerock.openig.config.env
Represents a Windows default environment.
WindowsEnvironment() - Constructor for class org.forgerock.openig.config.env.WindowsEnvironment
Builds a new Windows environment that will be located in the $AppData$ directory.
withoutQueryAndFragment(URI) - Static method in class org.forgerock.openig.util.URIUtil
Returns a new URI having the same scheme, authority and path, but no query nor fragment.
withQuery(URI, Form) - Static method in class org.forgerock.openig.util.URIUtil
Returns a new URI having the provided query parameters.
write(int) - Method in class org.forgerock.openig.io.NullOutputStream
 
write(byte[]) - Method in class org.forgerock.openig.io.NullOutputStream
 
write(byte[], int, int) - Method in class org.forgerock.openig.io.NullOutputStream
 
WWW_AUTHENTICATE - Static variable in class org.forgerock.openig.filter.oauth2.challenge.AuthenticateChallengeHandler
Authorization HTTP Header name.
A B C D E F G H I J K L M N O P Q R S T U V W 
OpenIG 3.0.0 API

Copyright © 2014 ForgeRock AS. All rights reserved.