org.picketlink.idm.spi

Class IdentityStoreInvocationContext

java.lang.Object

org.picketlink.idm.spi.IdentityStoreInvocationContext

public class IdentityStoreInvocationContext
extends Object

Used to pass contextual state to an IdentityStore during an identity management operation.

Author:

Shane Bryzak

Constructor Summary

Constructors

Constructor and Description
IdentityStoreInvocationContext(IdentityManager identityManager, IdentityCache cache, EventBridge eventBridge, CredentialHandlerFactory factory, IdGenerator idGenerator)

Method Summary

Methods

Modifier and Type	Method and Description
IdentityCache	getCache() Returns the cache for this invocation context.
CredentialHandler	getCredentialUpdater(Class<?> credentialClass, IdentityStore identityStore) Returns a CredentialHandler instance capable of updating a credential of the specified Credentials class, for the specified IdentityStore class
CredentialHandler	getCredentialValidator(Class<? extends Credentials> credentialsClass, IdentityStore identityStore) Returns a CredentialHandler instance capable of validating a credential of the specified Credentials class, for the specified IdentityStore class
EventBridge	getEventBridge()
IdentityManager	getIdentityManager()
IdGenerator	getIdGenerator()
Object	getParameter(String paramName) Returns the parameter value with the specified name
Partition	getPartition() Returns the current Partition.
Realm	getRealm() Return the active Realm for this context
Tier	getTier() Return the active Tier for this context
boolean	isParameterSet(String paramName) Returns a boolean indicating whether the parameter with the specified name has been set
void	setParameter(String paramName, Object value) Sets a parameter value
void	setRealm(Realm realm) Sets the active Realm for this context
void	setTier(Tier tier) Sets the active Tier for this context

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IdentityStoreInvocationContext

public IdentityStoreInvocationContext(IdentityManager identityManager,
                              IdentityCache cache,
                              EventBridge eventBridge,
                              CredentialHandlerFactory factory,
                              IdGenerator idGenerator)

Method Detail

getCredentialValidator

public CredentialHandler getCredentialValidator(Class<? extends Credentials> credentialsClass,
                                       IdentityStore identityStore)

Returns a CredentialHandler instance capable of validating a credential of the specified Credentials class, for the specified IdentityStore class

Parameters:

credentialsClass -

identityStoreClass -

Returns:

getCredentialUpdater

public CredentialHandler getCredentialUpdater(Class<?> credentialClass,
                                     IdentityStore identityStore)

Returns a CredentialHandler instance capable of updating a credential of the specified Credentials class, for the specified IdentityStore class

Parameters:

credentialClass -

identityStoreClass -

Returns:

getCache

public IdentityCache getCache()

Returns the cache for this invocation context.

Returns:

getParameter

public Object getParameter(String paramName)

Returns the parameter value with the specified name

Returns:

isParameterSet

public boolean isParameterSet(String paramName)

Returns a boolean indicating whether the parameter with the specified name has been set

Parameters:

paramName -

Returns:

setParameter

public void setParameter(String paramName,
                Object value)

Sets a parameter value

Parameters:

paramName -

value -

getEventBridge

public EventBridge getEventBridge()

Returns:

getIdGenerator

public IdGenerator getIdGenerator()

Returns:

getRealm

public Realm getRealm()

Return the active Realm for this context

Returns:

setRealm

public void setRealm(Realm realm)

Sets the active Realm for this context

Parameters:

realm -

getTier

public Tier getTier()

Return the active Tier for this context

Returns:

setTier

public void setTier(Tier tier)

Sets the active Tier for this context

Parameters:

tier -

getPartition

public Partition getPartition()

Returns the current Partition. It can be a Realm or a Tier. If the Tier is setted it will be returned otherwise the Realm.

Returns:

getIdentityManager

public IdentityManager getIdentityManager()