org.picketlink.idm.model.sample

Class SampleModel

java.lang.Object

org.picketlink.idm.model.sample.SampleModel

public class SampleModel
extends Object

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

Author:

Shane Bryzak

Constructor Summary

Constructors

Constructor and Description
SampleModel()

Method Summary

Methods

Modifier and Type	Method and Description
static void	addToGroup(RelationshipManager relationshipManager, Account member, Group group) Adds the given Agent as a member of the provided Group.
static Agent	getAgent(IdentityManager identityManager, String loginName) Returns an Agent with the given loginName.
static Group	getGroup(IdentityManager identityManager, String groupPath) Returns the Group with the specified groupPath.
static Group	getGroup(IdentityManager identityManager, String groupName, Group parent) Returns the Group with the given name and child of the given parent Group.
static Role	getRole(IdentityManager identityManager, String name) Returns an Role with the given name.
static User	getUser(IdentityManager identityManager, String loginName) Returns an User 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, IdentityType identity, 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 Agent 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

SampleModel

public SampleModel()

Method Detail

getAgent

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

Returns an Agent with the given loginName. User are also agents, so if the loginName maps to the an User it will be returned.

Parameters:

loginName -

Throws:

IdentityManagementException - If cannot retrieve the Agent.

getUser

public static User getUser(IdentityManager identityManager,
           String loginName)

Returns an User with the given loginName.

Parameters:

loginName -

Returns:

If there is no User with the given loginName this method returns null.

getRole

public static Role getRole(IdentityManager identityManager,
           String name)

Returns an Role with the given name.

Parameters:

loginName -

Returns:

If there is no Role with the given name this method returns null.

getGroup

public static Group getGroup(IdentityManager identityManager,
             String groupPath)

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

You can also provide the name only. In this case, the group returned will be the root group. Eg.: /Administrators.

Parameters:

groupPath -

Returns:

if there is no Group with the given groupPath this method returns null.

getGroup

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

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

Parameters:

groupName -

parent - Must be a Group instance with a valid identifier.

Returns:

if there is no Group this method returns null.

isMember

public static boolean isMember(RelationshipManager relationshipManager,
               IdentityType identity,
               Group group)

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

Parameters:

identityType - Must be a Agent or Group instance.

group -

Returns:

true if the IdentityType is a member of the provided Group.

addToGroup

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

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

Parameters:

agent -

group -

removeFromGroup

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

Removes the given Agent from the provided Group.

Parameters:

member -

group -

hasGroupRole

public 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.

Parameters:

assignee -

role -

group -

Returns:

grantGroupRole

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

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

Parameters:

assignee -

role -

group -

revokeGroupRole

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

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

Parameters:

assignee -

role -

group -

hasRole

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

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

Parameters:

identityType -

role -

Returns:

grantRole

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

Grants the given Role to the provided IdentityType.

Parameters:

identityType -

role -

revokeRole

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

Revokes the given Role from the provided IdentityType.

Parameters:

identityType -

role -