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

org.kuali.rice.kim.bo.Group	getGroup(GroupId groupId)
org.kuali.rice.kim.bo.Group	getGroup(String groupId) Returns the Group for the given groupId.
org.kuali.rice.kim.bo.Group	getGroupByName(String namespaceCode, String name)
String	getIdForGroupName(String namespace, String groupName)
String	getIdForPrincipalName(String principalName)
org.kuali.rice.kim.bo.Person	getPerson(String principalId) Returns the Person for the given principal id.
org.kuali.rice.kim.bo.Person	getPersonByEmployeeId(String employeeId) Returns the Person for the given employee id.
org.kuali.rice.kim.bo.Person	getPersonByPrincipalName(String principalName) Returns the Person for the given principal name.
org.kuali.rice.kim.bo.entity.KimPrincipal	getPrincipal(String principalId) Returns the KimPrincipal for the given principal id.
org.kuali.rice.kim.bo.entity.KimPrincipal	getPrincipal(org.kuali.rice.kew.user.UserId userId)
org.kuali.rice.kim.bo.entity.KimPrincipal	getPrincipalByPrincipalName(String principalName) Returns the KimPrincipal for the given principal name.
Recipient	getPrincipalRecipient(String principalId)
org.kuali.rice.kim.bo.entity.KimPrincipal	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

org.kuali.rice.kim.bo.entity.KimPrincipal getPrincipal(String principalId)

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

getPrincipalByPrincipalName

org.kuali.rice.kim.bo.entity.KimPrincipal getPrincipalByPrincipalName(String principalName)

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

getPerson

org.kuali.rice.kim.bo.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.

getPersonByPrincipalName

org.kuali.rice.kim.bo.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.

getPersonByEmployeeId

org.kuali.rice.kim.bo.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.

validatePrincipalId

void validatePrincipalId(String principalId)

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

getPrincipal

org.kuali.rice.kim.bo.entity.KimPrincipal getPrincipal(org.kuali.rice.kew.user.UserId userId)

getGroup

org.kuali.rice.kim.bo.Group getGroup(String groupId)

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

getGroup

org.kuali.rice.kim.bo.Group getGroup(GroupId groupId)

getGroupByName

org.kuali.rice.kim.bo.Group getGroupByName(String namespaceCode,
                                           String name)

getPrincipalRecipient

Recipient getPrincipalRecipient(String principalId)

getSystemPrincipal

org.kuali.rice.kim.bo.entity.KimPrincipal 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.