org.mule.module.http.api

Interface HttpAuthentication

All Known Implementing Classes:

DefaultHttpAuthentication

public interface HttpAuthentication

An object that authenticates an HTTP request.

Method Summary

Methods

Modifier and Type	Method and Description
void	authenticate(MuleEvent muleEvent, HttpRequestBuilder builder) Adds authentication information to the request.
boolean	shouldRetry(MuleEvent firstAttemptResponseEvent) Detects if there was an authentication failure in the response.

Method Detail

authenticate

void authenticate(MuleEvent muleEvent,
                HttpRequestBuilder builder)
                  throws MuleException

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.

Parameters:

muleEvent - The event that is being processed.

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

Throws:

MuleException

shouldRetry

boolean shouldRetry(MuleEvent firstAttemptResponseEvent)
                    throws MuleException

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.

Parameters:

firstAttemptResponseEvent - The event with the response of the request.

Returns:

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

Throws:

MuleException