Package org.glassfish.tyrus.client.auth

Class AuthConfig.Builder

java.lang.Object

org.glassfish.tyrus.client.auth.AuthConfig.Builder

Enclosing class:

AuthConfig

public static final class AuthConfig.Builder
extends Object

The AuthConfig.Builder is a class used for creating an instance of AuthConfig for purpose of HTTP Authentication.

Example 1 - building an authentication configuration enhanced with user defined NTLM authentication and overridden Basic Authentication:

 AuthConfig authConfig = AuthConfig.Builder.create().
                          registerAuthProvider("NTLM", myAuthenticator).
                          registerAuthProvider("Basic", myBasicAuthenticator).
                          build();
 

Example 2 - Building an authentication configuration with disabled Basic scheme authenticator:

 AuthConfig authConfig = AuthConfig.Builder.create().
                          disableProvidedBasicAuth().
                          build();
 

See Also:

• Credentials
• Authenticator

Method Summary

Modifier and Type	Method	Description
AuthConfig	build()	Build an instance of AuthConfig.
static AuthConfig.Builder	create()	Create new AuthConfig.Builder instance, which contains provided Basic and Digest authenticators.
final AuthConfig.Builder	disableProvidedBasicAuth()	Disable provided Basic Authenticator.
final AuthConfig.Builder	disableProvidedDigestAuth()	Disable provided Digest Authenticator.
final AuthConfig.Builder	registerAuthProvider(String scheme, Authenticator authenticator)	Register Authenticator for provided authentication scheme.

Methods inherited from class java.lang.Object

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

Method Details

create

public static AuthConfig.Builder create()

Create new AuthConfig.Builder instance, which contains provided Basic and Digest authenticators.

Returns:

AuthConfig.Builder instance.

registerAuthProvider

public final AuthConfig.Builder registerAuthProvider(String scheme,
 Authenticator authenticator)

Register Authenticator for provided authentication scheme.

Only one Authenticator for one authentication scheme can be registered. If current builder instance already contains Authenticator for provided scheme, existing authenticator will be replaced. Note that schemes are compared in case insensitive manner.

Parameters:

scheme - authentication scheme for which the registered authenticator will be used. Scheme is compared case insensitive.

authenticator - Authenticator instance to be registered.

Returns:

updated AuthConfig.Builder instance.

disableProvidedBasicAuth

public final AuthConfig.Builder disableProvidedBasicAuth()

Disable provided Basic Authenticator.

Returns:

updated AuthConfig.Builder instance.

disableProvidedDigestAuth

public final AuthConfig.Builder disableProvidedDigestAuth()

Disable provided Digest Authenticator.

Returns:

updated AuthConfig.Builder instance.

build

public AuthConfig build()

Build an instance of AuthConfig.

Returns:

an instance of AuthConfig.