DefaultAuthenticationService (IG Aggregated Javadoc 7.2.0 Documentation)

java.lang.Object
- org.forgerock.openig.tools.authentication.chf.DefaultAuthenticationService

All Implemented Interfaces:

AuthenticationService

Direct Known Subclasses:

AgentAuthenticationService
```
public class DefaultAuthenticationService
extends Object
implements AuthenticationService
```
Implements an HTTP-based authentication service.

Constructor Summary

Constructors
Constructor Description

DefaultAuthenticationService(Handler handler, URI uri)
Constructs a DefaultAuthenticationService.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Promise<SsoToken,AuthenticationException>`	`authenticate(Context context, String username, char[] password)`	Authenticates a subject (identified with the given `username` and `password` credentials), returning asynchronously an SSO token (if the authentication succeeded) or an `AuthenticationException` on failures (I/O, invalid credentials, ...).

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DefaultAuthenticationService
```
public DefaultAuthenticationService(Handler handler,
                                    URI uri)
```
    Constructs a DefaultAuthenticationService.
    
    Parameters:
    
    handler - HTTP handler used to communicate with AM
    
    uri - the absolute AM authentication endpoint URI (usually ending with /json/authenticate).
- Method Detail
  - authenticate
```
public Promise<SsoToken,AuthenticationException> authenticate(Context context,
                                                                    String username,
                                                                    char[] password)
```
    Description copied from interface: AuthenticationService
    
    Authenticates a subject (identified with the given username and password credentials), returning asynchronously an SSO token (if the authentication succeeded) or an AuthenticationException on failures (I/O, invalid credentials, ...).
    
    Specified by:
    
    authenticate in interface AuthenticationService
    
    Parameters:
    
    context - Service context
    
    username - subject's username
    
    password - subject's credentials
    
    Returns:
    
    a promise of an SsoToken