Get Privileges API

Get Privileges Request

The GetPrivilegesRequest supports getting privilege(s) for all or for specific applications.

Specific privilege of a specific application

GetPrivilegesRequest request = new GetPrivilegesRequest("testapp", "write");

All privileges of a specific application

GetPrivilegesRequest request = GetPrivilegesRequest.getApplicationPrivileges("testapp");

All privileges of all applications

GetPrivilegesRequest request = GetPrivilegesRequest.getAllPrivileges();

Synchronous Execution

When executing a GetPrivilegesRequest in the following manner, the client waits for the GetPrivilegesResponse to be returned before continuing with code execution:

GetPrivilegesResponse response = client.security().getPrivileges(request, RequestOptions.DEFAULT);

Synchronous calls may throw an IOException in case of either failing to parse the REST response in the high-level REST client, the request times out or similar cases where there is no response coming back from the server.

In cases where the server returns a 4xx or 5xx error code, the high-level client tries to parse the response body error details instead and then throws a generic ElasticsearchException and adds the original ResponseException as a suppressed exception to it.

Asynchronous Execution

Executing a GetPrivilegesRequest can also be done in an asynchronous fashion so that the client can return directly. Users need to specify how the response or potential failures will be handled by passing the request and a listener to the asynchronous get-privileges method:

client.security().getPrivilegesAsync(request, RequestOptions.DEFAULT, listener); 

The GetPrivilegesRequest to execute and the ActionListener to use when the execution completes

The asynchronous method does not block and returns immediately. Once it is completed the ActionListener is called back using the onResponse method if the execution successfully completed or using the onFailure method if it failed. Failure scenarios and expected exceptions are the same as in the synchronous execution case.

A typical listener for get-privileges looks like:

ActionListener<GetPrivilegesResponse> listener = new ActionListener<GetPrivilegesResponse>() {
    @Override
    public void onResponse(GetPrivilegesResponse getPrivilegesResponse) {
        
    }

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

Called when the execution is successfully completed.

Called when the whole GetPrivilegesRequest fails.

Get Privileges Response

The returned GetPrivilegesResponse allows to get information about the retrieved privileges as follows.

Set<ApplicationPrivilege> privileges = response.getPrivileges();