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

Interface HttpAuthentication

All Known Subinterfaces:

HttpAuthentication.HttpNtlmAuthentication

public interface HttpAuthentication

Represents an HTTP request's username/password based authentication.

Since:

4.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	HttpAuthentication.HttpNtlmAuthentication Represents an HTTP request's NTLM based authentication.

Method Summary

Modifier and Type	Method and Description
static HttpAuthenticationBuilder	basic(String username, String password) Provides a HttpAuthenticationBuilder already set up for basic authentication.
static HttpAuthenticationBuilder	builder() Provides a HttpAuthenticationBuilder to create instances of HttpAuthentication.
static HttpAuthenticationBuilder	digest(String username, String password) Provides a HttpAuthenticationBuilder already set up for digest authentication.
String	getPassword() The password defined.
HttpAuthenticationType	getType() The type of authentication defined.
String	getUsername() The username defined.
boolean	isPreemptive() Whether or not the authentication should be done from the first request.
static HttpAuthenticationBuilder.HttpNtlmAuthenticationBuilder	ntlm(String username, String password) Provides a HttpAuthenticationBuilder.HttpNtlmAuthenticationBuilder to create instances of HttpAuthentication.HttpNtlmAuthentication.

Method Detail

builder

static HttpAuthenticationBuilder builder()

Provides a HttpAuthenticationBuilder to create instances of HttpAuthentication.

Returns:

a fresh builder

basic

static HttpAuthenticationBuilder basic(String username,
                                       String password)

Provides a HttpAuthenticationBuilder already set up for basic authentication.

Parameters:

username - the username desired

password - the password desired

Returns:

a builder pre-configured for basic authentication

digest

static HttpAuthenticationBuilder digest(String username,
                                        String password)

Provides a HttpAuthenticationBuilder already set up for digest authentication.

Parameters:

username - the username desired

password - the password desired

Returns:

a builder pre-configured for digest authentication

ntlm

static HttpAuthenticationBuilder.HttpNtlmAuthenticationBuilder ntlm(String username,
                                                                    String password)

Provides a HttpAuthenticationBuilder.HttpNtlmAuthenticationBuilder to create instances of HttpAuthentication.HttpNtlmAuthentication.

Parameters:

username - the username desired

password - the password desired

Returns:

a builder pre-configured for NTLM authentication

getType

HttpAuthenticationType getType()

The type of authentication defined.

Returns:

the HttpAuthenticationType

getUsername

String getUsername()

The username defined.

Returns:

the username

getPassword

String getPassword()

The password defined.

Returns:

the password

isPreemptive

boolean isPreemptive()

Whether or not the authentication should be done from the first request. If false the request will be done awaiting a 401 response with authentication details to start the process.

Returns:

whether the authentication should be preemptive or not