oracle.tip.pc.services.identity
Class RemoteIdentityService

java.lang.Object
oracle.tip.pc.services.identity.LocalIdentityService
oracle.tip.pc.services.identity.RemoteIdentityService

All Implemented Interfaces:

oracle.tip.pc.services.common.Service

public class RemoteIdentityService

extends LocalIdentityService

RemoteIdentityService is an Identity Service. It provides set of APIs to lookup and search users and groups in repository(OID or XML file), service to check whether the user or group has defined role, gets all derects reportees for given user and members of group.

Constructor Summary

RemoteIdentityService()
Default Constructor

Method Summary

boolean	authenticateUser(java.lang.String userName, java.lang.String passwd) Authenticates User
Group[]	getAllGroups() Gets all groups in default realm
User[]	getAllUsers() Gets all users in default realm
User[]	getDirectReportees(java.lang.String managerName) Get direct reportees
java.lang.String[]	getManagement(java.lang.String userName, java.lang.String uptoUserName, java.lang.String uptoTitle, int level) Gets array of management name for given user
User[]	getParticipants(java.lang.String groupName, boolean direct) Get participants for given group/role
boolean	isUserInRole(java.lang.String userName, java.lang.String roleName) Defines whether user has the specifed role
Group	lookupGroup(java.lang.String groupName) Look up BPMGroup in scpecified realm by group name
User	lookupUser(java.lang.String userName) Looks up User in scpecified realm by role name
Group[]	searchGroups(java.lang.String attributeName, java.lang.String searchString) Searches groups having the searchString in the specified attributeName
User[]	searchUsers(java.lang.String attributeName, java.lang.String searchString) Searches users having the searchString in the specified attributeName

Methods inherited from class oracle.tip.pc.services.identity.LocalIdentityService

getManagementChain, getManagementChain, getManager, getStatus

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RemoteIdentityService

public RemoteIdentityService()

Default Constructor

Method Detail

lookupUser

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

Looks up User in scpecified realm by role name

Parameters:

userName - an user name

Throws:

BPMIdentityException

BPMIdentityNotFoundException

lookupGroup

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

Look up BPMGroup in scpecified realm by group name

Parameters:

groupName - a group name

Throws:

BPMIdentityException

BPMIdentityNotFoundException

getAllUsers

public User[] getAllUsers()
                   throws BPMIdentityException,
                          BPMIdentityNotFoundException

Gets all users in default realm

Throws:

BPMIdentityException

BPMIdentityNotFoundException

getAllGroups

public Group[] getAllGroups()
                     throws BPMIdentityException,
                            BPMIdentityNotFoundException

Gets all groups in default realm

Throws:

BPMIdentityException

BPMIdentityNotFoundException

searchUsers

public User[] searchUsers(java.lang.String attributeName,
                          java.lang.String searchString)
                   throws BPMIdentityException,
                          BPMUnsupportedAttributeException

Searches users having the searchString in the specified attributeName

Parameters:

attributeName - an attribute to the search

searchString - a string to the search

Returns:

array of Users objects

Throws:

BPMIdentityException

BPMUnsupportedAttributeException

searchGroups

public Group[] searchGroups(java.lang.String attributeName,
                            java.lang.String searchString)
                     throws BPMIdentityException,
                            BPMUnsupportedAttributeException

Searches groups having the searchString in the specified attributeName

Parameters:

attributeName - an attribute to the search

searchString - a string to the search

Returns:

array of group objects

Throws:

BPMIdentityException

BPMUnsupportedAttributeException

getDirectReportees

public User[] getDirectReportees(java.lang.String managerName)
                          throws BPMIdentityException,
                                 BPMIdentityNotFoundException

Get direct reportees

Parameters:

managerName - a manager name

Returns:

array of Users objects for given namagerName

Throws:

BPMIdentityException

BPMIdentityNotFoundException

getParticipants

public User[] getParticipants(java.lang.String groupName,
                              boolean direct)
                       throws BPMIdentityNotFoundException,
                              BPMIdentityException

Get participants for given group/role

Parameters:

groupName - a group/role name

direct - a boolean flag. If true method returns direct user participants, else all user participarts for given group/role name

Returns:

array of Users objects for given group/role name

Throws:

BPMIdentityNotFoundException

BPMIdentityException

authenticateUser

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

Authenticates User

Returns:

true if user authenticated

Throws:

BPMAuthenticationException

BPMIdentityException

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:

BPMIdentityException

BPMIdentityNotFoundException

getManagement

public java.lang.String[] getManagement(java.lang.String userName,
                                        java.lang.String uptoUserName,
                                        java.lang.String uptoTitle,
                                        int level)
                                 throws BPMIdentityNotFoundException,
                                        BPMIdentityException

Gets array of management name for given user

Parameters:

userName - a user name

uptoUserName - a search constraint to chain managers up to user name

uptoTitle - a search constraint to chain managers up to title

level - a management level

Returns:

ManagementChain object

Throws:

BPMIdentityNotFoundException - if user not found

BPMIdentityException - if error occurs