org.mule.runtime.module.http.internal.request

Class DefaultHttpAuthentication

java.lang.Object

org.mule.runtime.module.http.internal.request.DefaultHttpAuthentication

All Implemented Interfaces:

org.mule.runtime.api.lifecycle.Initialisable, MuleContextAware, HttpAuthentication

public class DefaultHttpAuthentication
extends Object
implements HttpAuthentication, MuleContextAware, org.mule.runtime.api.lifecycle.Initialisable

Field Summary

Fields inherited from interface org.mule.runtime.api.lifecycle.Initialisable

PHASE_NAME

Constructor Summary

Constructors

Constructor and Description
DefaultHttpAuthentication(HttpAuthenticationType type)

Method Summary

Modifier and Type	Method and Description
void	authenticate(Event muleEvent, HttpRequestBuilder requestBuilder) Adds authentication information to the request.
String	getDomain()
String	getPassword()
String	getPreemptive()
HttpAuthenticationType	getType()
String	getUsername()
String	getWorkstation()
void	initialise()
HttpRequestAuthentication	resolveRequestAuthentication(Event event)
void	setDomain(String domain)
void	setMuleContext(MuleContext muleContext)
void	setPassword(String password)
void	setPreemptive(String preemptive)
void	setUsername(String username)
void	setWorkstation(String workstation)
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

DefaultHttpAuthentication

public DefaultHttpAuthentication(HttpAuthenticationType type)

Method Detail

initialise

public void initialise()
                throws org.mule.runtime.api.lifecycle.InitialisationException

Specified by:

initialise in interface org.mule.runtime.api.lifecycle.Initialisable

Throws:

org.mule.runtime.api.lifecycle.InitialisationException

getUsername

public String getUsername()

setUsername

public void setUsername(String username)

getPassword

public String getPassword()

setPassword

public void setPassword(String password)

getDomain

public String getDomain()

setDomain

public void setDomain(String domain)

getType

public HttpAuthenticationType getType()

getWorkstation

public String getWorkstation()

setWorkstation

public void setWorkstation(String workstation)

getPreemptive

public String getPreemptive()

setPreemptive

public void setPreemptive(String preemptive)

setMuleContext

public void setMuleContext(MuleContext muleContext)

Specified by:

setMuleContext in interface MuleContextAware

resolveRequestAuthentication

public HttpRequestAuthentication resolveRequestAuthentication(Event event)

authenticate

public void authenticate(Event muleEvent,
                         HttpRequestBuilder requestBuilder)

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.

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

shouldRetry

public boolean shouldRetry(Event firstAttemptResponseEvent)

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.