Skip navigation links

oracle.bpm.services.authentication
Interface IBPMUserAuthenticationService

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
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

authenticate

IBPMContext authenticate(java.lang.String user,
                         char[] password,
                         java.lang.String identityContext)
                         throws BPMException

authenticate is used for authenticating a user with the identity authentication service based on the specified user/password and returns a BPM context.

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.

Parameters:

user - the name of the user who needs to be authenticated

password - the password of the user who needs to be authenticated

identityContext - the identityContext (usually realm) of the user

Returns:

IBPMContext the BPM context

Throws:

BPMException - any exception thrown during authentication

authenticateOnBehalfOf

IBPMContext authenticateOnBehalfOf(IBPMContext adminContext,
                                   java.lang.String onBehalfOfUser)
                                   throws BPMException

Admin can authenticate on behalf of another user, and get the BPM context for the user specified in onBehalfOfUser

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.

Parameters:

IBPMContext - the BPM context of the admin

onBehalfOfUser - The user on behalf of whom the context should be created

Returns:

IBPMContext the BPM context for the user specified in onBehalfOfUser

Throws:

BPMException - any exception thrown during authentication

getBPMContextForAuthenticatedUser

IBPMContext getBPMContextForAuthenticatedUser()
                                              throws BPMException

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

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.

Returns:

IBPMContext object.

Throws:

BPMException - any exception thrown during authentication

destroyBPMContext

void destroyBPMContext(IBPMContext ctx)
                       throws BPMException

destroyBPMContext is used for cleaning up a BPM context that is no longer needed. This will free up the memory used for storing the BPM context. This is used typically when a user logs out.

Parameters:

ctx - the BPM context

Throws:

BPMException - any exception thrown during authentication

Skip navigation links