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: 2885 $ $Date: 2014-02-05 16:28:49 -0500 (Wed, 05 Feb 2014) $

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.

Method Summary

Credential	getCredential() Returns the credential.
String[]	getReturnAttributes() Returns the return attributes.
String	getUser() Returns the user.
void	setCredential(Credential c) Sets the credential.
void	setReturnAttributes(String... attrs) Sets the return attributes.
void	setUser(String id) 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(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

Method Detail

getUser

public String getUser()

Returns the user.

Returns:

user identifier

setUser

public void setUser(String id)

Sets the user.

Parameters:

id - of the 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

toString

public String toString()

Overrides:

toString in class Object