oracle.tip.pc.services.identity
Interface BPMIdentityService

All Superinterfaces:

oracle.tip.pc.services.common.Service

public interface BPMIdentityService

extends oracle.tip.pc.services.common.Service

BPMIdentityService defines BPEL Process Manager Identity Service

Method Summary

void	authenticateUser(java.lang.String userName, java.lang.String passwd) Authenticates user
java.util.List	getAppRoles() Gets Application roles
java.lang.String	getDefaultRealmName() Gets default realm name
java.util.List	getDirectReportees(java.lang.String managerName) Gets direct reportees
java.util.List	getGroups() Get Enterprise Role, Groups in the specified realm
java.util.List	getParticipants(java.lang.String name, boolean direct) Gets participants for given group/role name
java.util.List	getRoles(RoleClassifier roleType) Gets Roles
java.util.List	getUsers() Gets all users
boolean	isUserInRole(java.lang.String userName, java.lang.String roleName) Defines whether User has the specifed role
BPMGroup	lookupGroup(java.lang.String groupName) Looks up BPMGroup in scpecified realm by group name
BPMRole	lookupRole(java.lang.String roleName) Looks up BPMRole in scpecified realm by role name
BPMUser	lookupUser(java.lang.String userName) Looks up BPMUser in scpecified realm by user name
java.util.List	searchGroups(java.lang.String attributeName, java.lang.String searchFilter) Searches groups which have given searchString in the specified attributeName
java.util.List	searchUsers(java.lang.String attributeName, java.lang.String searchFilter) Searches users which have given searchString in the specified attributeName
BPMUser	whoAmI(javax.servlet.http.HttpServletRequest request) Who am I

Methods inherited from interface oracle.tip.pc.services.common.Service

getStatus

Method Detail

lookupRole

public BPMRole lookupRole(java.lang.String roleName)
                   throws BPMIdentityException,
                          BPMIdentityNotFoundException

Looks up BPMRole in scpecified realm by role name

Parameters:

roleName - a role name

Throws:

BPMIdentityNotFoundException - if role is not found

BPMIdentityException - if error occurs

lookupUser

public BPMUser lookupUser(java.lang.String userName)
                   throws BPMIdentityException,
                          BPMIdentityNotFoundException

Looks up BPMUser in scpecified realm by user name

Parameters:

userName - a user name

Throws:

BPMIdentityNotFoundException - if role is not found

BPMIdentityException - if error occurs

searchUsers

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

Searches users which have given searchString in the specified attributeName

Parameters:

attributeName - an attribute to apply the search

searchFilter - a search filter

Returns:

List of BPMUser objects

Throws:

BPMUnsupportedAttributeException - if attribute is unsupported

BPMIdentityException

lookupGroup

public BPMGroup lookupGroup(java.lang.String groupName)
                     throws BPMIdentityException,
                            BPMIdentityNotFoundException

Looks up BPMGroup in scpecified realm by group name

Parameters:

groupName - a group name

Throws:

BPMIdentityNotFoundException - if role is not found

BPMIdentityException - if error occurs

searchGroups

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

Searches groups which have given searchString in the specified attributeName

Parameters:

attributeName - an attribute to the search

searchFilter - a search filter

Returns:

List of BPMGroup objects

Throws:

BPMUnsupportedAttributeException - if attribute is unsupported

BPMIdentityException - if error occurs

getUsers

public java.util.List getUsers()
                        throws BPMIdentityException

Gets all users

Throws:

BPMIdentityException - if error occurs

getGroups

public java.util.List getGroups()
                         throws BPMIdentityException

Get Enterprise Role, Groups in the specified realm

Throws:

BPMIdentityException - if error occurs

getRoles

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

Gets Roles

Parameters:

roleType - a role classifier

Throws:

BPMIdentityException - if error occurs

getAppRoles

public java.util.List getAppRoles()
                           throws BPMIdentityException

Gets Application roles

Throws:

BPMIdentityException - if error occurs

getParticipants

public java.util.List getParticipants(java.lang.String name,
                                      boolean direct)
                               throws BPMIdentityException,
                                      BPMIdentityNotFoundException

Gets participants for given group/role name

Parameters:

name - a group/role name

direct - a boolean flag. If true method return direct participans, elase all.

Returns:

List of BPMUser objects for given group/role name

Throws:

BPMIdentityNotFoundException - if group/role is not found

BPMIdentityException - if error occurs

getDirectReportees

public java.util.List getDirectReportees(java.lang.String managerName)
                                  throws BPMIdentityException,
                                         BPMIdentityNotFoundException

Gets direct reportees

Parameters:

managerName - a manager name

Returns:

List of BPMUsers objects for given managerName

Throws:

BPMIdentityNotFoundException - if manager is not found

BPMIdentityException - if error occurs

whoAmI

public BPMUser whoAmI(javax.servlet.http.HttpServletRequest request)
               throws BPMIdentityException,
                      BPMIdentityNotFoundException

Who am I

Parameters:

request - a HttpServletRequest object

Returns:

BPMUser object

Throws:

BPMIdentityNotFoundException - if object is not found

BPMIdentityException - if error occurs

authenticateUser

public void authenticateUser(java.lang.String userName,
                             java.lang.String passwd)
                      throws BPMAuthenticationException,
                             BPMIdentityException

Authenticates user

Parameters:

userName - user name

passwd - user password

Throws:

BPMAuthenticationException - if user not authenticated

BPMIdentityException - if error occurs

isUserInRole

public boolean isUserInRole(java.lang.String userName,
                            java.lang.String roleName)
                     throws BPMIdentityException,
                            BPMIdentityNotFoundException

Defines whether User has the specifed role

Parameters:

userName - is a user name

roleName - is a role name

Returns:

boolean true if user in role, else false

Throws:

BPMIdentityNotFoundException - if object is not found

BPMIdentityException - if error occurs

getDefaultRealmName

public java.lang.String getDefaultRealmName()

Gets default realm name

Returns:

dafault realm name