Package oracle.tip.pc.services.identity

Interface BPMProvider

public interface BPMProvider

BPMProvider defines Identity Service Provider Interface

Method Summary

Modifier and Type	Method	Description
void	authenticateUser(String name, String password)	Authenticates the user in the system.
PermissionCollection	getAllPermissions()	Gets all the permissions associated with all the Applications
PermissionCollection	getAllPermissions(String appName)	Gets all the permissions associated with the Application
String	getDefaultRealmName()	Gets the default realm name
Set	getGrantedRoles(BPMPrincipal principal, boolean direct)	Gets granted roles to principal
Set	getGrantedRoles(BPMPrincipal bpmPrincipal, boolean direct, String appName)	Gets granted roles to principal for a given application
Set	getGrantees(String roleName, boolean direct)	Gets all grantee for given group/role name
Set<BPMIdentity>	getGranteesToAppRole(String appRole, String appName, boolean direct, Set roleChain)	Gets all grantees for given application role
String	getKeyStoreType(String policyStoreTypeProperty)
List<String>	getLocaleSpecificGroupNames(List<String> groupNames, Locale locale)	Gets locale specific names of the groups
List<String>	getLocaleSpecificUserNames(List<String> usersNames, Locale locale)	Gets locale specific names of the users
Map<String,Map<Locale,String>>	getLocalizedGroupNames(List<String> groupsNames, List<Locale> locales)	Gets map of localized user's display name for given local list
Map<String,Map<Locale,String>>	getLocalizedUserNames(List<String> usersNames, List<Locale> locales)	Gets map of localized user's display name for given local list
List<BPMRole>	getManagedRoles(BPMIdentity id, boolean direct)	Gets a list of managed roles for an identity
String	getNameAttribute(String entityName)
Map	getObjectAttributes(BPMPrincipal pr)	Get object Attributes return map - an attribute map containing the attributes of the object.
Set	getOwnedRoles(BPMPrincipal principal, boolean direct)	Get roles owned by BPMPrincipal
Set	getOwners(BPMRole role, boolean direct)	Gets users who own given role
PermissionCollection	getPermissions(BPMIdentity identity)	Gets the permissions associated with an identity
PermissionCollection	getPermissions(BPMIdentity identity, String appName)	Gets the permissions associated with an identity for a given application
String	getPolicyStoreType()
String	getProviderAttributeName(Class classifier, String attrName)	Gets provider attribute name.
ProviderCfg	getProviderCfg()	Gets provider config associated with this provider.
String	getRealmName()	Gets the active realm name
List<BPMIdentity>	getRoleManagers(BPMRole role, boolean direct)	Gets a list of managers for a group.
List	getRoles(RoleClassifier roleType)	Gets Roles of the specified type.
List<String>	getSearchableUserAttributes()	Gets the list of user attribute names that are searchable
long	getTenantGUID(String tenantname)	Gets tenant id from tenantname
String	getTenantName(String tenantGUID)	Gets tenant name from tenantid
List	getUsers()	Gets all users
boolean	hasPermission(BPMIdentity identity, Permission perm, String appName)	Check if identity Has permission
boolean	isAPPIDUser(String username)
BPMAppRole	lookupAppRole(String appRoleName, String appName)	Looks up BPMGroup in specified realm by role name
BPMGroup	lookupGroup(String name)	Looks up BPMGroup in specified realm by role name
BPMRole	lookupRole(String name)	Looks up BPMRole in specified realm by role name
BPMUser	lookupUser(String name)	Looks up BPMUser in the scpecified logical realm using the given user name
BPMRole	populateDetails(BPMRole role)	Loads BPMRole Details.
BPMUser	populateDetails(BPMUser user)	Loads BPMUser Details
List	searchRoles(RoleClassifier classifier, String attrName, String attrValue)	Searches BPMRole based on teh classifier and attribute name-value pair.
List	searchRoles(RoleClassifier classifier, SearchFilter filter)	Searches BPMRole based on the classifier and search filter.
List	searchUsers(String attrName, String attrValue)	Searches BPMUsers with the given attribute name and value pair.
List	searchUsers(SearchFilter filter)	Searches BPMUsers based on the criteria specified in teh search filter.

Method Details

getProviderCfg

ProviderCfg getProviderCfg()

Gets provider config associated with this provider.

Returns:

config

getDefaultRealmName

String getDefaultRealmName()
                    throws BPMIdentityException

Gets the default realm name

Returns:

default realm name

Throws:

BPMIdentityException - If exception condition occurs.

getRealmName

String getRealmName()

Gets the active realm name

Returns:

realm name

Throws:

BPMIdentityException - If exception condition occurs.

lookupUser

BPMUser lookupUser(String name)
            throws BPMIdentityException,
BPMIdentityNotFoundException

Looks up BPMUser in the scpecified logical realm using the given user name

Parameters:

name - user name

Throws:

BPMIdentityException - If exception condition occurs.

BPMIdentityNotFoundException - If user is not found

lookupGroup

BPMGroup lookupGroup(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 exception condition occurs.

lookupAppRole

BPMAppRole lookupAppRole(String appRoleName,
 String appName)
                  throws BPMIdentityException,
BPMIdentityNotFoundException

Looks up BPMGroup in specified realm by role name

Parameters:

appRoleName - application role name

appName - application name

Throws:

BPMIdentityNotFoundException - If application role is not found

BPMIdentityException - If exception condition occurs.

lookupRole

BPMRole lookupRole(String name)
            throws BPMIdentityException,
BPMIdentityNotFoundException

Looks up BPMRole in specified realm by role name

Parameters:

name - a role name

Throws:

BPMIdentityNotFoundException - If role is not found

BPMIdentityException - If exception condition occurs.

getUsers

List getUsers()
       throws BPMIdentityException

Gets all users

Throws:

BPMIdentityException - If exception condition occurs.

getLocaleSpecificUserNames

List<String> getLocaleSpecificUserNames(List<String> usersNames,
 Locale locale)
                                 throws BPMIdentityException,
BPMIdentityNotFoundException

Gets locale specific names of the users

Parameters:

userNames - List of userNames

Locale -

Returns:

List of localeNames For each entry in the input list (userNames) the corresponding localeName is returned in the same position in the ouput list. In case a non-exisiting username(s) is/are provided in the input, null will be returned as the localized name for that/those user(s).

Throws:

BPMIdentityNotFoundException - If user is not found

BPMIdentityException - If exception condition occurs.

getLocalizedUserNames

Map<String,Map<Locale,String>> getLocalizedUserNames(List<String> usersNames,
 List<Locale> locales)
                                              throws BPMIdentityException

Gets map of localized user's display name for given local list

Parameters:

usersNames - List of userNames

locales - List of Locale

Returns:

Map of user's display name for given local list

Throws:

BPMIdentityNotFoundException

BPMIdentityException

getLocaleSpecificGroupNames

List<String> getLocaleSpecificGroupNames(List<String> groupNames,
 Locale locale)
                                  throws BPMIdentityException,
BPMIdentityNotFoundException

Gets locale specific names of the groups

Parameters:

userNames - List of groupNames

Locale -

Returns:

List of localeNames For each entry in the input list (groupNamess) the corresponding localeName is returned in the same position in the ouput list. In case a non-exisiting groupname(s) is/are provided in the input, null will be returned as the localized name for that/those group(s).

Throws:

BPMIdentityNotFoundException - If group is not found

BPMIdentityException - If exception condition occurs.

getLocalizedGroupNames

Map<String,Map<Locale,String>> getLocalizedGroupNames(List<String> groupsNames,
 List<Locale> locales)
                                               throws BPMIdentityException

Gets map of localized user's display name for given local list

Parameters:

groupsNames - List of userNames

locales - List of Locale

Returns:

Map of user's display name for given local list

Throws:

BPMIdentityNotFoundException

BPMIdentityException

getRoles

List getRoles(RoleClassifier roleType)
       throws BPMIdentityException

Gets Roles of the specified type.

Parameters:

roleType - a role classifier

Throws:

BPMIdentityException - If exception condition occurs.

getGrantedRoles

Set getGrantedRoles(BPMPrincipal principal,
 boolean direct)
             throws BPMIdentityException

Gets granted roles to principal

Parameters:

principal - a BPMPrincipal object

direct - a boolean flag. if true return direct granted role, else all

Returns:

Set of BPMRole objects

Throws:

BPMIdentityException - If exception condition occurs.

getGrantedRoles

Set getGrantedRoles(BPMPrincipal bpmPrincipal,
 boolean direct,
 String appName)
             throws BPMIdentityException

Gets granted roles to principal for a given application

Parameters:

principal - a BPMPrincipal object

direct - a boolean flag. if true return direct granted role, else all

appName - a String, the name of the application

Returns:

Set of BPMRole objects

Throws:

BPMIdentityException - If exception condition occurs.

getGrantees

Set getGrantees(String roleName,
 boolean direct)
         throws BPMIdentityException,
BPMIdentityNotFoundException

Gets all grantee for given group/role name

Parameters:

roleName - a role name

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

Returns:

Set of BPMUser objects for given group/role name

Throws:

BPMIdentityException - If exception condition occurs.

BPMIdentityNotFoundException

searchUsers

List searchUsers(String attrName,
 String attrValue)
          throws BPMIdentityException,
BPMUnsupportedAttributeException

Searches BPMUsers with the given attribute name and value pair.

Parameters:

attrName -

attrValue -

Returns:

List of BPMUser found according to search criteria

Throws:

BPMIdentityException - If exception condition occurs.

BPMUnsupportedAttributeException

searchUsers

List searchUsers(SearchFilter filter)
          throws BPMIdentityException,
BPMUnsupportedAttributeException

Searches BPMUsers based on the criteria specified in teh search filter.

Parameters:

filter - a SearchFilter instance.

Returns:

List of BPMUser found according to search criteria

Throws:

BPMIdentityException - If exception condition occurs.

BPMUnsupportedAttributeException

searchRoles

List searchRoles(RoleClassifier classifier,
 String attrName,
 String attrValue)
          throws BPMIdentityException,
BPMUnsupportedAttributeException

Searches BPMRole based on teh classifier and attribute name-value pair.

Parameters:

classifier - RoleClassifier

attrName -

attrValue -

Returns:

List of BPMRole found according to search criteria

Throws:

BPMIdentityException - If exception condition occurs.

BPMUnsupportedAttributeException

searchRoles

List searchRoles(RoleClassifier classifier,
 SearchFilter filter)
          throws BPMIdentityException,
BPMUnsupportedAttributeException

Searches BPMRole based on the classifier and search filter.

Parameters:

classifier - RoleClassifier

filter - a SearchFilter

Returns:

List of BPMRole found according to search criteria

Throws:

BPMIdentityException - If exception condition occurs.

BPMUnsupportedAttributeException

populateDetails

BPMRole populateDetails(BPMRole role)
                 throws BPMIdentityException,
BPMIdentityNotFoundException

Loads BPMRole Details. These include the various attributes.

Returns:

BPMRole object

Throws:

BPMIdentityException - If exception condition occurs.

BPMIdentityNotFoundException - If role is not found

populateDetails

BPMUser populateDetails(BPMUser user)
                 throws BPMIdentityException,
BPMIdentityNotFoundException

Loads BPMUser Details

Parameters:

user - a BPMUser to populate

Returns:

BPMUser object

Throws:

BPMIdentityException - If exception condition occurs.

BPMIdentityNotFoundException - if role is not found

getOwnedRoles

Set getOwnedRoles(BPMPrincipal principal,
 boolean direct)
           throws BPMIdentityException

Get roles owned by BPMPrincipal

Parameters:

principal - The owner principal.

direct - a boolean flag. If true method returns only directly owned roles.

Returns:

a set groups.

Throws:

BPMIdentityException

getOwners

Set getOwners(BPMRole role,
 boolean direct)
       throws BPMIdentityException

Gets users who own given role

Parameters:

role - The role whose owners are to be found

direct - a boolean flag, if true only direct owners are returned, else all

Returns:

set of BPMUser objects

Throws:

BPMIdentityException - If exception condition occurs.

getRoleManagers

List<BPMIdentity> getRoleManagers(BPMRole role,
 boolean direct)
                           throws BPMIdentityException

Gets a list of managers for a group.

Parameters:

role - The role for which the managers are to be fetched

direct - a boolean flag, if true only direct managers are returned, else all

Returns:

A list of BPMIdentity

Throws:

BPMIdentityException

getManagedRoles

List<BPMRole> getManagedRoles(BPMIdentity id,
 boolean direct)
                       throws BPMIdentityException

Gets a list of managed roles for an identity

Parameters:

id - The identity for which managed roles are to be fetched

direct - a boolean flag, if true only direct managed roles are returned, else all

Returns:

A list of BPMRole

Throws:

BPMIdentityException

getObjectAttributes

Map getObjectAttributes(BPMPrincipal pr)
                 throws BPMIdentityException

Get object Attributes return map - an attribute map containing the attributes of the object.

Throws:

BPMIdentityException

authenticateUser

void authenticateUser(String name,
 String password)
               throws BPMIdentityException,
BPMAuthenticationException

Authenticates the user in the system.

Parameters:

name - The name of the user to be authenticated.

password - The password of the user to be authenticated.

Throws:

BPMIdentityException - If exception condition occurs.

BPMAuthenticationException - If the user could not be authenticated or if an exception condition occured during authentication.

getProviderAttributeName

String getProviderAttributeName(Class classifier,
 String attrName)

Gets provider attribute name. Provider has to map provider specifc attribute names to Identity Service attribute name for all pre-defined attributes

Parameters:

classifier -

attrName -

Returns:

hasPermission

boolean hasPermission(BPMIdentity identity,
 Permission perm,
 String appName)
               throws BPMIdentityException

Check if identity Has permission

Parameters:

identity - the identity

perm - The permission

appName - Name of the application

Returns:

a boolean value

Throws:

BPMIdentityException - if an exception condition occured

getPermissions

PermissionCollection getPermissions(BPMIdentity identity)
                             throws BPMIdentityException

Gets the permissions associated with an identity

Parameters:

identity - the identity

Returns:

a PermissionCollection

Throws:

BPMIdentityException - if an exception condition occured

getPermissions

PermissionCollection getPermissions(BPMIdentity identity,
 String appName)
                             throws BPMIdentityException

Gets the permissions associated with an identity for a given application

Parameters:

identity - the identity

appName - Name of the application

Returns:

a PermissionCollection

Throws:

BPMIdentityException - if an exception condition occured

getAllPermissions

PermissionCollection getAllPermissions()
                                throws BPMIdentityException

Gets all the permissions associated with all the Applications

Returns:

PermissionCollection

Throws:

BPMIdentityException - if an exception condition occured

getAllPermissions

PermissionCollection getAllPermissions(String appName)
                                throws BPMIdentityException

Gets all the permissions associated with the Application

Parameters:

appName - Name of the application

Returns:

PermissionCollection

Throws:

BPMIdentityException - if an exception condition occured

getTenantName

String getTenantName(String tenantGUID)
              throws BPMIdentityException

Gets tenant name from tenantid

Throws:

BPMIdentityException

getSearchableUserAttributes

List<String> getSearchableUserAttributes()
                                  throws BPMIdentityException

Gets the list of user attribute names that are searchable

Returns:

list of attribute names

Throws:

BPMIdentityException - if an exception condition occured

getTenantGUID

long getTenantGUID(String tenantname)
            throws BPMIdentityException

Gets tenant id from tenantname

Throws:

BPMIdentityException

isAPPIDUser

boolean isAPPIDUser(String username)
             throws BPMIdentityException

Throws:

BPMIdentityException

getGranteesToAppRole

Set<BPMIdentity> getGranteesToAppRole(String appRole,
 String appName,
 boolean direct,
 Set roleChain)
                               throws BPMIdentityException,
BPMIdentityNotFoundException

Gets all grantees for given application role

Parameters:

appRole - The name of application role

appName - an application name

direct - a boolean flag. The method returns direct grantees if direct flag is true, else all

roleChain - an role chain

Returns:

Set of BPMIdentity objects

Throws:

BPMIdentityException - If exception condition occurs

BPMIdentityNotFoundException

Since:

11

getPolicyStoreType

String getPolicyStoreType()
                   throws BPMIdentityException

Throws:

BPMIdentityException

getKeyStoreType

String getKeyStoreType(String policyStoreTypeProperty)
                throws BPMIdentityException

Throws:

BPMIdentityException

getNameAttribute

String getNameAttribute(String entityName)
                 throws BPMIdentityException

Throws:

BPMIdentityException