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.

Version:

$Revision: 3235 $ $Date: 2017-08-28 15:48:23 -0400 (Mon, 28 Aug 2017) $

Author:

Middleware Services

Constructor Summary

AuthenticationRequest()
Default constructor.

AuthenticationRequest(String id, Credential c)
Creates a new authentication request.

AuthenticationRequest(String id, Credential c, String... attrs)
Creates a new authentication request.

AuthenticationRequest(User u, Credential c)
Creates a new authentication request.

AuthenticationRequest(User u, Credential c, String... attrs)
Creates a new authentication request.

Method Summary

RequestControl[]	getControls() Returns the controls.
Credential	getCredential() Returns the credential.
String[]	getReturnAttributes() Returns the return attributes.
String	getUser() Returns the user.
User	getUserEx() Returns the user.
static AuthenticationRequest	newAuthenticationRequest(AuthenticationRequest request) Returns an authentication request initialized with the supplied request.
void	setControls(RequestControl... c) Sets the controls.
void	setCredential(Credential c) Sets the credential.
void	setReturnAttributes(String... attrs) Sets the return attributes.
void	setUser(String id) Sets the user.
void	setUserEx(User u) Sets the user.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

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(User u,
                             Credential c)

Creates a new authentication request.

Parameters:

u - 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,
                             String... attrs)

Creates a new authentication request.

Parameters:

u - that identifies the user

c - credential to authenticate the user

attrs - attributes to return

Method Detail

getUser

public String getUser()

Returns the user.

Returns:

user identifier

getUserEx

public User getUserEx()

Returns the user.

Returns:

user identifier

setUser

public void setUser(String id)

Sets the user.

Parameters:

id - of the user

setUserEx

public void setUserEx(User u)

Sets the user.

Parameters:

u - user to authenticate

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... c)

Sets the controls.

Parameters:

c - controls to set

newAuthenticationRequest

public static AuthenticationRequest newAuthenticationRequest(AuthenticationRequest request)

Returns an authentication request initialized with the supplied request.

Parameters:

request - authentication request to read properties from

Returns:

authentication request

toString

public String toString()

Overrides:

toString in class Object