Authenticate API

Authenticating and retrieving information about a user can be performed using the security().authenticate() method:

AuthenticateResponse response = client.security().authenticate(RequestOptions.DEFAULT);

This method does not require a request object. The client waits for the AuthenticateResponse to be returned before continuing with code execution.

The returned AuthenticateResponse contains four fields. The user field , accessed with getUser, contains all the information about this authenticated user. The field enabled, tells if this user is actually usable or has been temporarily deactivated. The field authentication_realm, accessed with getAuthenticationRealm contains the name and type of the Realm that has authenticated the user and the field lookup_realm, accessed with getLookupRealm contains the name and type of the Realm where the user information were retrieved from.

User user = response.getUser(); 
boolean enabled = response.enabled(); 
final String authenticationRealmName = response.getAuthenticationRealm().getName(); 
final String authenticationRealmType = response.getAuthenticationRealm().getType(); 
final String lookupRealmName = response.getLookupRealm().getName(); 
final String lookupRealmType = response.getLookupRealm().getType(); 
final String authenticationType = response.getAuthenticationType(); 

This request can also be executed asynchronously:

client.security().authenticateAsync(RequestOptions.DEFAULT, listener); 

The asynchronous method does not block and returns immediately. Once the request has completed the ActionListener is called back using the onResponse method if the execution completed successfully or using the onFailure method if it failed.

A typical listener for a AuthenticateResponse looks like:

ActionListener<AuthenticateResponse> listener = new ActionListener<AuthenticateResponse>() {
    @Override
    public void onResponse(AuthenticateResponse response) {
        
    }

    @Override
    public void onFailure(Exception e) {
        
    }
};