Class PutUserRequest
- java.lang.Object
-
- org.elasticsearch.client.security.PutUserRequest
-
- All Implemented Interfaces:
Validatable
,ToXContent
,ToXContentObject
public final class PutUserRequest extends java.lang.Object implements Validatable, ToXContentObject
Request object to create or update a user in the native realm.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params
-
-
Field Summary
-
Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent
EMPTY_PARAMS
-
Fields inherited from interface org.elasticsearch.client.Validatable
EMPTY
-
-
Constructor Summary
Constructors Constructor Description PutUserRequest(User user, char[] password, boolean enabled, RefreshPolicy refreshPolicy)
Deprecated.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object o)
char[]
getPassword()
RefreshPolicy
getRefreshPolicy()
User
getUser()
int
hashCode()
boolean
isEnabled()
XContentBuilder
toXContent(XContentBuilder builder, ToXContent.Params params)
static PutUserRequest
updateUser(User user, boolean enabled, RefreshPolicy refreshPolicy)
Update an existing user in the native realm without modifying their password.java.util.Optional<ValidationException>
validate()
Perform validation.static PutUserRequest
withPassword(User user, char[] password, boolean enabled, RefreshPolicy refreshPolicy)
Create or update a user in the native realm, with the user's new or updated password specified in plaintext.static PutUserRequest
withPasswordHash(User user, char[] passwordHash, boolean enabled, RefreshPolicy refreshPolicy)
Create or update a user in the native realm, with the user's new or updated password specified as a cryptographic hash.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject
isFragment
-
-
-
-
Constructor Detail
-
PutUserRequest
@Deprecated public PutUserRequest(User user, @Nullable char[] password, boolean enabled, @Nullable RefreshPolicy refreshPolicy)
Deprecated.Creates a new request that is used to create or update a user in the native realm.- Parameters:
user
- the user to be created or updatedpassword
- the password of the user. The password array is not modified by this class. It is the responsibility of the caller to clear the password after receiving a response.enabled
- true if the user is enabled and allowed to access elasticsearchrefreshPolicy
- the refresh policy for the request.
-
-
Method Detail
-
withPassword
public static PutUserRequest withPassword(User user, char[] password, boolean enabled, RefreshPolicy refreshPolicy)
Create or update a user in the native realm, with the user's new or updated password specified in plaintext.- Parameters:
user
- the user to be created or updatedpassword
- the password of the user. The password array is not modified by this class. It is the responsibility of the caller to clear the password after receiving a response.enabled
- true if the user is enabled and allowed to access elasticsearchrefreshPolicy
- the refresh policy for the request.
-
withPasswordHash
public static PutUserRequest withPasswordHash(User user, char[] passwordHash, boolean enabled, RefreshPolicy refreshPolicy)
Create or update a user in the native realm, with the user's new or updated password specified as a cryptographic hash.- Parameters:
user
- the user to be created or updatedpasswordHash
- the hash of the password of the user. It must be in the correct format for the password hashing algorithm in use on this elasticsearch cluster. The array is not modified by this class. It is the responsibility of the caller to clear the hash after receiving a response.enabled
- true if the user is enabled and allowed to access elasticsearchrefreshPolicy
- the refresh policy for the request.
-
updateUser
public static PutUserRequest updateUser(User user, boolean enabled, RefreshPolicy refreshPolicy)
Update an existing user in the native realm without modifying their password.- Parameters:
user
- the user to be created or updatedenabled
- true if the user is enabled and allowed to access elasticsearchrefreshPolicy
- the refresh policy for the request.
-
getUser
public User getUser()
-
getPassword
@Nullable public char[] getPassword()
-
isEnabled
public boolean isEnabled()
-
getRefreshPolicy
public RefreshPolicy getRefreshPolicy()
-
equals
public boolean equals(java.lang.Object o)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
validate
public java.util.Optional<ValidationException> validate()
Description copied from interface:Validatable
Perform validation. This method does not have to be overridden in the event that no validation needs to be done, or the validation was done during object construction time. AValidationException
that is not null is assumed to contain validation errors and will be thrown.- Specified by:
validate
in interfaceValidatable
- Returns:
- An
Optional
ValidationException
that contains a list of validation errors.
-
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException
- Specified by:
toXContent
in interfaceToXContent
- Throws:
java.io.IOException
-
-