Package org.ldaptive.auth

Class Authenticator.Builder

java.lang.Object

org.ldaptive.auth.Authenticator.Builder

Enclosing class:

Authenticator

public static final class Authenticator.Builder
extends Object

Authenticator builder.

Field Summary

Fields

Modifier and Type	Field	Description
private final Authenticator	object	Authenticator to build.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Builder()	Default constructor.

Method Summary

Modifier and Type	Method	Description
Authenticator.Builder	authenticationHandler(AuthenticationHandler handler)	Sets the authentication handler.
Authenticator	build()	Returns the authenticator.
Authenticator.Builder	dnResolver(DnResolver resolver)	Sets the DN resolver.
Authenticator.Builder	entryResolver(EntryResolver resolver)	Sets the entry resolver.
Authenticator.Builder	freeze()	Makes this instance immutable.
Authenticator.Builder	requestHandlers(AuthenticationRequestHandler... handlers)	Sets the authentication request handlers.
Authenticator.Builder	responseHandlers(AuthenticationResponseHandler... handlers)	Sets the authentication response handlers.
Authenticator.Builder	returnAttributes(String... attributes)	Sets the return attributes.

Methods inherited from class java.lang.Object

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

Field Details

object

private final Authenticator object

Authenticator to build.

Constructor Details

Builder

private Builder()

Default constructor.

Method Details

freeze

public Authenticator.Builder freeze()

Makes this instance immutable.

Returns:

this builder

dnResolver

public Authenticator.Builder dnResolver(DnResolver resolver)

Sets the DN resolver.

Parameters:

resolver - DN resolver

Returns:

this builder

authenticationHandler

public Authenticator.Builder authenticationHandler(AuthenticationHandler handler)

Sets the authentication handler.

Parameters:

handler - authentication handler

Returns:

this builder

entryResolver

public Authenticator.Builder entryResolver(EntryResolver resolver)

Sets the entry resolver.

Parameters:

resolver - entry resolver

Returns:

this builder

requestHandlers

public Authenticator.Builder requestHandlers(AuthenticationRequestHandler... handlers)

Sets the authentication request handlers.

Parameters:

handlers - request handlers

Returns:

this builder

responseHandlers

public Authenticator.Builder responseHandlers(AuthenticationResponseHandler... handlers)

Sets the authentication response handlers.

Parameters:

handlers - response handlers

Returns:

this builder

returnAttributes

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

Sets the return attributes.

Parameters:

attributes - return attributes

Returns:

this builder

build

public Authenticator build()

Returns the authenticator.

Returns:

authenticator