org.picketlink.idm

Interface RelationshipManager

All Known Implementing Classes:

ContextualRelationshipManager

public interface RelationshipManager

Defines relationship management operations

Author:

Shane Bryzak

Method Summary

Methods

Modifier and Type	Method and Description
void	add(Relationship relationship) Adds the given Relationship instance to the configured identity store.
<T extends Relationship> RelationshipQuery<T>	createRelationshipQuery(Class<T> relationshipType) Creates an RelationshipQuery that can be used to query for Relationship instances.
boolean	inheritsPrivileges(IdentityType identity, IdentityType assignee) Returns true if the specified identity is the same or inherits privileges assigned to the specified assignee, either via a relationship or a direct reference from the identity (or a combination of these)
void	remove(Relationship relationship) Removes the given Relationship instance.
void	update(Relationship relationship) Updates the given Relationship instance.

Method Detail

add

void add(Relationship relationship)
         throws IdentityManagementException

Adds the given Relationship instance to the configured identity store.

Parameters:

relationship -

Throws:

IdentityManagementException - If cannot add the provided Relationship instance.

update

void update(Relationship relationship)
            throws IdentityManagementException

Updates the given Relationship instance. The instance must have an identifier that references a previously stored instance, otherwise a exception will be thrown.

Parameters:

relationship -

Throws:

IdentityManagementException - If cannot update the provided Relationship instance.

remove

void remove(Relationship relationship)
            throws IdentityManagementException

Removes the given Relationship instance. The instance must have an identifier that references a previously stored instance, otherwise a exception will be thrown.

Parameters:

relationship -

Throws:

IdentityManagementException - If cannot remove the provided Relationship instance.

createRelationshipQuery

<T extends Relationship> RelationshipQuery<T> createRelationshipQuery(Class<T> relationshipType)

Creates an RelationshipQuery that can be used to query for Relationship instances.

The first argument tells which Relationship type should be returned. If you provide the Relationship base interface any Relationship instance that matches the provided query parameters will be returned.

Parameters:

relationshipType -

Returns:

inheritsPrivileges

boolean inheritsPrivileges(IdentityType identity,
                         IdentityType assignee)

Returns true if the specified identity is the same or inherits privileges assigned to the specified assignee, either via a relationship or a direct reference from the identity (or a combination of these)

Parameters:

identity -

assignee -

Returns: