org.ldaptive.auth

Class AuthenticationRequest

java.lang.Object

org.ldaptive.auth.AuthenticationRequest

public class AuthenticationRequest
extends java.lang.Object

Contains the data required to perform an ldap authentication.

Field Summary

Fields

Modifier and Type	Field and Description
private Credential	credential User credential.
private java.lang.String[]	retAttrs User attributes to return.
private java.lang.String	user User identifier.

Constructor Summary

Constructors

Constructor and Description
AuthenticationRequest() Default constructor.
AuthenticationRequest(java.lang.String id, Credential c) Creates a new authentication request.
AuthenticationRequest(java.lang.String id, Credential c, java.lang.String... attrs) Creates a new authentication request.

Method Summary

Modifier and Type	Method and Description
Credential	getCredential() Returns the credential.
java.lang.String[]	getReturnAttributes() Returns the return attributes.
java.lang.String	getUser() Returns the user.
void	setCredential(Credential c) Sets the credential.
void	setReturnAttributes(java.lang.String... attrs) Sets the return attributes.
void	setUser(java.lang.String id) Sets the user.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

user

private java.lang.String user

User identifier.

credential

private Credential credential

User credential.

retAttrs

private java.lang.String[] retAttrs

User attributes to return.

Constructor Detail

AuthenticationRequest

public AuthenticationRequest()

Default constructor.

AuthenticationRequest

public AuthenticationRequest(java.lang.String id,
                             Credential c)

Creates a new authentication request.

Parameters:

id - that identifies the user

c - credential to authenticate the user

AuthenticationRequest

public AuthenticationRequest(java.lang.String id,
                             Credential c,
                             java.lang.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 java.lang.String getUser()

Returns the user.

Returns:

user identifier

setUser

public void setUser(java.lang.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 java.lang.String[] getReturnAttributes()

Returns the return attributes.

Returns:

attributes to return

setReturnAttributes

public void setReturnAttributes(java.lang.String... attrs)

Sets the return attributes.

Parameters:

attrs - return attributes

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object