Package org.elasticsearch.client.security

Class PutUserRequest

java.lang.Object
org.elasticsearch.client.security.PutUserRequest
All Implemented Interfaces:
Validatable, org.elasticsearch.xcontent.ToXContent, org.elasticsearch.xcontent.ToXContentObject
public final class PutUserRequest extends Object implements Validatable, org.elasticsearch.xcontent.ToXContentObject
Request object to create or update a user in the native realm.

  • Constructor Details

    • PutUserRequest

      @Deprecated public PutUserRequest(User user, @Nullable char[] password, boolean enabled, @Nullable RefreshPolicy refreshPolicy)
      Deprecated.
      Use withPassword(User, char[], boolean, RefreshPolicy) or updateUser(User, boolean, RefreshPolicy) instead.
      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 updated
      password - 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 elasticsearch
      refreshPolicy - the refresh policy for the request.

  • Method Details

    • 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 updated
      password - 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 elasticsearch
      refreshPolicy - 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 updated
      passwordHash - 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 elasticsearch
      refreshPolicy - 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 updated
      enabled - true if the user is enabled and allowed to access elasticsearch
      refreshPolicy - 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(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • validate

      public 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. A ValidationException that is not null is assumed to contain validation errors and will be thrown.
      Specified by:
      validate in interface Validatable
      Returns:
      An Optional ValidationException that contains a list of validation errors.

    • toXContent

      public org.elasticsearch.xcontent.XContentBuilder toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) throws IOException
      Specified by:
      toXContent in interface org.elasticsearch.xcontent.ToXContent
      Throws:
      IOException