|
Oracle Fusion Middleware Java API Reference for Oracle BPM Suite 11g Release 1 (11.1.1.7.0) E25378-07 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IBPMUserAuthenticationService
Provides APIs to create/destroy BPM context of a user.
Method Summary | |
---|---|
IBPMContext |
authenticate(java.lang.String user,
char[] password,
java.lang.String identityContext)
authenticate is used for authenticating a user with the identity authentication service based on the specified user/password and returns a BPM context. |
IBPMContext |
authenticateOnBehalfOf(IBPMContext adminContext,
java.lang.String onBehalfOfUser)
Admin can authenticate on behalf of another user, and get the BPM context for the user specified in onBehalfOfUser |
IBPMContext |
createContextFromRequestObject(java.lang.Object request)
createContextFromRequestObject is used for creating a context from a pre-authenticated environment such as a SSO based application. |
void |
destroyBPMContext(IBPMContext ctx)
destroyBPMContext is used for cleaning up a BPM context that is no longer needed. |
IBPMContext |
getBPMContextForAuthenticatedUser()
Gets BPM context for already authenticated user and whose identity is propagated to server The method returns valid context only if user identity is propagated to the service and context is still valid, else the method throws BPMException exception |
Method Detail |
---|
IBPMContext authenticate(java.lang.String user, char[] password, java.lang.String identityContext) throws BPMException
If a IBPMContext
instance is not used for within the timeout defined
in the workflow configuration, it would become invalid and can't be used further in BPM
service calls because a BPMException would be thrown. If this occurs a new
IBPMContext
instance would have to be obtained.
When IBPMContext
instance isn't needed any more (such as a logout
from an application) it has to be destroyed to free up memory used in the service by that
corresponding session. To destroy a IBPMContext
instance see
destroyBPMContext()
method.
user
- the name of the user who needs to be authenticatedpassword
- the password of the user who needs to be authenticatedidentityContext
- the identityContext (usually realm) of the user
BPMException
- any exception thrown during authenticationIBPMContext authenticateOnBehalfOf(IBPMContext adminContext, java.lang.String onBehalfOfUser) throws BPMException
If a IBPMContext
instance is not used for within the timeout defined
in the workflow configuration, it would become invalid and can't be used further in BPM
service calls because a BPMException would be thrown. If this occurs a new
IBPMContext
instance would have to be obtained.
When IBPMContext
instance isn't needed any more (such as a logout
from an application) it has to be destroyed to free up memory used in the service by that
corresponding session. To destroy a IBPMContext
instance see
destroyBPMContext()
method.
IBPMContext
- the BPM context of the adminonBehalfOfUser
- The user on behalf of whom the context should be created
BPMException
- any exception thrown during authenticationIBPMContext getBPMContextForAuthenticatedUser() throws BPMException
BPMException
exception
If a IBPMContext
instance is not used for within the timeout defined
in the workflow configuration, it would become invalid and can't be used further in BPM
service calls because a BPMException would be thrown. If this occurs a new
IBPMContext
instance would have to be obtained.
When IBPMContext
instance isn't needed any more (such as a logout
from an application) it has to be destroyed to free up memory used in the service by that
corresponding session. To destroy a IBPMContext
instance see
destroyBPMContext()
method.
IBPMContext
object.
BPMException
- any exception thrown during authenticationIBPMContext createContextFromRequestObject(java.lang.Object request) throws BPMException
If a IBPMContext
instance is not used for within the timeout defined
in the workflow configuration, it would become invalid and can't be used further in BPM
service calls because a BPMException would be thrown. If this occurs a new
IBPMContext
instance would have to be obtained.
When IBPMContext
instance isn't needed any more (such as a logout
from an application) it has to be destroyed to free up memory used in the service by that
corresponding session. To destroy a IBPMContext
instance see
destroyBPMContext()
method.
request
- The pre-authenticated HttpServletRequest/PortletRequest to create the workflow context for
IBPMContext
the BPM context
BPMException
- any exception thrown during authenticationvoid destroyBPMContext(IBPMContext ctx) throws BPMException
ctx
- the BPM context
BPMException
- any exception thrown during authentication
|
Oracle Fusion Middleware Java API Reference for Oracle BPM Suite 11g Release 1 (11.1.1.7.0) E25378-07 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |