org.kuali.rice.kew.identity.service

Interface IdentityHelperService

All Known Implementing Classes:

IdentityHelperServiceImpl

public interface IdentityHelperService

A simple helper service in KEW for interacting with the KIM identity management services. Some of the methods on here exist solely for the purpose of assisting with the piece-by-piece migration of KEW to use the KIM services.

Author:

Kuali Rice Team (rice.collab@kuali.org)

Method Summary

Methods

Modifier and Type	Method and Description
Group	getGroup(GroupId groupId) Returns the Group for the given GroupId.
Group	getGroup(String groupId) Returns the Group for the given groupId.
Group	getGroupByName(String namespaceCode, String name) Returns the Group for the given namespaceCode and name.
String	getIdForGroupName(String namespace, String groupName)
String	getIdForPrincipalName(String principalName)
Person	getPerson(String principalId) Returns the Person for the given principal id.
Person	getPersonByEmployeeId(String employeeId) Returns the Person for the given employee id.
Person	getPersonByPrincipalName(String principalName) Returns the Person for the given principal name.
Principal	getPrincipal(String principalId) Returns the KimPrincipal for the given principal id.
Principal	getPrincipal(UserId userId) Returns the principal for the given UserId.
Principal	getPrincipalByPrincipalName(String principalName) Returns the KimPrincipal for the given principal name.
Recipient	getPrincipalRecipient(String principalId) Returns the Recipient for the given principalId.
Principal	getSystemPrincipal() Returns the principal for the "system user".
void	validatePrincipalId(String principalId) Checks that the given principalId is valid.

Method Detail

getIdForPrincipalName

String getIdForPrincipalName(String principalName)

getIdForGroupName

String getIdForGroupName(String namespace,
                       String groupName)

getPrincipal

Principal getPrincipal(String principalId)

Returns the KimPrincipal for the given principal id. Throws an exception if the principal id cannot be resolved to a principal.

Throws:

RiceIllegalArgumentException - if the principal id cannot be resolved to a principal.

getPrincipalByPrincipalName

Principal getPrincipalByPrincipalName(String principalName)

Returns the KimPrincipal for the given principal name. Throws an exception if the principal name cannot be resolved to a principal.

Throws:

RiceIllegalArgumentException - if the principal name cannot be resolved to a principal

getPerson

Person getPerson(String principalId)

Returns the Person for the given principal id. Throws an exception if the principal id cannot be resolved to a person.

Throws:

RiceIllegalArgumentException - if the principal id cannot be resolved to a person.

getPersonByPrincipalName

Person getPersonByPrincipalName(String principalName)

Returns the Person for the given principal name. Throws an exception if the principal name cannot be resolved to a person.

Throws:

RiceIllegalArgumentException - if the principal name cannot be resolved to a person.

getPersonByEmployeeId

Person getPersonByEmployeeId(String employeeId)

Returns the Person for the given employee id. Throws an exception if the principal name cannot be resolved to a person.

Throws:

RiceIllegalArgumentException - if the principal name cannot be resolved to a person.

validatePrincipalId

void validatePrincipalId(String principalId)

Checks that the given principalId is valid. Throws a RiceRuntimeException if it is not.

Throws:

RiceIllegalArgumentException - if the given principalId is valid

getPrincipal

Principal getPrincipal(UserId userId)

Returns the principal for the given UserId.

Throws:

RiceIllegalArgumentException - if the given UserId does not resolve to a valid principal

getGroup

Group getGroup(String groupId)

Returns the Group for the given groupId. Throws an exception if the groupId cannot be resolved to a group.

Throws:

RiceIllegalArgumentException - if the groupId cannot be resolved to a group.

getGroup

Group getGroup(GroupId groupId)

Returns the Group for the given GroupId. Throws an exception if the groupId cannot be resolved to a group.

Throws:

RiceIllegalArgumentException - if the GroupId cannot be resolved to a group.

getGroupByName

Group getGroupByName(String namespaceCode,
                   String name)

Returns the Group for the given namespaceCode and name. Throws an exception if the namespaceCode and name cannot be resolved to a group.

Throws:

RiceIllegalArgumentException - if the namespaceCode and name cannot be resolved to a group.

getPrincipalRecipient

Recipient getPrincipalRecipient(String principalId)

Returns the Recipient for the given principalId. Throws an exception if the principalId cannot be resolved to a recipient.

Throws:

RiceIllegalArgumentException - if the principalId cannot be resolved to a recipient

getSystemPrincipal

Principal getSystemPrincipal()

Returns the principal for the "system user". This is a user that can be used in the cases where an actual user cannot be determined.