org.picketlink.idm

Interface IdentityCache

All Known Implementing Classes:

DefaultIdentityCache

public interface IdentityCache

Storage for User, Group and Role instances to enable quick resolution of identity memberships. TODO: dicuss if we can have only two methods here. put(IdentityType) and lookup/get(IdentityType). TODO: dicuss if we need cache capabilities when using stores like the the JPA that usually have its own cache mechanisms (eg.: hibernate second level cache).

Author:

Shane Bryzak

Method Summary

Modifier and Type	Method and Description
void	invalidate(Partition partition, IdentityType identity)
Agent	lookupAgent(Realm realm, String loginName) Returns the cached Agent object for the specified id, in the specified Realm.
Group	lookupGroup(Partition partition, String groupPath) Returns the cached Group object with the specified group id, in the specified partition.
Role	lookupRole(Partition partition, String name) Returns the cached Role object with the specified name, in the specified partition.
User	lookupUser(Realm realm, String loginName) Returns the cached User object for the specified id, in the specified Realm.
void	putAgent(Realm realm, Agent agent) Inserts the specified Agent into the cache, within the specified Partition.
void	putGroup(Partition partition, Group group) Inserts the specified group into the cache, within the specified Partition.
void	putRole(Partition partition, Role role) Inserts the specified role into the cache, within the specified Partition.
void	putUser(Realm realm, User user) Inserts the specified user into the cache, for the specified Realm.

Method Detail

lookupUser

User lookupUser(Realm realm,
                String loginName)

Returns the cached User object for the specified id, in the specified Realm. If the User has not previously been cached, returns null.

Parameters:

realm -

loginName -

Returns:

lookupGroup

Group lookupGroup(Partition partition,
                  String groupPath)

Returns the cached Group object with the specified group id, in the specified partition. If the Group has not previously been cached, returns null.

Parameters:

partition -

groupPath -

Returns:

lookupRole

Role lookupRole(Partition partition,
                String name)

Returns the cached Role object with the specified name, in the specified partition. If the Role has not previously been cached, returns null.

Parameters:

partition -

name -

Returns:

putUser

void putUser(Realm realm,
             User user)

Inserts the specified user into the cache, for the specified Realm.

Parameters:

realm -

user -

putGroup

void putGroup(Partition partition,
              Group group)

Inserts the specified group into the cache, within the specified Partition.

Parameters:

partition -

group -

putRole

void putRole(Partition partition,
             Role role)

Inserts the specified role into the cache, within the specified Partition.

Parameters:

partition -

role -

lookupAgent

Agent lookupAgent(Realm realm,
                  String loginName)

Returns the cached Agent object for the specified id, in the specified Realm. If the Agent has not previously been cached, returns null.

Parameters:

realm -

loginName -

Returns:

putAgent

void putAgent(Realm realm,
              Agent agent)

Inserts the specified Agent into the cache, within the specified Partition.

Parameters:

partition -

role -

invalidate

void invalidate(Partition partition,
                IdentityType identity)

Parameters:

identity -