Package org.forgerock.services.context
Class AbstractContext
java.lang.Object
org.forgerock.services.context.AbstractContext
- All Implemented Interfaces:
Context
- Direct Known Subclasses:
AdviceContext
,ApiVersionRouterContext
,AttributesContext
,ClientContext
,MessageContextImpl
,OAuth2Context
,RequestAuditContext
,RootContext
,SecurityContext
,SelfServiceContext
,SessionContext
,TransactionIdContext
,UriRouterContext
A base implementation of the
Context
interface. Derived Contexts MUST support persistence by providing
- a public constructor having the same declaration as
AbstractContext(JsonValue, ClassLoader)
- a public method having the same declaration as
Context.toJsonValue()
Here is an example of the JSON representation of the core attributes of all contexts:
{ "id" : "56f0fb7e-3837-464d-b9ec-9d3b6af665c3", "class" : ...Java class name.., "parent" : { ... } }
-
Field Summary
-
Constructor Summary
ModifierConstructorDescriptionprotected
AbstractContext
(String id, String name, Context parent) Constructs a newAbstractContext
.AbstractContext
(JsonValue savedContext, ClassLoader classLoader) Creates a new context from the JSON representation of a previously persisted context.protected
AbstractContext
(Context parent, String name) Constructs a newAbstractContext
with anull
id
. -
Method Summary
Modifier and TypeMethodDescriptionReturns an @{link Optional} which contains the first context in the chain whose type is a sub-type of the providedContext
class if one exists, or an empty optional if none is present.final <T extends Context>
TReturns the first context in the chain whose type is a sub-type of the providedContext
class.final boolean
containsContext
(Class<? extends Context> clazz) Returnstrue
if there is a context in the chain whose type is a sub-type of the providedContext
class.final boolean
containsContext
(String contextName) Returnstrue
if there is a context in the chain whose name matches the provided context name.final Context
getContext
(String contextName) Returns the first context in the chain whose context name matches the provided name.final String
Get this Context's name.final String
getId()
Returns the unique ID identifying this context, usually a UUID.final Context
Returns the parent of this context.Returns the unique ID of the root context, usually a UUID.final boolean
Returnstrue
if this context is a root context.Return this Context as a JsonValue (for persistence).toString()
-
Field Details
-
data
The Context data.
-
-
Constructor Details
-
AbstractContext
Constructs a newAbstractContext
with anull
id
.- Parameters:
parent
- The parent context.name
- The name of the context.
-
AbstractContext
Constructs a newAbstractContext
.- Parameters:
id
- The id of the context.parent
- The parent context.name
- The name of the context.
-
AbstractContext
Creates a new context from the JSON representation of a previously persisted context.Sub-classes MUST provide a constructor having the same declaration as this constructor in order to support persistence. Implementations MUST take care to invoke the super class implementation before parsing their own context attributes. Below is an example implementation for a security context which stores the user name and password of the authenticated user:
protected SecurityContext(JsonValue savedContext, ClassLoader classLoader) { // Invoke the super-class implementation first. super(savedContext, classLoader); // Now parse the attributes for this context. this.username = savedContext.get("username").required().asString(); this.password = savedContext.get("password").required().asString(); }
In order to create a context's persisted JSON representation, implementations must override.- Parameters:
savedContext
- The JSON representation from which this context's attributes should be parsed.classLoader
- The ClassLoader which can properly resolve the persisted class-name.
-
-
Method Details
-
getContextName
Description copied from interface:Context
Get this Context's name.- Specified by:
getContextName
in interfaceContext
- Returns:
- this object's name
-
asContext
Description copied from interface:Context
Returns the first context in the chain whose type is a sub-type of the providedContext
class. The method first checks this context to see if it has the required type, before proceeding to the parent context, and then continuing up the chain of parents until the root context is reached. -
as
Description copied from interface:Context
Returns an @{link Optional} which contains the first context in the chain whose type is a sub-type of the providedContext
class if one exists, or an empty optional if none is present. The method first checks this context to see if it has the required type, before proceeding to the parent context, and then continuing up the chain of parents until the root context is reached.- Specified by:
as
in interfaceContext
- Type Parameters:
T
- The context type.- Parameters:
clazz
- The class of context to be returned.- Returns:
- An
Optional
containing the first context in the chain whose type is a sub-type of the providedContext
class, or an empty optional if no such Context exists in the chain.
-
getContext
Description copied from interface:Context
Returns the first context in the chain whose context name matches the provided name.- Specified by:
getContext
in interfaceContext
- Parameters:
contextName
- The name of the context to be returned.- Returns:
- The first context in the chain whose name matches the provided context name.
-
get
Description copied from interface:Context
-
containsContext
Description copied from interface:Context
Returnstrue
if there is a context in the chain whose type is a sub-type of the providedContext
class. The method first checks this context to see if it has the required type, before proceeding to the parent context, and then continuing up the chain of parents until the root context is reached.- Specified by:
containsContext
in interfaceContext
- Parameters:
clazz
- The class of context to be checked.- Returns:
true
if there is a context in the chain whose type is a sub-type of the providedContext
class.
-
containsContext
Description copied from interface:Context
Returnstrue
if there is a context in the chain whose name matches the provided context name.- Specified by:
containsContext
in interfaceContext
- Parameters:
contextName
- The name of the context to locate.- Returns:
true
if there is a context in the chain whose context name matchescontextName
.
-
getId
Description copied from interface:Context
Returns the unique ID identifying this context, usually a UUID. If no ID has been defined then the ID of the parent context will be returned. -
getRootId
Description copied from interface:Context
Returns the unique ID of the root context, usually a UUID. -
getParent
Description copied from interface:Context
Returns the parent of this context. -
isRootContext
public final boolean isRootContext()Description copied from interface:Context
Returnstrue
if this context is a root context.- Specified by:
isRootContext
in interfaceContext
- Returns:
true
if this context is a root context.
-
toJsonValue
Description copied from interface:Context
Return this Context as a JsonValue (for persistence).- Specified by:
toJsonValue
in interfaceContext
- Returns:
- the Context data as a JsonValue.
-
toString
-