org.picketlink.idm.model.basic

Class BasicModel

java.lang.Object

org.picketlink.idm.model.basic.BasicModel

public class BasicModel
extends Object

This class provides a number of static convenience methods for looking up identities from the basic identity model.

Author:

Shane Bryzak

Constructor Summary

Constructors

Constructor and Description
BasicModel()

Method Summary

Methods

Modifier and Type	Method and Description
static void	addToGroup(RelationshipManager relationshipManager, Account member, Group group) Adds the given Account as a member of the provided Group.
static Agent	getAgent(IdentityManager identityManager, String loginName) Returns an Agent instance with the given loginName.
static Group	getGroup(IdentityManager identityManager, String groupPath) Returns a Group instance with the specified groupPath.
static Group	getGroup(IdentityManager identityManager, String groupName, Group parent) Returns the Group with the given groupName and child of the given parent Group.
static Role	getRole(IdentityManager identityManager, String name) Returns an Role instance with the given name.
static User	getUser(IdentityManager identityManager, String loginName) Returns an User instance with the given loginName.
static void	grantGroupRole(RelationshipManager relationshipManager, IdentityType assignee, Role role, Group group) Creates a GroupRole relationship for the given IdentityType, Role and Group instances.
static void	grantRole(RelationshipManager relationshipManager, IdentityType assignee, Role role) Grants the given Role to the provided IdentityType.
static boolean	hasGroupRole(RelationshipManager relationshipManager, IdentityType assignee, Role role, Group group) Checks if the given IdentityType, Role and Group instances maps to a GroupRole relationship.
static boolean	hasRole(RelationshipManager relationshipManager, IdentityType assignee, Role role) Checks if the given Role is granted to the provided IdentityType.
static boolean	isMember(RelationshipManager relationshipManager, Account member, Group group) Checks if the given IdentityType is a member of a specific Group.
static void	removeFromGroup(RelationshipManager relationshipManager, Account member, Group group) Removes the given Account from the provided Group.
static void	revokeGroupRole(RelationshipManager relationshipManager, IdentityType assignee, Role role, Group group) Revokes a GroupRole relationship for the given IdentityType, Role and Group instances.
static void	revokeRole(RelationshipManager relationshipManager, IdentityType assignee, Role role) Revokes the given Role from the provided IdentityType.

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicModel

public BasicModel()

Method Detail

getAgent

public static Agent getAgent(IdentityManager identityManager,
             String loginName)
                      throws IdentityManagementException

Returns an Agent instance with the given loginName.

Parameters:

loginName - The agent's login name.

Returns:

An Agent instance or null if the loginName is null or an empty string. User are also agents, so if the loginName maps to an user, it will be returned.

Throws:

IdentityManagementException - If the method fails.

getUser

public static User getUser(IdentityManager identityManager,
           String loginName)
                    throws IdentityManagementException

Returns an User instance with the given loginName.

Parameters:

loginName - The agent's login name.

Returns:

An User instance or null if the loginName is null or an empty string.

Throws:

IdentityManagementException - If the method fails.

getRole

public static Role getRole(IdentityManager identityManager,
           String name)
                    throws IdentityManagementException

Returns an Role instance with the given name.

Parameters:

name - The role's name.

Returns:

An Role instance or null if the name is null or an empty string.

Throws:

IdentityManagementException - If the method fails.

getGroup

public static Group getGroup(IdentityManager identityManager,
             String groupPath)
                      throws IdentityManagementException

Returns a Group instance with the specified groupPath. Eg.: /groupA/groupB/groupC.

Parameters:

groupPath - The group's path or its name only without the group separator. In this last case, the group returned will be the root group. Eg.: Administrators == /Administrators.

Returns:

An Group instance or null if the groupPath is null or an empty string.

Throws:

IdentityManagementException - If the method fails.

getGroup

public static Group getGroup(IdentityManager identityManager,
             String groupName,
             Group parent)
                      throws IdentityManagementException

Returns the Group with the given groupName and child of the given parent Group.

Parameters:

groupName - The group's name.

parent - A Group instance with a valid identifier or null. In this last case, the returned group will be always a root group.

Returns:

An Group instance or null if the groupName is null or an empty string.

Throws:

IdentityManagementException - If the method fails.

isMember

public static boolean isMember(RelationshipManager relationshipManager,
               Account member,
               Group group)
                        throws IdentityManagementException

Checks if the given IdentityType is a member of a specific Group.

Parameters:

member - A previously loaded Account instance.

group - A previously loaded Group instance.

Returns:

True if the Account is a member of the provided Group. Otherwise this method returns false.

Throws:

IdentityManagementException - If the method fails.

addToGroup

public static void addToGroup(RelationshipManager relationshipManager,
              Account member,
              Group group)
                       throws IdentityManagementException

Adds the given Account as a member of the provided Group.

Parameters:

member - A previously loaded Account instance.

group - A previously loaded Group instance.

Throws:

IdentityManagementException - If the method fails.

removeFromGroup

public static void removeFromGroup(RelationshipManager relationshipManager,
                   Account member,
                   Group group)
                            throws IdentityManagementException

Removes the given Account from the provided Group.

Parameters:

member - A previously loaded Account instance.

group - A previously loaded Group instance.

Throws:

IdentityManagementException - If the method fails.

hasGroupRole

public static boolean hasGroupRole(RelationshipManager relationshipManager,
                   IdentityType assignee,
                   Role role,
                   Group group)
                            throws IdentityManagementException

Checks if the given IdentityType, Role and Group instances maps to a GroupRole relationship.

Parameters:

assignee - A previously loaded IdentityType instance.

role - A previously loaded Role instance.

group - A previously loaded Group instance.

Returns:

True if the given assignee, role and group map to a previously stored GroupRole relationship. Otherwise this method returns false.

Throws:

IdentityManagementException - If the method fails.

grantGroupRole

public static void grantGroupRole(RelationshipManager relationshipManager,
                  IdentityType assignee,
                  Role role,
                  Group group)
                           throws IdentityManagementException

Creates a GroupRole relationship for the given IdentityType, Role and Group instances.

Parameters:

assignee - A previously loaded IdentityType instance.

role - A previously loaded Role instance.

group - A previously loaded Group instance.

Throws:

IdentityManagementException - If the method fails.

revokeGroupRole

public static void revokeGroupRole(RelationshipManager relationshipManager,
                   IdentityType assignee,
                   Role role,
                   Group group)
                            throws IdentityManagementException

Revokes a GroupRole relationship for the given IdentityType, Role and Group instances.

Parameters:

assignee - A previously loaded IdentityType instance.

role - A previously loaded Role instance.

group - A previously loaded Group instance.

Throws:

IdentityManagementException - If the method fails.

hasRole

public static boolean hasRole(RelationshipManager relationshipManager,
              IdentityType assignee,
              Role role)
                       throws IdentityManagementException

Checks if the given Role is granted to the provided IdentityType.

Parameters:

assignee - A previously loaded IdentityType instance. Valid instances are only from the Account and Group types.

role - A previously loaded Role instance.

Returns:

True if the give Role is granted. Otherwise this method returns false.

Throws:

IdentityManagementException - If the method fails.

grantRole

public static void grantRole(RelationshipManager relationshipManager,
             IdentityType assignee,
             Role role)
                      throws IdentityManagementException

Grants the given Role to the provided IdentityType.

Parameters:

assignee - A previously loaded IdentityType instance. Valid instances are only from the Account and Group types.

role - A previously loaded Role instance.

Throws:

IdentityManagementException - If the method fails.

revokeRole

public static void revokeRole(RelationshipManager relationshipManager,
              IdentityType assignee,
              Role role)
                       throws IdentityManagementException

Revokes the given Role from the provided IdentityType.

Parameters:

assignee - A previously loaded IdentityType instance. Valid instances are only from the Account and Group types.

role - A previously loaded Role instance.

Throws:

IdentityManagementException - If the method fails.