|
Oracle Fusion Middleware Java API Reference for Oracle BPM Suite 11g Release 1 (11.1.1.6.3) E25378-06 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface BPMProvider
BPMProvider
defines Identity Service Provider Interface
Method Summary | |
---|---|
void |
authenticateUser(java.lang.String name, java.lang.String password) Authenticates the user in the system. |
java.security.PermissionCollection |
getAllPermissions() Gets all the permissions associated with all the Applications |
java.security.PermissionCollection |
getAllPermissions(java.lang.String appName) Gets all the permissions associated with the Application |
java.lang.String |
getDefaultRealmName() Gets the default realm name |
java.util.Set |
getGrantedRoles(BPMPrincipal principal, boolean direct) Gets granted roles to principal |
java.util.Set |
getGrantedRoles(BPMPrincipal bpmPrincipal, boolean direct, java.lang.String appName) Gets granted roles to principal for a given application |
java.util.Set |
getGrantees(java.lang.String roleName, boolean direct) Gets all grantee for given group/role name |
java.util.List<java.lang.String> |
getLocaleSpecificGroupNames(java.util.List<java.lang.String> groupNames, java.util.Locale locale) Gets locale specific names of the groups |
java.util.List<java.lang.String> |
getLocaleSpecificUserNames(java.util.List<java.lang.String> usersNames, java.util.Locale locale) Gets locale specific names of the users |
java.util.List<BPMRole> |
getManagedRoles(BPMIdentity id, boolean direct) Gets a list of managed roles for an identity |
java.util.Map |
getObjectAttributes(BPMPrincipal pr) Get object Attributes return map - an attribute map containing the attributes of the object. |
java.util.Set |
getOwnedRoles(BPMPrincipal principal, boolean direct) Get roles owned by BPMPrincipal |
java.util.Set |
getOwners(BPMRole role, boolean direct) Gets users who own given role |
java.security.PermissionCollection |
getPermissions(BPMIdentity identity) Gets the permissions associated with an identity |
java.security.PermissionCollection |
getPermissions(BPMIdentity identity, java.lang.String appName) Gets the permissions associated with an identity for a given application |
java.lang.String |
getProviderAttributeName(java.lang.Class classifier, java.lang.String attrName) Gets provider attribute name. |
ProviderCfg |
getProviderCfg() Gets provider config associated with this provider. |
java.lang.String |
getRealmName() Gets the active realm name |
java.util.List<BPMIdentity> |
getRoleManagers(BPMRole role, boolean direct) Gets a list of managers for a group. |
java.util.List |
getRoles(RoleClassifier roleType) Gets Roles of the specified type. |
java.util.List<java.lang.String> |
getSearchableUserAttributes() Gets the list of user attribute names that are searchable |
java.lang.String |
getTenantName(java.lang.String tenantGUID) Gets tenant name from tenantid |
java.util.List |
getUsers() Gets all users |
boolean |
hasPermission(BPMIdentity identity, java.security.Permission perm, java.lang.String appName) Check if identity Has permission |
BPMAppRole |
lookupAppRole(java.lang.String appRoleName, java.lang.String appName) Looks up BPMGroup in specified realm by role name |
BPMGroup |
lookupGroup(java.lang.String name) Looks up BPMGroup in specified realm by role name |
BPMRole |
lookupRole(java.lang.String name) Looks up BPMRole in specified realm by role name |
BPMUser |
lookupUser(java.lang.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 |
java.util.List |
searchRoles(RoleClassifier classifier, SearchFilter filter) Searches BPMRole based on the classifier and search filter. |
java.util.List |
searchRoles(RoleClassifier classifier, java.lang.String attrName, java.lang.String attrValue) Searches BPMRole based on teh classifier and attribute name-value pair. |
java.util.List |
searchUsers(SearchFilter filter) Searches BPMUsers based on the criteria specified in teh search filter. |
java.util.List |
searchUsers(java.lang.String attrName, java.lang.String attrValue) Searches BPMUsers with the given attribute name and value pair. |
Method Detail |
---|
ProviderCfg getProviderCfg()
java.lang.String getDefaultRealmName() throws BPMIdentityException
BPMIdentityException
- If exception condition occurs.java.lang.String getRealmName()
BPMIdentityException
- If exception condition occurs.BPMUser lookupUser(java.lang.String name) throws BPMIdentityException, BPMIdentityNotFoundException
name
- user nameBPMIdentityException
- If exception condition occurs.BPMIdentityNotFoundException
- If user is not foundBPMGroup lookupGroup(java.lang.String name) throws BPMIdentityException, BPMIdentityNotFoundException
name
- group nameBPMIdentityNotFoundException
- If group is not foundBPMIdentityException
- If exception condition occurs.BPMAppRole lookupAppRole(java.lang.String appRoleName, java.lang.String appName) throws BPMIdentityException, BPMIdentityNotFoundException
appRoleName
- application role nameappName
- application nameBPMIdentityNotFoundException
- If application role is not foundBPMIdentityException
- If exception condition occurs.BPMRole lookupRole(java.lang.String name) throws BPMIdentityException, BPMIdentityNotFoundException
name
- a role nameBPMIdentityNotFoundException
- If role is not foundBPMIdentityException
- If exception condition occurs.java.util.List getUsers() throws BPMIdentityException
BPMIdentityException
- If exception condition occurs.java.util.List<java.lang.String> getLocaleSpecificUserNames(java.util.List<java.lang.String> usersNames, java.util.Locale locale) throws BPMIdentityException, BPMIdentityNotFoundException
userNames
- List of userNamesLocale
-BPMIdentityNotFoundException
- If user is not foundBPMIdentityException
- If exception condition occurs.java.util.List<java.lang.String> getLocaleSpecificGroupNames(java.util.List<java.lang.String> groupNames, java.util.Locale locale) throws BPMIdentityException, BPMIdentityNotFoundException
userNames
- List of groupNamesLocale
-BPMIdentityNotFoundException
- If group is not foundBPMIdentityException
- If exception condition occurs.java.util.List getRoles(RoleClassifier roleType) throws BPMIdentityException
roleType
- a role classifierBPMIdentityException
- If exception condition occurs.java.util.Set getGrantedRoles(BPMPrincipal principal, boolean direct) throws BPMIdentityException
principal
- a BPMPrincipal objectdirect
- a boolean flag. if true return direct granted role, else allBPMIdentityException
- If exception condition occurs.java.util.Set getGrantedRoles(BPMPrincipal bpmPrincipal, boolean direct, java.lang.String appName) throws BPMIdentityException
principal
- a BPMPrincipal objectdirect
- a boolean flag. if true return direct granted role, else allappName
- a String, the name of the applicationBPMIdentityException
- If exception condition occurs.java.util.Set getGrantees(java.lang.String roleName, boolean direct) throws BPMIdentityException, BPMIdentityNotFoundException
roleName
- a role namedirect
- a boolean flag. If true method returns only direct participans, else all.BPMIdentityException
- If exception condition occurs.BPMIdentityNotFoundException
java.util.List searchUsers(java.lang.String attrName, java.lang.String attrValue) throws BPMIdentityException, BPMUnsupportedAttributeException
attrName
-attrValue
-BPMIdentityException
- If exception condition occurs.BPMUnsupportedAttributeException
java.util.List searchUsers(SearchFilter filter) throws BPMIdentityException, BPMUnsupportedAttributeException
filter
- a SearchFilter instance.BPMIdentityException
- If exception condition occurs.BPMUnsupportedAttributeException
java.util.List searchRoles(RoleClassifier classifier, java.lang.String attrName, java.lang.String attrValue) throws BPMIdentityException, BPMUnsupportedAttributeException
classifier
- RoleClassifierattrName
-attrValue
-BPMIdentityException
- If exception condition occurs.BPMUnsupportedAttributeException
java.util.List searchRoles(RoleClassifier classifier, SearchFilter filter) throws BPMIdentityException, BPMUnsupportedAttributeException
classifier
- RoleClassifierfilter
- a SearchFilterBPMIdentityException
- If exception condition occurs.BPMUnsupportedAttributeException
BPMRole populateDetails(BPMRole role) throws BPMIdentityException, BPMIdentityNotFoundException
BPMIdentityException
- If exception condition occurs.BPMIdentityNotFoundException
- If role is not foundBPMUser populateDetails(BPMUser user) throws BPMIdentityException, BPMIdentityNotFoundException
user
- a BPMUser to populateBPMIdentityException
- If exception condition occurs.BPMIdentityNotFoundException
- if role is not foundjava.util.Set getOwnedRoles(BPMPrincipal principal, boolean direct) throws BPMIdentityException
principal
- The owner principal.direct
- a boolean flag. If true method returns only directly owned roles.BPMIdentityException
java.util.Set getOwners(BPMRole role, boolean direct) throws BPMIdentityException
role
- The role whose owners are to be founddirect
- a boolean flag, if true only direct owners are returned, else allBPMIdentityException
- If exception condition occurs.java.util.List<BPMIdentity> getRoleManagers(BPMRole role, boolean direct) throws BPMIdentityException
role
- The role for which the managers are to be fetcheddirect
- a boolean flag, if true only direct managers are returned, else allBPMIdentityException
java.util.List<BPMRole> getManagedRoles(BPMIdentity id, boolean direct) throws BPMIdentityException
id
- The identity for which managed roles are to be fetcheddirect
- a boolean flag, if true only direct managed roles are returned, else allBPMIdentityException
java.util.Map getObjectAttributes(BPMPrincipal pr) throws BPMIdentityException
BPMIdentityException
void authenticateUser(java.lang.String name, java.lang.String password) throws BPMIdentityException, BPMAuthenticationException
name
- The name of the user to be authenticated.password
- The password of the user to be authenticated.BPMIdentityException
- If exception condition occurs.BPMAuthenticationException
- If the user could not be authenticated or if an exception condition occured during authentication.java.lang.String getProviderAttributeName(java.lang.Class classifier, java.lang.String attrName)
classifier
-attrName
-boolean hasPermission(BPMIdentity identity, java.security.Permission perm, java.lang.String appName) throws BPMIdentityException
identity
- the identityperm
- The permissionappName
- Name of the applicationBPMIdentityException
- if an exception condition occuredjava.security.PermissionCollection getPermissions(BPMIdentity identity) throws BPMIdentityException
identity
- the identityBPMIdentityException
- if an exception condition occuredjava.security.PermissionCollection getPermissions(BPMIdentity identity, java.lang.String appName) throws BPMIdentityException
identity
- the identityappName
- Name of the applicationBPMIdentityException
- if an exception condition occuredjava.security.PermissionCollection getAllPermissions() throws BPMIdentityException
BPMIdentityException
- if an exception condition occuredjava.security.PermissionCollection getAllPermissions(java.lang.String appName) throws BPMIdentityException
appName
- Name of the applicationBPMIdentityException
- if an exception condition occuredjava.lang.String getTenantName(java.lang.String tenantGUID) throws BPMIdentityException
BPMIdentityException
java.util.List<java.lang.String> getSearchableUserAttributes() throws BPMIdentityException
BPMIdentityException
- if an exception condition occured
|
Oracle Fusion Middleware Java API Reference for Oracle BPM Suite 11g Release 1 (11.1.1.6.3) E25378-06 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |