Package org.ldaptive.auth

Class AuthenticationRequest

java.lang.Object
org.ldaptive.auth.AuthenticationRequest
public class AuthenticationRequest extends Object
Contains the data required to perform an ldap authentication.

  • Field Details

    • user

      private User user
      User.

    • credential

      private Credential credential
      User credential.

    • returnAttributes

      private String[] returnAttributes
      User attributes to return.

    • controls

      private RequestControl[] controls
      Request controls.

  • Constructor Details

    • AuthenticationRequest

      public AuthenticationRequest()
      Default constructor.

    • AuthenticationRequest

      public AuthenticationRequest(String id, Credential c)
      Creates a new authentication request.
      Parameters:
      id - that identifies the user
      c - credential to authenticate the user

    • AuthenticationRequest

      public AuthenticationRequest(String id, Credential c, String... attrs)
      Creates a new authentication request.
      Parameters:
      id - that identifies the user
      c - credential to authenticate the user
      attrs - attributes to return

    • AuthenticationRequest

      public AuthenticationRequest(User u, Credential c)
      Creates a new authentication request.
      Parameters:
      u - that identifies the user
      c - credential to authenticate the user

    • AuthenticationRequest

      public AuthenticationRequest(User u, Credential c, String... attrs)
      Creates a new authentication request.
      Parameters:
      u - that identifies the user
      c - credential to authenticate the user
      attrs - attributes to return

  • Method Details

    • getUser

      public User getUser()
      Returns the user.
      Returns:
      user identifier

    • setUser

      public void setUser(User u)
      Sets the user.
      Parameters:
      u - user

    • getCredential

      public Credential getCredential()
      Returns the credential.
      Returns:
      user credential

    • setCredential

      public void setCredential(Credential c)
      Sets the credential.
      Parameters:
      c - user credential

    • getReturnAttributes

      public String[] getReturnAttributes()
      Returns the return attributes.
      Returns:
      attributes to return

    • setReturnAttributes

      public void setReturnAttributes(String... attrs)
      Sets the return attributes.
      Parameters:
      attrs - return attributes

    • getControls

      public RequestControl[] getControls()
      Returns the controls.
      Returns:
      controls

    • setControls

      public void setControls(RequestControl... cntrls)
      Sets the controls.
      Parameters:
      cntrls - controls to set

    • copy

      static AuthenticationRequest copy(AuthenticationRequest request)
      Returns an authentication request initialized with the supplied request. This method does not perform a deep copy of request properties.
      Parameters:
      request - authentication request to read properties from
      Returns:
      authentication request

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • builder

      public static AuthenticationRequest.Builder builder()
      Creates a builder for this class.
      Returns:
      new builder