Delete Privileges API

This API can be used to delete application privileges.

Delete Application Privileges Request

A DeletePrivilegesRequest has two arguments

DeletePrivilegesRequest request = new DeletePrivilegesRequest(
    "testapp",          
    "read", "write"); 

the name of application

the name(s) of the privileges to delete that belong to the given application

Synchronous Execution

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

DeletePrivilegesResponse response = client.security().deletePrivileges(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 DeletePrivilegesRequest 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 delete-privileges method:

client.security().deletePrivilegesAsync(deletePrivilegesRequest, RequestOptions.DEFAULT, listener); 

The DeletePrivilegesRequest 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 delete-privileges looks like:

listener = new ActionListener<DeletePrivilegesResponse>() {
    @Override
    public void onResponse(DeletePrivilegesResponse deletePrivilegesResponse) {
        
    }

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

Called when the execution is successfully completed.

Called when the whole DeletePrivilegesRequest fails.

Delete Application Privileges Response

The returned DeletePrivilegesResponse allows to retrieve information about the executed operation as follows:

String application = response.getApplication();        
boolean found = response.isFound("read");              

the name of the application

whether the given privilege was found and deleted