WARNING: Deprecated in 7.15.0.
The Java REST Client is deprecated in favor of the Java API Client.
InvalidateTokenRequest supports invalidating
- A specific token, that can be either an access token or a refresh token
- All tokens (both access tokens and refresh tokens) for a specific realm
- All tokens (both access tokens and refresh tokens) for a specific user
- All tokens (both access tokens and refresh tokens) for a specific user in a specific realm
InvalidateTokenRequest invalidateTokenRequest = InvalidateTokenRequest.accessToken(accessToken);
InvalidateTokenRequest invalidateTokenRequest = InvalidateTokenRequest.refreshToken(refreshToken);
InvalidateTokenRequest invalidateTokenRequest = InvalidateTokenRequest.realmTokens("default_native");
InvalidateTokenRequest invalidateTokenRequest = InvalidateTokenRequest.userTokens("other_user");
InvalidateTokenRequest invalidateTokenRequest = new InvalidateTokenRequest(null, null, "default_native", "extra_user");
When executing a
InvalidateTokenRequest in the following manner, the client waits
InvalidateTokenResponse to be returned before continuing with code execution:
InvalidateTokenResponse invalidateTokenResponse = client.security().invalidateToken(invalidateTokenRequest, 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
5xx error code, the high-level
client tries to parse the response body error details instead and then throws
ElasticsearchException and adds the original
ResponseException as a
suppressed exception to it.
InvalidateTokenRequest 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 invalidate-token method:
The asynchronous method does not block and returns immediately. Once it is
ActionListener is called back using the
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
invalidate-token looks like:
InvalidateTokenResponse contains the information regarding the tokens that the request
getInvalidatedTokensdenotes the number of tokens that this request invalidated.
getPreviouslyInvalidatedTokensdenotes the number of tokens that this request attempted to invalidate but were already invalid.
getErrorscontains possible errors that were encountered while attempting to invalidate specific tokens.
final List<ElasticsearchException> errors = invalidateTokenResponse.getErrors(); final int invalidatedTokens = invalidateTokenResponse.getInvalidatedTokens(); final int previouslyInvalidatedTokens = invalidateTokenResponse.getPreviouslyInvalidatedTokens();