java.lang.Object
org.elasticsearch.xpack.core.security.user.User
- All Implemented Interfaces:
org.elasticsearch.xcontent.ToXContent,org.elasticsearch.xcontent.ToXContentObject
- Direct Known Subclasses:
InternalUser,ReservedUser
An authenticated user
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent
org.elasticsearch.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.xcontent.ToXContent.MapParams, org.elasticsearch.xcontent.ToXContent.Params -
Field Summary
Fields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY, EMPTY_PARAMS -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionemail()booleanenabled()booleanfullName()inthashCode()voidinnerToXContent(org.elasticsearch.xcontent.XContentBuilder builder) metadata()String[]roles()toString()final org.elasticsearch.xcontent.XContentBuildertoXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) static voidwriteUser(User user, StreamOutput output) Write the givenUserMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.elasticsearch.xcontent.ToXContentObject
isFragment
-
Constructor Details
-
User
-
User
-
-
Method Details
-
principal
- Returns:
- The principal of this user - effectively serving as the unique identity of the user (within a given realm).
-
roles
- Returns:
- The roles this user is associated with. The roles are identified by their unique names and each represents as set of permissions
-
metadata
- Returns:
- The metadata that is associated with this user. Can never be
null.
-
fullName
- Returns:
- The full name of this user. May be
null.
-
email
- Returns:
- The email of this user. May be
null.
-
enabled
public boolean enabled()- Returns:
- whether the user is enabled or not
-
toString
-
equals
-
hashCode
public int hashCode() -
toXContent
public final org.elasticsearch.xcontent.XContentBuilder toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) throws IOException - Specified by:
toXContentin interfaceorg.elasticsearch.xcontent.ToXContent- Throws:
IOException
-
innerToXContent
- Throws:
IOException
-
writeUser
Write the givenUser- Throws:
IOException
-