io.apimatic.core.authentication

Class AuthBuilder

java.lang.Object

io.apimatic.core.authentication.AuthBuilder

public class AuthBuilder
extends Object

A builder for authentication.

Constructor Summary

Constructors

Constructor and Description
AuthBuilder() Default constructor.

Method Summary

Modifier and Type	Method and Description
AuthBuilder	add(String authKey) Registers the authentication key to the builder.
AuthBuilder	and(java.util.function.Consumer<AuthBuilder> action) Registers the and group for authentication.
io.apimatic.coreinterfaces.authentication.Authentication	build(Map<String,io.apimatic.coreinterfaces.authentication.Authentication> authManagers) Builds and validates the authentication using registered authentication keys.
AuthBuilder	copy()
AuthBuilder	or(java.util.function.Consumer<AuthBuilder> action) Registers the or group for authentication.

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthBuilder

public AuthBuilder()

Default constructor.

Method Detail

add

public AuthBuilder add(String authKey)

Registers the authentication key to the builder.

Parameters:

authKey - A key pointing to some authentication in the provided auth managers.

Returns:

AuthBuilder The instance of the current builder.

and

public AuthBuilder and(java.util.function.Consumer<AuthBuilder> action)

Registers the and group for authentication.

Parameters:

action - A consumer for the nested builder.

Returns:

AuthBuilder The instance of the current builder.

or

public AuthBuilder or(java.util.function.Consumer<AuthBuilder> action)

Registers the or group for authentication.

Parameters:

action - A consumer for the nested builder.

Returns:

AuthBuilder The instance of the current builder.

build

public io.apimatic.coreinterfaces.authentication.Authentication build(Map<String,io.apimatic.coreinterfaces.authentication.Authentication> authManagers)

Builds and validates the authentication using registered authentication keys.

Parameters:

authManagers - The map of authentication managers.

Returns:

Authentication The validated instance of authentication.

copy

public AuthBuilder copy()

Returns:

A copy of this AuthBuilder instance.