io.apiman.manager.api.core

Interface IIdmStorage

public interface IIdmStorage

Interface to manage roles and users. This is separate from the IStorage interface so that roles can be stored using a different strategy. An obvious example is that the users and roles may be stored in an LDAP directory while the core apiman data is stored in a database. Depending on implementation, various methods in this interface may not be supported. For example, if the IDM system being used is read only (perhaps because it is backed by some centrally managed LDAP system).

Author:

eric.wittmann@redhat.com

Method Summary

Methods

Modifier and Type	Method and Description
void	createMembership(io.apiman.manager.api.beans.idm.RoleMembershipBean membership) Grants membership into a role for a user.
void	createRole(io.apiman.manager.api.beans.idm.RoleBean role) Creates a new role in the role storage system.
void	createUser(io.apiman.manager.api.beans.idm.UserBean user) Creates a user in the IDM system.
void	deleteMembership(String userId, String roleId, String organizationId) Deletes a single membership.
void	deleteMemberships(String userId, String organizationId) Deletes all role memberships for a user in a given organization.
void	deleteRole(io.apiman.manager.api.beans.idm.RoleBean role) Deletes a role from the system.
io.apiman.manager.api.beans.search.SearchResultsBean<io.apiman.manager.api.beans.idm.RoleBean>	findRoles(io.apiman.manager.api.beans.search.SearchCriteriaBean criteria) Returns a list of users that match the given search criteria.
io.apiman.manager.api.beans.search.SearchResultsBean<io.apiman.manager.api.beans.idm.UserBean>	findUsers(io.apiman.manager.api.beans.search.SearchCriteriaBean criteria) Returns a list of users that match the given search criteria.
Set<io.apiman.manager.api.beans.idm.RoleMembershipBean>	getOrgMemberships(String organizationId) Gets all the memberships configured for a particular organization.
Set<io.apiman.manager.api.beans.idm.PermissionBean>	getPermissions(String userId) Returns a set of permissions granted to the user due to their role memberships.
io.apiman.manager.api.beans.idm.RoleBean	getRole(String roleId) Gets a role by id.
io.apiman.manager.api.beans.idm.UserBean	getUser(String userId) Gets a user by id.
Set<io.apiman.manager.api.beans.idm.RoleMembershipBean>	getUserMemberships(String userId) Gets all the user's memberships.
Set<io.apiman.manager.api.beans.idm.RoleMembershipBean>	getUserMemberships(String userId, String organizationId) Gets all the user's memberships for the given organization.
void	updateRole(io.apiman.manager.api.beans.idm.RoleBean role) Updates a single role (typically with new permissions).
void	updateUser(io.apiman.manager.api.beans.idm.UserBean user) Updates the personal information about a user.

Method Detail

createUser

void createUser(io.apiman.manager.api.beans.idm.UserBean user)
                throws StorageException,
                       AlreadyExistsException

Creates a user in the IDM system.

Parameters:

user -

Throws:

StorageException

AlreadyExistsException

getUser

io.apiman.manager.api.beans.idm.UserBean getUser(String userId)
                                                 throws StorageException,
                                                        DoesNotExistException

Gets a user by id.

Parameters:

userId -

Throws:

StorageException

DoesNotExistException

updateUser

void updateUser(io.apiman.manager.api.beans.idm.UserBean user)
                throws StorageException,
                       DoesNotExistException

Updates the personal information about a user.

Parameters:

user -

Throws:

StorageException

DoesNotExistException

findUsers

io.apiman.manager.api.beans.search.SearchResultsBean<io.apiman.manager.api.beans.idm.UserBean> findUsers(io.apiman.manager.api.beans.search.SearchCriteriaBean criteria)
                                                                                                         throws StorageException

Returns a list of users that match the given search criteria.

Parameters:

criteria -

Throws:

StorageException

createRole

void createRole(io.apiman.manager.api.beans.idm.RoleBean role)
                throws StorageException,
                       AlreadyExistsException

Creates a new role in the role storage system. This is typically done by a super admin of the system, to set up roles and what permissions memberhip in those roles will grant.

Parameters:

role -

Throws:

StorageException

AlreadyExistsException

getRole

io.apiman.manager.api.beans.idm.RoleBean getRole(String roleId)
                                                 throws StorageException,
                                                        DoesNotExistException

Gets a role by id.

Parameters:

roleId -

Throws:

StorageException

DoesNotExistException

updateRole

void updateRole(io.apiman.manager.api.beans.idm.RoleBean role)
                throws StorageException,
                       DoesNotExistException

Updates a single role (typically with new permissions).

Parameters:

role -

Throws:

StorageException

AlreadyExistsException

DoesNotExistException

deleteRole

void deleteRole(io.apiman.manager.api.beans.idm.RoleBean role)
                throws StorageException,
                       DoesNotExistException

Deletes a role from the system. This would also remove all memberships in that role. This should be done very infrequently!

Parameters:

role -

Throws:

StorageException

DoesNotExistException

findRoles

io.apiman.manager.api.beans.search.SearchResultsBean<io.apiman.manager.api.beans.idm.RoleBean> findRoles(io.apiman.manager.api.beans.search.SearchCriteriaBean criteria)
                                                                                                         throws StorageException

Returns a list of users that match the given search criteria.

Parameters:

criteria -

Throws:

StorageException

createMembership

void createMembership(io.apiman.manager.api.beans.idm.RoleMembershipBean membership)
                      throws StorageException,
                             AlreadyExistsException

Grants membership into a role for a user.

Parameters:

membership -

Throws:

StorageException

AlreadyExistsException

deleteMembership

void deleteMembership(String userId,
                    String roleId,
                    String organizationId)
                      throws StorageException,
                             DoesNotExistException

Deletes a single membership.

Parameters:

userId -

roleId -

organizationId -

Throws:

StorageException

DoesNotExistException

deleteMemberships

void deleteMemberships(String userId,
                     String organizationId)
                       throws StorageException

Deletes all role memberships for a user in a given organization.

Parameters:

userId -

organizationId -

Throws:

StorageException

getUserMemberships

Set<io.apiman.manager.api.beans.idm.RoleMembershipBean> getUserMemberships(String userId)
                                                                           throws StorageException

Gets all the user's memberships.

Parameters:

userId -

Throws:

StorageException

getUserMemberships

Set<io.apiman.manager.api.beans.idm.RoleMembershipBean> getUserMemberships(String userId,
                                                                         String organizationId)
                                                                           throws StorageException

Gets all the user's memberships for the given organization.

Parameters:

userId -

organizationId -

Throws:

StorageException

getOrgMemberships

Set<io.apiman.manager.api.beans.idm.RoleMembershipBean> getOrgMemberships(String organizationId)
                                                                          throws StorageException

Gets all the memberships configured for a particular organization.

Parameters:

organizationId -

Throws:

StorageException

getPermissions

Set<io.apiman.manager.api.beans.idm.PermissionBean> getPermissions(String userId)
                                                                   throws StorageException

Returns a set of permissions granted to the user due to their role memberships.

Parameters:

userId -

Throws:

StorageException