oracle.tip.pc.services.identity
Interface BPMProvider

public interface BPMProvider

BPMProvider defines Identity Service Provider Interface

Method Summary

void	authenticateUser(java.lang.String name, java.lang.String password) Authenticates user
java.lang.String	getDefaultRealmName() Gets default realm name
BPMGroup	getGroup(java.lang.String name) Looks up BPMGroup in specified realm by role name
java.util.List	getGroupParticipants(java.lang.String roleName, RoleClassifier roleType, boolean direct) Gets all the role participants for given group/role name
BPMRole	getRole(java.lang.String name) Looks up BPMRole in specified realm by role name
java.util.List	getRoles(RoleClassifier classifier) Gets Roles
BPMUser	getUser(java.lang.String name) Looks up BPMUser in scpecified realm by user name
java.util.List	getUserParticipants(java.lang.String roleName, boolean direct) Gets all the user participants for given group/role name
java.util.Set	getUserRoles(java.lang.String userName, boolean direct) Gets all the roles granted for given user
java.util.List	getUsers() Gets all users
BPMRole	populateRoleDetails(BPMRole role) Populate BPMRole Details
BPMUser	populateUserDetails(BPMUser user) Populate BPMUser Details
java.util.List	searchGroups(java.lang.String attrName, java.lang.String searchFilter) Searches BPMGroups
java.util.List	searchUsers(java.lang.String attrName, java.lang.String searchFilter) Searches BPMUsers

Method Detail

getDefaultRealmName

public java.lang.String getDefaultRealmName()

Gets default realm name

Returns:

default realm name

getUser

public BPMUser getUser(java.lang.String name)
                throws BPMIdentityException,
                       BPMIdentityNotFoundException

Looks up BPMUser in scpecified realm by user name

Parameters:

name - user name

Throws:

BPMIdentityException - if error occurs

BPMIdentityNotFoundException - if user is not found

getGroup

public BPMGroup getGroup(java.lang.String name)
                  throws BPMIdentityException,
                         BPMIdentityNotFoundException

Looks up BPMGroup in specified realm by role name

Parameters:

name - group name

Throws:

BPMIdentityNotFoundException - if group is not found

BPMIdentityException - if error occurs

getRole

public BPMRole getRole(java.lang.String name)
                throws BPMIdentityException,
                       BPMIdentityNotFoundException

Looks up BPMRole in specified realm by role name

Throws:

BPMIdentityNotFoundException - if role is not found

BPMIdentityException - if error occurs

getUsers

public java.util.List getUsers()
                        throws BPMIdentityException

Gets all users

Throws:

BPMIdentityException - if error occurs

getRoles

public java.util.List getRoles(RoleClassifier classifier)
                        throws BPMIdentityException

Gets Roles

Throws:

BPMIdentityException - if error occurs

authenticateUser

public void authenticateUser(java.lang.String name,
                             java.lang.String password)
                      throws BPMIdentityException,
                             BPMAuthenticationException

Authenticates user

Throws:

BPMAuthenticationException - if user not authenticated

BPMIdentityException - if error occurs

getUserRoles

public java.util.Set getUserRoles(java.lang.String userName,
                                  boolean direct)
                           throws BPMIdentityException,
                                  BPMIdentityNotFoundException

Gets all the roles granted for given user

Parameters:

direct - a boolean flag. If true method returns only roles directly granted to user, else all.

Returns:

List of BPMRole objects for given username

Throws:

BPMIdentityException - if error occurs

BPMIdentityNotFoundException

getUserParticipants

public java.util.List getUserParticipants(java.lang.String roleName,
                                          boolean direct)
                                   throws BPMIdentityException,
                                          BPMIdentityNotFoundException

Gets all the user participants for given group/role name

Parameters:

direct - a boolean flag. If true method returns only direct participans, else all.

Returns:

List of BPMUser objects for given group/role name

Throws:

BPMIdentityException - if error occurs

BPMIdentityNotFoundException

getGroupParticipants

public java.util.List getGroupParticipants(java.lang.String roleName,
                                           RoleClassifier roleType,
                                           boolean direct)
                                    throws BPMIdentityException,
                                           BPMIdentityNotFoundException

Gets all the role participants for given group/role name

Parameters:

roleType - APPROLE/ENTERPRISEROLE/BOTH.

direct - a boolean flag. If true method returns only direct participans, else all.

Returns:

List of BPMRole objects for given group/role name

Throws:

BPMIdentityException - if error occurs

BPMIdentityNotFoundException

searchUsers

public java.util.List searchUsers(java.lang.String attrName,
                                  java.lang.String searchFilter)
                           throws BPMIdentityException,
                                  BPMUnsupportedAttributeException

Searches BPMUsers

Returns:

List of BPMUser found according to search criteria

Throws:

BPMIdentityException

BPMUnsupportedAttributeException

searchGroups

public java.util.List searchGroups(java.lang.String attrName,
                                   java.lang.String searchFilter)
                            throws BPMIdentityException,
                                   BPMUnsupportedAttributeException

Searches BPMGroups

Returns:

List of BPMGroup found according to search criteria

Throws:

BPMIdentityException

BPMUnsupportedAttributeException

populateRoleDetails

public BPMRole populateRoleDetails(BPMRole role)
                            throws BPMIdentityException,
                                   BPMIdentityNotFoundException

Populate BPMRole Details

Returns:

BPMRole object

Throws:

BPMIdentityException - if error occurs

BPMIdentityNotFoundException - if role is noit found

populateUserDetails

public BPMUser populateUserDetails(BPMUser user)
                            throws BPMIdentityException,
                                   BPMIdentityNotFoundException

Populate BPMUser Details

Parameters:

user - a BPMUser to populate

Returns:

BPMUser object

Throws:

BPMIdentityException - if error occurs

BPMIdentityNotFoundException - if role is noit found