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.
io.apiman.manager.api.beans.idm.RoleMembershipBean	getMembership(String userId, String roleId, String organizationId) Returns a single membership or null if one does not exist.
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

Creates a user in the IDM system.

Parameters:

user - the user

Throws:

StorageException - if an exception occurs during storage attempt

getUser

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

Gets a user by id.

Parameters:

userId - user's id

Returns:

the user

Throws:

StorageException - if an exception occurs during storage attempt

updateUser

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

Updates the personal information about a user.

Parameters:

user - the user

Throws:

StorageException - if an exception occurs during storage attempt

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 - search criteria

Returns:

found users

Throws:

StorageException - if an exception occurs during storage attempt

createRole

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

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 - the role

Throws:

StorageException - if an exception occurs during storage attempt

getRole

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

Gets a role by id.

Parameters:

roleId - the role id

Returns:

the role

Throws:

StorageException - if an exception occurs during storage attempt

updateRole

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

Updates a single role (typically with new permissions).

Parameters:

role - the role

Throws:

StorageException - if an exception occurs during storage attempt

deleteRole

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

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

Parameters:

role - the role

Throws:

StorageException - if an exception occurs during storage attempt

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 - search criteria

Returns:

the found roles

Throws:

StorageException - if an exception occurs during storage attempt

createMembership

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

Grants membership into a role for a user.

Parameters:

membership - the membership

Throws:

StorageException - if an exception occurs during storage attempt

getMembership

io.apiman.manager.api.beans.idm.RoleMembershipBean getMembership(String userId,
                                                               String roleId,
                                                               String organizationId)
                                                                 throws StorageException

Returns a single membership or null if one does not exist.

Parameters:

userId - the user id

roleId - the role id

organizationId - the organization id

Returns:

the membership

Throws:

StorageException - if an exception occurs during storage attempt

deleteMembership

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

Deletes a single membership.

Parameters:

userId - the user's id

roleId - the role's id

organizationId - the organization's id

Throws:

StorageException - if an exception occurs during storage attempt

deleteMemberships

void deleteMemberships(String userId,
                     String organizationId)
                       throws StorageException

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

Parameters:

userId - the user's id

organizationId - the organization's id

Throws:

StorageException - if an exception occurs during storage attempt

getUserMemberships

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

Gets all the user's memberships.

Parameters:

userId - the user's id

Returns:

set of memberships

Throws:

StorageException - if an exception occurs during storage attempt

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 - the user's id

organizationId - the organization's id

Returns:

set of memberships

Throws:

StorageException - if an exception occurs during storage attempt

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 - the organization's id

Returns:

set of memberships

Throws:

StorageException - if an exception occurs during storage attempt

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 - the user's id

Returns:

set of permissions

Throws:

StorageException - if an exception occurs during storage attempt