Class AuthenticateResponse
- java.lang.Object
-
- org.elasticsearch.client.security.AuthenticateResponse
-
public final class AuthenticateResponse extends java.lang.Object
The response for the authenticate call. The response contains two fields: a user field and a boolean flag signaling if the user is enabled or not. The user object contains all user metadata which Elasticsearch uses to map roles, etc.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
AuthenticateResponse.RealmInfo
-
Constructor Summary
Constructors Constructor Description AuthenticateResponse(User user, boolean enabled, AuthenticateResponse.RealmInfo authenticationRealm, AuthenticateResponse.RealmInfo lookupRealm)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
enabled()
boolean
equals(java.lang.Object o)
static AuthenticateResponse
fromXContent(XContentParser parser)
AuthenticateResponse.RealmInfo
getAuthenticationRealm()
AuthenticateResponse.RealmInfo
getLookupRealm()
User
getUser()
int
hashCode()
-
-
-
Constructor Detail
-
AuthenticateResponse
public AuthenticateResponse(User user, boolean enabled, AuthenticateResponse.RealmInfo authenticationRealm, AuthenticateResponse.RealmInfo lookupRealm)
-
-
Method Detail
-
getUser
public User getUser()
- Returns:
- The effective user. This is the authenticated user, or, when submitting requests on behalf of other users, it is the impersonated user.
-
enabled
public boolean enabled()
- Returns:
- whether the user is enabled or not
-
getAuthenticationRealm
public AuthenticateResponse.RealmInfo getAuthenticationRealm()
- Returns:
- the realm that authenticated the user
-
getLookupRealm
public AuthenticateResponse.RealmInfo getLookupRealm()
- Returns:
- the realm where the user information was looked up
-
equals
public boolean equals(java.lang.Object o)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
fromXContent
public static AuthenticateResponse fromXContent(XContentParser parser) throws java.io.IOException
- Throws:
java.io.IOException
-
-