程序包 org.easysearch.client.security

类 PutUserRequest

java.lang.Object
org.easysearch.client.security.PutUserRequest
所有已实现的接口:
Validatable, org.easysearch.common.xcontent.ToXContent, org.easysearch.common.xcontent.ToXContentObject
public final class PutUserRequest
extends java.lang.Object
implements Validatable, org.easysearch.common.xcontent.ToXContentObject
Request object to create or update a user in the native realm.

  • 嵌套类概要

    从接口继承的嵌套类/接口 org.easysearch.common.xcontent.ToXContent

    org.easysearch.common.xcontent.ToXContent.DelegatingMapParams, org.easysearch.common.xcontent.ToXContent.MapParams, org.easysearch.common.xcontent.ToXContent.Params

  • 字段概要

    从接口继承的字段 org.easysearch.common.xcontent.ToXContent

    EMPTY_PARAMS

    从接口继承的字段 org.easysearch.client.Validatable

    EMPTY

  • 方法概要

    修饰符和类型 方法 说明
    boolean equals​(java.lang.Object o)  
    char[] getPassword()  
    User getUser()  
    int hashCode()  
    org.easysearch.common.xcontent.XContentBuilder toXContent​(org.easysearch.common.xcontent.XContentBuilder builder, org.easysearch.common.xcontent.ToXContent.Params params)  
    static PutUserRequest updateUser​(User user)
    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)
    Create or update a user in the native realm, with the user's new or updated password specified in plaintext.

    从类继承的方法 java.lang.Object

    clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

    从接口继承的方法 org.easysearch.common.xcontent.ToXContentObject

    isFragment

  • 方法详细资料

    • withPassword

      public static PutUserRequest withPassword​(User user, char[] password)
      Create or update a user in the native realm, with the user's new or updated password specified in plaintext.
      参数:
      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.

    • updateUser

      public static PutUserRequest updateUser​(User user)
      Update an existing user in the native realm without modifying their password.
      参数:
      user - the user to be created or updated

    • getUser

      public User getUser()

    • getPassword

      @Nullable public char[] getPassword()

    • equals

      public boolean equals​(java.lang.Object o)
      覆盖:
      equals 在类中 java.lang.Object

    • hashCode

      public int hashCode()
      覆盖:
      hashCode 在类中 java.lang.Object

    • validate

      public java.util.Optional<ValidationException> validate()
      从接口复制的说明: 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.
      指定者:
      validate 在接口中 Validatable
      返回:
      An Optional ValidationException that contains a list of validation errors.

    • toXContent

      public org.easysearch.common.xcontent.XContentBuilder toXContent​(org.easysearch.common.xcontent.XContentBuilder builder, org.easysearch.common.xcontent.ToXContent.Params params) throws java.io.IOException
      指定者:
      toXContent 在接口中 org.easysearch.common.xcontent.ToXContent
      抛出:
      java.io.IOException