org.mule.runtime.http.api.client.auth

Interface HttpAuthenticationBuilder

All Known Subinterfaces:

HttpAuthenticationBuilder.HttpNtlmAuthenticationBuilder

public interface HttpAuthenticationBuilder

Allows the creation of HttpAuthentication instances. At the very least, a type, username and password must be provided.

Since:

4.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	HttpAuthenticationBuilder.HttpNtlmAuthenticationBuilder Specification of HttpAuthenticationBuilder for NTLM based authentication.

Method Summary

Modifier and Type	Method and Description
HttpAuthentication	build() Creates the HttpAuthentication as configured.
HttpAuthenticationBuilder	password(String password) Defines the password to use.
HttpAuthenticationBuilder	preemptive(boolean preemptive) Defines whether or not the authentication should be done from the first request.
HttpAuthenticationBuilder	type(HttpAuthenticationType type) Defines the HttpAuthenticationType to use.
HttpAuthenticationBuilder	username(String username) Defines the username to use.

Method Detail

type

HttpAuthenticationBuilder type(HttpAuthenticationType type)

Defines the HttpAuthenticationType to use. Must be provided.

Parameters:

type - the authentication scheme desired

Returns:

this builder

username

HttpAuthenticationBuilder username(String username)

Defines the username to use. Must be provided.

Parameters:

username - for the authentication

Returns:

this builder

password

HttpAuthenticationBuilder password(String password)

Defines the password to use. Must be provided.

Parameters:

password - for the authentication

Returns:

this builder

preemptive

HttpAuthenticationBuilder preemptive(boolean preemptive)

Defines whether or not the authentication should be done from the first request. Default value is true, if false the request will be done awaiting a 401 response with authentication details to start the process.

Parameters:

preemptive - whether or not the authentication process should be started at once

Returns:

this builder

build

HttpAuthentication build()

Creates the HttpAuthentication as configured.

Returns:

a fresh authentication configuration