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.Modifier and Type | Method and Description |
---|---|
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.
|
void authenticateUser(java.lang.String userName, java.lang.String password) throws BPMAuthenticationException, BPMIdentityException
authenticateUser(String, char[])
insteaduserName
- user namepassword
- user passwordBPMAuthenticationException
- if user not authenticatedBPMIdentityException
- if error occursvoid authenticateUser(java.lang.String userName, char[] password) throws BPMAuthenticationException, BPMIdentityException
userName
- The name of the user who is to be authenticatedpassword
- The password as a character arrayBPMAuthenticationException
- If authentication fails or causes an exception condition.BPMIdentityException
- If any other exception condition occurs.java.lang.String getRealmName() throws BPMIdentityException
BPMIdentityException
- If any exception condition occurs.Configuration getConfiguration() throws BPMIdentityException
BPMIdentityException
- If any exception condition occurs.BPMProvider getProvider()
BPMIdentityException
- If any exception condition occurs.