org.jboss.picketlink.idm.spi
Interface IdentityStore

public interface IdentityStore

IdentityStore representation providing minimal SPI

Method Summary

Group	createGroup(String name, Group parent)
Membership	createMembership(Role role, User user, Group group)
Role	createRole(String name)
User	createUser(String name)
List<Group>	executeQuery(GroupQuery query, Range range)
List<Membership>	executeQuery(MembershipQuery query, Range range)
List<Role>	executeQuery(RoleQuery query, Range range)
List<User>	executeQuery(UserQuery query, Range range)
Map<String,String[]>	getAttributes(Group group)
Map<String,String[]>	getAttributes(Role role)
Map<String,String[]>	getAttributes(User user)
String[]	getAttributeValues(Group group, String name)
String[]	getAttributeValues(Role role, String name)
String[]	getAttributeValues(User user, String name)
Group	getGroup(String name)
Membership	getMembership(Role role, User user, Group group)
Role	getRole(String role)
User	getUser(String name)
void	removeAttribute(Group group, String name) Remove attribute with given name
void	removeAttribute(Role role, String name) Remove attribute with given name
void	removeAttribute(User user, String name)
void	removeGroup(Group group)
void	removeMembership(Role role, User user, Group group)
void	removeRole(Role role)
void	removeUser(User user)
void	setAttribute(Group group, String name, String[] values) Set attribute with given name and values.
void	setAttribute(Role role, String name, String[] values) Set attribute with given name and values.
void	setAttribute(User user, String name, String[] values) Set attribute with given name and values.

Method Detail

createUser

User createUser(String name)

removeUser

void removeUser(User user)

getUser

User getUser(String name)

createGroup

Group createGroup(String name,
                  Group parent)

removeGroup

void removeGroup(Group group)

getGroup

Group getGroup(String name)

createRole

Role createRole(String name)

removeRole

void removeRole(Role role)

getRole

Role getRole(String role)

createMembership

Membership createMembership(Role role,
                            User user,
                            Group group)

removeMembership

void removeMembership(Role role,
                      User user,
                      Group group)

getMembership

Membership getMembership(Role role,
                         User user,
                         Group group)

executeQuery

List<User> executeQuery(UserQuery query,
                        Range range)

executeQuery

List<Group> executeQuery(GroupQuery query,
                         Range range)

executeQuery

List<Role> executeQuery(RoleQuery query,
                        Range range)

executeQuery

List<Membership> executeQuery(MembershipQuery query,
                              Range range)

setAttribute

void setAttribute(User user,
                  String name,
                  String[] values)

Set attribute with given name and values. Operation will overwrite any previous values. Null value or empty array will remove attribute.

Parameters:

user -

name - of attribute

values - to be set

removeAttribute

void removeAttribute(User user,
                     String name)

Parameters:

user - Remove attribute with given name

name - of attribute

getAttributeValues

String[] getAttributeValues(User user,
                            String name)

Parameters:

user -

name - of attribute

Returns:

attribute values or null if attribute with given name doesn't exist

getAttributes

Map<String,String[]> getAttributes(User user)

Parameters:

user -

Returns:

map of attribute names and their values

setAttribute

void setAttribute(Group group,
                  String name,
                  String[] values)

Set attribute with given name and values. Operation will overwrite any previous values. Null value or empty array will remove attribute.

Parameters:

group -

name - of attribute

values - to be set

removeAttribute

void removeAttribute(Group group,
                     String name)

Remove attribute with given name

Parameters:

group -

name - of attribute

getAttributeValues

String[] getAttributeValues(Group group,
                            String name)

Parameters:

group -

name - of attribute

Returns:

attribute values or null if attribute with given name doesn't exist

getAttributes

Map<String,String[]> getAttributes(Group group)

Parameters:

group -

Returns:

map of attribute names and their values

setAttribute

void setAttribute(Role role,
                  String name,
                  String[] values)

Set attribute with given name and values. Operation will overwrite any previous values. Null value or empty array will remove attribute.

Parameters:

role -

name - of attribute

values - to be set

removeAttribute

void removeAttribute(Role role,
                     String name)

Remove attribute with given name

Parameters:

role -

name - of attribute

getAttributeValues

String[] getAttributeValues(Role role,
                            String name)

Parameters:

role -

name - of attribute

Returns:

attribute values or null if attribute with given name doesn't exist

getAttributes

Map<String,String[]> getAttributes(Role role)

Parameters:

role -

Returns:

map of attribute names and their values