# Uses of Class
org.opensaml.messaging.context.BaseContext

Packages that use BaseContext
Package
Description
org.opensaml.messaging.context
Interfaces and classes for tracking message processing state.
org.opensaml.messaging.context.httpclient
Interfaces and classes for tracking HTTP message processing state.
org.opensaml.messaging.context.navigate
A set of functions used to navigate and lookup data from a tree of `BaseContext`s.
org.opensaml.messaging.handler.impl
Implementations of message context handlers.
org.opensaml.profile.action.impl
Implementations of general profile actions.
org.opensaml.profile.context
Context classes in support of profile behavior.
org.opensaml.profile.context.navigate
Functions for navigating profile context information.
org.opensaml.profile.logic
First order logic predicates and functions used for working with profile request data.
org.opensaml.saml.common.binding.impl
Implementation of SAML binding-level functionality, such as MessageHandlers.
org.opensaml.saml.common.messaging.context
Context classes for SAML-based messaging function.
org.opensaml.saml.saml2.binding.decoding.impl
SAML 2.0 message decoders.
org.opensaml.saml.saml2.profile.context
Context classes supporting SAML 2 profiles.
org.opensaml.security.messaging
Messaging-related security classes.
org.opensaml.soap.client
SOAP client functionality.
org.opensaml.soap.client.security
Classes related to SOAP client security.
org.opensaml.soap.messaging.context
Context classes in support of SOAP messaging.
org.opensaml.soap.wsaddressing.messaging
WS-Addressing messaging support components.
org.opensaml.soap.wssecurity.messaging
WS-Security messaging support components.
org.opensaml.storage.impl.client
Implementation of `StorageService` that unifies cookie and HTML Local Storage.
org.opensaml.xmlsec.context
Message context classes for XML Security.

## Uses of BaseContext in org.opensaml.messaging.context

Subclasses of BaseContext in org.opensaml.messaging.context
Modifier and Type
Class
Description
`class`
`InOutOperationContext`
An operation context which represents concretely a message exchange pattern involving an inbound message and an outbound message.
`final class`
`MessageChannelSecurityContext`
A subcontext which carries information about whether the message channel in use is considered to have the active properties of confidentiality and integrity.
`final class`
`MessageContext`
A context component which holds the state related to the processing of a single message.
`final class`
`ScratchContext`
A context subclass for holding arbitrary data in a map.
Fields in org.opensaml.messaging.context declared as BaseContext
Modifier and Type
Field
Description
`private BaseContext`
BaseContext.`parent`
The owning parent context.
Fields in org.opensaml.messaging.context with type parameters of type BaseContext
Modifier and Type
Field
Description
`private final Map<String,Class<? extends BaseContext>>`
BaseContext.DeprecatedContextClassNameLookAside.`lookAsideMap`
Map of renamed classes.
`private ClassIndexedSet<BaseContext>`
BaseContext.`subcontexts`
The subcontexts being managed.
`private Iterator<BaseContext>`
BaseContext.ContextSetNoRemoveIteratorDecorator.`wrappedIterator`
The decorated iterator.
Methods in org.opensaml.messaging.context with type parameters of type BaseContext
Modifier and Type
Method
Description
`<T extends BaseContext>
boolean`
BaseContext.`containsSubcontext(Class<T> clazz)`
Return whether the current context currently contains an instance of the specified subcontext class.
`protected <T extends BaseContext>
T`
BaseContext.`createSubcontext(Class<T> clazz)`
Create an instance of the specified subcontext class.
`<T extends BaseContext>
T`
BaseContext.`ensureSubcontext(Class<T> clazz)`
Get a subcontext of the current context, creating it if it does not exist.
`<T extends BaseContext>
T`
BaseContext.`getSubcontext(Class<T> clazz)`
Get a subcontext of the current context.
`<T extends BaseContext>
T`
BaseContext.`getSubcontext(Class<T> clazz, boolean autocreate)`
Deprecated.
use `ensureSubcontext(Class)` or `getSubcontext(Class)`.
`<T extends BaseContext>
void`
BaseContext.`removeSubcontext(Class<T> clazz)`
Remove the subcontext from the current context which corresponds to the supplied class.
Methods in org.opensaml.messaging.context that return BaseContext
Modifier and Type
Method
Description
`BaseContext`
BaseContext.`addSubcontext(BaseContext subContext)`
Add a subcontext to the current context.
`BaseContext`
BaseContext.`addSubcontext(BaseContext subcontext, boolean replace)`
Add a subcontext to the current context.
`BaseContext`
BaseContext.`ensureSubcontext(String className)`
Get a subcontext of the current context, creating it if necessary.
`BaseContext`
BaseContext.`getParent()`
Get the parent context, if there is one.
`BaseContext`
BaseContext.`getSubcontext(String className)`
Get a subcontext of the current context.
`BaseContext`
BaseContext.`getSubcontext(String className, boolean autocreate)`
Deprecated.
use `ensureSubcontext(String)` or `getSubcontext(String)`.
`BaseContext`
BaseContext.ContextSetNoRemoveIteratorDecorator.`next()`
Methods in org.opensaml.messaging.context that return types with arguments of type BaseContext
Modifier and Type
Method
Description
`Class<? extends BaseContext>`
BaseContext.DeprecatedContextClassNameLookAside.`get(String name)`
Get the relocated class object if it exists.
`Iterator<BaseContext>`
BaseContext.`iterator()`
Methods in org.opensaml.messaging.context with parameters of type BaseContext
Modifier and Type
Method
Description
`BaseContext`
BaseContext.`addSubcontext(BaseContext subContext)`
Add a subcontext to the current context.
`BaseContext`
BaseContext.`addSubcontext(BaseContext subcontext, boolean replace)`
Add a subcontext to the current context.
`void`
BaseContext.`removeSubcontext(BaseContext subcontext)`
Remove a subcontext from the current context.
`protected void`
BaseContext.`setParent(BaseContext newParent)`
Set the context parent.
Constructor parameters in org.opensaml.messaging.context with type arguments of type BaseContext
Modifier
Constructor
Description
`protected`
`ContextSetNoRemoveIteratorDecorator(Iterator<BaseContext> iterator)`
Constructor.
``
`DeprecatedContextClassNameLookAside(Map<String,Class<? extends BaseContext>> map)`
Constructor.

## Uses of BaseContext in org.opensaml.messaging.context.httpclient

Subclasses of BaseContext in org.opensaml.messaging.context.httpclient
Modifier and Type
Class
Description
`final class`
`HttpClientRequestContext`
A context impl holding data related to the execution of an `HttpClient` request.

## Uses of BaseContext in org.opensaml.messaging.context.navigate

Classes in org.opensaml.messaging.context.navigate with type parameters of type BaseContext
Modifier and Type
Class
Description
`class`
`ChildContextLookup<ParentContext extends BaseContext,ChildContext extends BaseContext>`
A `ContextDataLookupFunction` that gets the child context of a given parent context.
`class`
`ChildContextLookup<ParentContext extends BaseContext,ChildContext extends BaseContext>`
A `ContextDataLookupFunction` that gets the child context of a given parent context.
`interface`
`ContextDataLookupFunction<F extends BaseContext,T>`
A `Function` that is used to navigate a `BaseContext` tree and extract data from it.
`class`
`MessageContextLookup<StartContext extends BaseContext>`
A lookup function for resolving either the inbound or outbound `MessageContext` relative to a particular `BaseContext`.
`class`
`ParentContextLookup<StartContext extends BaseContext,ParentContext extends BaseContext>`
A `ContextDataLookupFunction` that gets the parent of a given context.
`class`
`ParentContextLookup<StartContext extends BaseContext,ParentContext extends BaseContext>`
A `ContextDataLookupFunction` that gets the parent of a given context.
`class`
`RecursiveTypedChildContextLookup<ChildContext extends BaseContext>`
A `ContextDataLookupFunction` that peforms a depth-first search of context's children and returns the first nested child context that is an instance of the specified type.
`class`
`RecursiveTypedParentContextLookup<StartContext extends BaseContext,ParentContext extends BaseContext>`
A `ContextDataLookupFunction` that recurses up the parent chain of the input via `getParent()`, and returns the first parent context that is an instance of the specified type.
`class`
`RecursiveTypedParentContextLookup<StartContext extends BaseContext,ParentContext extends BaseContext>`
A `ContextDataLookupFunction` that recurses up the parent chain of the input via `getParent()`, and returns the first parent context that is an instance of the specified type.
`class`
`RootContextLookup<StartContext extends BaseContext,RootContext extends BaseContext>`
A `ContextDataLookupFunction` that gets the root of context tree.
`class`
`RootContextLookup<StartContext extends BaseContext,RootContext extends BaseContext>`
A `ContextDataLookupFunction` that gets the root of context tree.
Fields in org.opensaml.messaging.context.navigate with type parameters of type BaseContext
Modifier and Type
Field
Description
`private Function<BaseContext,InOutOperationContext>`
MessageContextLookup.`opContextLookup`
The operation context lookup.
Methods in org.opensaml.messaging.context.navigate with parameters of type BaseContext
Modifier and Type
Method
Description
`MessageContext`
MessageContextLookup.`apply(BaseContext baseContext)`
`ChildContext`
RecursiveTypedChildContextLookup.`apply(BaseContext input)`
`RootContext`
RootContextLookup.`apply(BaseContext input)`
Constructor parameters in org.opensaml.messaging.context.navigate with type arguments of type BaseContext
Modifier
Constructor
Description
``
`MessageContextLookup(MessageContextLookup.Direction direction, Function<BaseContext,InOutOperationContext> lookup)`
Constructor.

## Uses of BaseContext in org.opensaml.messaging.handler.impl

Fields in org.opensaml.messaging.handler.impl declared as BaseContext
Modifier and Type
Field
Description
`private BaseContext`
AbstractMessageChannelSecurity.`parentContext`
Parent for eventual context.
Fields in org.opensaml.messaging.handler.impl with type parameters of type BaseContext
Modifier and Type
Field
Description
`private Function<MessageContext,BaseContext>`
AbstractMessageChannelSecurity.`parentContextLookupStrategy`
Strategy used to look up the parent `BaseContext` on which the `MessageChannelSecurityContext` will be populated.
Methods in org.opensaml.messaging.handler.impl that return BaseContext
Modifier and Type
Method
Description
`protected BaseContext`
AbstractMessageChannelSecurity.`ensureParentContext()`
Get the parent context on which the `MessageChannelSecurityContext` will be populated, raising an `IllegalStateException` if null.
`protected BaseContext`
AbstractMessageChannelSecurity.`getParentContext()`
Get the parent context on which the `MessageChannelSecurityContext` will be populated.
Method parameters in org.opensaml.messaging.handler.impl with type arguments of type BaseContext
Modifier and Type
Method
Description
`void`
AbstractMessageChannelSecurity.`setParentContextLookupStrategy(Function<MessageContext,BaseContext> strategy)`
Set the strategy used to look up the parent `BaseContext` on which the `MessageChannelSecurityContext` will be populated.

## Uses of BaseContext in org.opensaml.profile.action.impl

Fields in org.opensaml.profile.action.impl declared as BaseContext
Modifier and Type
Field
Description
`private BaseContext`
AbstractMessageChannelSecurity.`parentContext`
Parent for eventual context.
Fields in org.opensaml.profile.action.impl with type parameters of type BaseContext
Modifier and Type
Field
Description
`private Function<ProfileRequestContext,BaseContext>`
AbstractMessageChannelSecurity.`parentContextLookupStrategy`
Strategy used to look up the parent `BaseContext` on which the `MessageChannelSecurityContext` will be populated.
Methods in org.opensaml.profile.action.impl that return BaseContext
Modifier and Type
Method
Description
`protected BaseContext`
AbstractMessageChannelSecurity.`ensureParentContext()`
Get the parent context on which the `MessageChannelSecurityContext` will be populated, raising an `IllegalStateException` if absent.
`protected BaseContext`
AbstractMessageChannelSecurity.`getParentContext()`
Get the parent context on which the `MessageChannelSecurityContext` will be populated.
Method parameters in org.opensaml.profile.action.impl with type arguments of type BaseContext
Modifier and Type
Method
Description
`void`
AbstractMessageChannelSecurity.`setParentContextLookupStrategy(Function<ProfileRequestContext,BaseContext> strategy)`
Set the strategy used to look up the parent `BaseContext` on which the `MessageChannelSecurityContext` will be populated.

## Uses of BaseContext in org.opensaml.profile.context

Subclasses of BaseContext in org.opensaml.profile.context
Modifier and Type
Class
Description
`final class`
`AccessControlContext`
A context component which holds state for making an access control decision using the `AccessControl` interface.
`class`
`EventContext`
A context component which holds the result of a profile action that produces an "event".
`final class`
`MetricContext`
Child context that supplies instructions to the runtime actions about timers to start and stop to measure performance.
`final class`
`PreviousEventContext<EventType>`
A context component which holds the last result produced by a profile action that produced an "event".
`final class`
`ProfileRequestContext`
Context that holds the ongoing state of a profile request.
`final class`
`ProxiedRequesterContext`
A context which expresses one or more requesters on whose behalf a request is being handled.

## Uses of BaseContext in org.opensaml.profile.context.navigate

Classes in org.opensaml.profile.context.navigate with type parameters of type BaseContext
Modifier and Type
Class
Description
`class`
`ParentProfileRequestContextLookup<StartContext extends BaseContext>`
A convenience subtype of `RecursiveTypedParentContextLookup` which returns the `ProfileRequestContext` parent of the target `BaseContext`.

## Uses of BaseContext in org.opensaml.profile.logic

Methods in org.opensaml.profile.logic with parameters of type BaseContext
Modifier and Type
Method
Description
`boolean`
IPRangePredicate.`test(BaseContext input)`

## Uses of BaseContext in org.opensaml.saml.common.binding.impl

Fields in org.opensaml.saml.common.binding.impl with type parameters of type BaseContext
Modifier and Type
Field
Description
`private ContextDataLookupFunction<MessageContext,? extends BaseContext>`
SAMLProtocolAndRoleHandler.`copyContextLookup`
Optional lookup function for a context from which to copy the protocol and role data, for example from a parent operation context.
Method parameters in org.opensaml.saml.common.binding.impl with type arguments of type BaseContext
Modifier and Type
Method
Description
`void`
SAMLProtocolAndRoleHandler.`setCopyContextLookup(ContextDataLookupFunction<MessageContext,? extends BaseContext> lookup)`
Set the optional lookup function for a context from which to copy the protocol and role data, for example from a parent operation context.

## Uses of BaseContext in org.opensaml.saml.common.messaging.context

Subclasses of BaseContext in org.opensaml.saml.common.messaging.context
Modifier and Type
Class
Description
`class`
`AbstractAuthenticatableSAMLEntityContext`
Abstract base class for subcontexts that carry information about a SAML entity which may be authenticated.
`class`
`AbstractSAMLEntityContext`
Abstract base class for subcontexts that carry information about a SAML entity.
`final class`
`AttributeConsumingServiceContext`
Context, usually attached to `SAMLMetadataContext` that carries a SAML `AttributeConsumingService` for use in later stages.
`final class`
`ChannelBindingsContext`
Context, usually attached to a `MessageContext` that carries a collection of `ChannelBindings` objects supplied with a message.
`final class`
`ECPContext`
Context, usually attached to a `MessageContext` that carries state associated with an ECP request that is needed during response generation.
`final class`
`SAMLArtifactContext`
Context that carries information about SAML artifact usage.
`final class`
`SAMLBindingContext`
Context for holding information related to the SAML binding in use.
`final class`
`SAMLConsentContext`
Subcontext that carries information about a SAML Consent value.
`final class`
`SAMLEndpointContext`
Context that carries information about a SAML entity endpoint.
`final class`
`SAMLMessageInfoContext`
A context intended to be used as a subcontext of a `MessageContext` that carries some basic information about the SAML message.
`class`
`SAMLMessageReceivedEndpointContext`
A context intended to be used as a subcontext of a `MessageContext` that carries some basic information about the SAML message.
`final class`
`SAMLMetadataContext`
Subcontext that carries information SAML metadata about an associated entity.
`class`
`SAMLMetadataLookupParametersContext`
Context for operational parameters that influence the lookup of SAML metadata.
`final class`
`SAMLPeerEntityContext`
Subcontext that carries information about a SAML peer entity.
`final class`
`SAMLPresenterEntityContext`
Deprecated, for removal: This API element is subject to removal in a future version.
`final class`
`SAMLProtocolContext`
Subcontext that carries information about the ongoing SAML protocol.
`final class`
`SAMLSelfEntityContext`
Subcontext that carries information about the SAML "self" entity.
`final class`
`SAMLSubjectNameIdentifierContext`
A context implementation which represents a SAML 1 `NameIdentifier` or a SAML 2 `NameID`.

## Uses of BaseContext in org.opensaml.saml.saml2.binding.decoding.impl

Subclasses of BaseContext in org.opensaml.saml.saml2.binding.decoding.impl
Modifier and Type
Class
Description
`class`
`SimpleSignatureContext`
Context implementation holding data related to SAML 2 "simple signature" evaluation.

## Uses of BaseContext in org.opensaml.saml.saml2.profile.context

Subclasses of BaseContext in org.opensaml.saml.saml2.profile.context
Modifier and Type
Class
Description
`final class`
`EncryptionContext`
Context supplying encryption parameters for the different forms of SAML XML encryption.

## Uses of BaseContext in org.opensaml.security.messaging

Subclasses of BaseContext in org.opensaml.security.messaging
Modifier and Type
Class
Description
`final class`
`ClientTLSSecurityParametersContext`
Messaging context implementation for holding parameters related to validating client TLS `X509Credential` instances.
`final class`
`HttpClientSecurityContext`
A context implementation holding parameters related to `HttpClient` security features.

## Uses of BaseContext in org.opensaml.soap.client

Subclasses of BaseContext in org.opensaml.soap.client
Modifier and Type
Class
Description
`final class`
`SOAPClientContext`
Message context for SOAP client messages.

## Uses of BaseContext in org.opensaml.soap.client.security

Subclasses of BaseContext in org.opensaml.soap.client.security
Modifier and Type
Class
Description
`final class`
`SOAPClientSecurityContext`
Context class for holding security information related to SOAP client operations.

## Uses of BaseContext in org.opensaml.soap.messaging.context

Subclasses of BaseContext in org.opensaml.soap.messaging.context
Modifier and Type
Class
Description
`final class`
`InboundSOAPContext`
A subcontext holding information related to processing of an inbound SOAP message.
`final class`
`SOAP11Context`
Subcontext that carries information about the SOAP 1.1 message transport.

## Uses of BaseContext in org.opensaml.soap.wsaddressing.messaging

Subclasses of BaseContext in org.opensaml.soap.wsaddressing.messaging
Modifier and Type
Class
Description
`class`
`WSAddressingContext`
A subcontext that carries information related to WS-Addressing processing.

## Uses of BaseContext in org.opensaml.soap.wssecurity.messaging

Subclasses of BaseContext in org.opensaml.soap.wssecurity.messaging
Modifier and Type
Class
Description
`final class`
`WSSecurityContext`
A subcontext that carries information related to WS-Security processing.

## Uses of BaseContext in org.opensaml.storage.impl.client

Subclasses of BaseContext in org.opensaml.storage.impl.client
Modifier and Type
Class
Description
`class`
`ClientStorageLoadContext`
A subcontext for driving the loading of data from a client into one or more instances of a `ClientStorageService`.
`class`
`ClientStorageSaveContext`
A subcontext for driving the saving of data to a client from one or more instances of a `ClientStorageService`.

## Uses of BaseContext in org.opensaml.xmlsec.context

Subclasses of BaseContext in org.opensaml.xmlsec.context
Modifier and Type
Class
Description
`final class`
`SecurityParametersContext`
A context implementation for storing parameter instances for XML signature signing and validation, and XML encryption and decryption.