Package org.ldaptive.auth

Class AuthenticationRequest.Builder

java.lang.Object

org.ldaptive.auth.AuthenticationRequest.Builder

Enclosing class:

AuthenticationRequest

public static class AuthenticationRequest.Builder
extends Object

Authentication request builder.

Field Summary

Fields

Modifier and Type	Field	Description
private AuthenticationRequest	object	Authentication request to build.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder()	Default constructor.

Method Summary

Modifier and Type	Method	Description
AuthenticationRequest	build()	Returns the authentication request.
AuthenticationRequest.Builder	controls(RequestControl... controls)	Sets the request controls.
AuthenticationRequest.Builder	credential(byte[] credential)	Sets the user credential.
AuthenticationRequest.Builder	credential(char[] credential)	Sets the user credential.
AuthenticationRequest.Builder	credential(String credential)	Sets the user credential.
AuthenticationRequest.Builder	credential(Credential credential)	Sets the user credential.
AuthenticationRequest.Builder	id(String id)	Sets the user id.
AuthenticationRequest.Builder	returnAttributes(String... attributes)	Sets the return attributes.
AuthenticationRequest.Builder	user(User user)	Sets the user.

Methods inherited from class java.lang.Object

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

Field Detail

object

private final AuthenticationRequest object

Authentication request to build.

Constructor Detail

Builder

protected Builder()

Default constructor.

Method Detail

id

public AuthenticationRequest.Builder id(String id)

Sets the user id.

Parameters:

id - user id

Returns:

this builder

credential

public AuthenticationRequest.Builder credential(Credential credential)

Sets the user credential.

Parameters:

credential - user credential

Returns:

this builder

credential

public AuthenticationRequest.Builder credential(String credential)

Sets the user credential.

Parameters:

credential - user credential

Returns:

this builder

credential

public AuthenticationRequest.Builder credential(char[] credential)

Sets the user credential.

Parameters:

credential - user credential

Returns:

this builder

credential

public AuthenticationRequest.Builder credential(byte[] credential)

Sets the user credential.

Parameters:

credential - user credential

Returns:

this builder

user

public AuthenticationRequest.Builder user(User user)

Sets the user.

Parameters:

user - to authenticate

Returns:

this builder

returnAttributes

public AuthenticationRequest.Builder returnAttributes(String... attributes)

Sets the return attributes.

Parameters:

attributes - return attributes

Returns:

this builder

controls

public AuthenticationRequest.Builder controls(RequestControl... controls)

Sets the request controls.

Parameters:

controls - request controls

Returns:

this builder

build

public AuthenticationRequest build()

Returns the authentication request.

Returns:

authentication request