org.mule.extension.http.api.request.authentication

Class UsernamePasswordAuthentication

java.lang.Object

org.mule.extension.http.api.request.authentication.UsernamePasswordAuthentication

All Implemented Interfaces:

HttpAuthentication

Direct Known Subclasses:

BasicAuthentication, DigestAuthentication, NtlmAuthentication

public abstract class UsernamePasswordAuthentication
extends Object
implements HttpAuthentication

Base class for user/pass based implementations.

Since:

4.0

Constructor Summary

Constructors

Constructor and Description
UsernamePasswordAuthentication()

Method Summary

Modifier and Type	Method and Description
void	authenticate(Event muleEvent, HttpRequestBuilder builder) Adds authentication information to the request.
abstract HttpRequestAuthentication	buildRequestAuthentication()
protected HttpRequestAuthentication	getBaseRequestAuthentication(HttpAuthenticationType authType)
boolean	shouldRetry(Event firstAttemptResponseEvent) Detects if there was an authentication failure in the response.

Methods inherited from class java.lang.Object

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

Constructor Detail

UsernamePasswordAuthentication

public UsernamePasswordAuthentication()

Method Detail

authenticate

public void authenticate(Event muleEvent,
                         HttpRequestBuilder builder)
                  throws org.mule.runtime.api.exception.MuleException

Description copied from interface: HttpAuthentication

Adds authentication information to the request. This method will be executed before creating and sending the request. Implementations will usually add some authentication header, but there is no restriction on this.

Specified by:

authenticate in interface HttpAuthentication

Parameters:

muleEvent - The event that is being processed.

builder - The builder that is being used to create the HTTP request.

Throws:

org.mule.runtime.api.exception.MuleException

shouldRetry

public boolean shouldRetry(Event firstAttemptResponseEvent)
                    throws org.mule.runtime.api.exception.MuleException

Description copied from interface: HttpAuthentication

Detects if there was an authentication failure in the response. After sending an HTTP request and creating an event with the response, this method will be executed. If it returns false, the flow continues executing. If it returns true, the requester will try to send the request again.

Specified by:

shouldRetry in interface HttpAuthentication

Parameters:

firstAttemptResponseEvent - The event with the response of the request.

Returns:

True if the request should be sent again, false otherwise.

Throws:

org.mule.runtime.api.exception.MuleException

buildRequestAuthentication

public abstract HttpRequestAuthentication buildRequestAuthentication()

getBaseRequestAuthentication

protected HttpRequestAuthentication getBaseRequestAuthentication(HttpAuthenticationType authType)