oracle.tip.pc.services.identity
Interface BPMAuthenticationService

All Superinterfaces:

Service

All Known Subinterfaces:

BPMIdentityService

public interface BPMAuthenticationService
extends Service

BPMAuthenticationService defines BPEL Process Manager Authentication Service An instance can be obtained from the ServiceFactory. For example: BPMAuthenticationService service = ServiceFactory.getAuthenticationServiceInstance(); BPMAuthenticationService service = ServiceFactory.getAuthenticationServiceInstance("myRealm"); This method will fetch the service instance as configured in the identity service configuration.

Method Summary

void	authenticateUser(java.lang.String userName, char[] password) Authenticates the given user and password against the system.
void	authenticateUser(java.lang.String userName, java.lang.String password) Deprecated. since release 11. Use authenticateUser(String, char[]) instead
Configuration	getConfiguration() Gets the configuration associated with this service
BPMProvider	getProvider() Gets the provider associated with this service
java.lang.String	getRealmName() Gets the name of the realm associated with this service.

Methods inherited from interface oracle.tip.pc.services.common.Service

getStatus

Method Detail

authenticateUser

void authenticateUser(java.lang.String userName,
                      java.lang.String password)
                      throws BPMAuthenticationException,
                             BPMIdentityException

Deprecated. since release 11. Use authenticateUser(String, char[]) instead

Authenticates the given user and password against the system.

Parameters:

userName - user name

password - user password

Throws:

BPMAuthenticationException - if user not authenticated

BPMIdentityException - if error occurs

authenticateUser

void authenticateUser(java.lang.String userName,
                      char[] password)
                      throws BPMAuthenticationException,
                             BPMIdentityException

Authenticates the given user and password against the system.

Parameters:

userName - The name of the user who is to be authenticated

password - The password as a character array

Throws:

BPMAuthenticationException - If authentication fails or causes an exception condition.

BPMIdentityException - If any other exception condition occurs.

getRealmName

java.lang.String getRealmName()
                              throws BPMIdentityException

Gets the name of the realm associated with this service.

Returns:

realm name

Throws:

BPMIdentityException - If any exception condition occurs.

getConfiguration

Configuration getConfiguration()
                               throws BPMIdentityException

Gets the configuration associated with this service

Returns:

configuration

Throws:

BPMIdentityException - If any exception condition occurs.

getProvider

BPMProvider getProvider()

Gets the provider associated with this service

Returns:

BPMProvider instance

Throws:

BPMIdentityException - If any exception condition occurs.