org.mule.extension.http.api.listener

Class HttpBasicAuthenticationFilter

java.lang.Object

org.mule.runtime.core.security.AbstractSecurityFilter

org.mule.runtime.core.security.AbstractAuthenticationFilter

org.mule.extension.http.api.listener.HttpBasicAuthenticationFilter

All Implemented Interfaces:

org.mule.runtime.api.lifecycle.Initialisable, MuleContextAware, AuthenticationFilter, SecurityFilter

public class HttpBasicAuthenticationFilter
extends AbstractAuthenticationFilter

Filter for basic authentication over an HTTP request

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.apache.commons.logging.Log	logger

Fields inherited from class org.mule.runtime.core.security.AbstractSecurityFilter

muleContext, securityManager

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

PHASE_NAME

Constructor Summary

Constructors

Constructor and Description
HttpBasicAuthenticationFilter() Creates a filter based on the HTTP listener error response builder status code and headers configuration.

Method Summary

Modifier and Type	Method and Description
Event	authenticate(Event event) Authenticates the current message if authenticate is set to true.
protected Authentication	createAuthentication(String username, String password, Event event)
protected void	doInitialise()
String	getRealm()
boolean	isRealmRequired()
void	setRealm(String realm)
void	setRealmRequired(boolean realmRequired)
protected Event	setUnauthenticated(Event event, InternalMessage message)

Methods inherited from class org.mule.runtime.core.security.AbstractAuthenticationFilter

doFilter, getCredentialsAccessor, isAuthenticate, setAuthenticate, setCredentialsAccessor

Methods inherited from class org.mule.runtime.core.security.AbstractSecurityFilter

getSecurityManager, getSecurityProviders, initialise, setMuleContext, setSecurityManager, setSecurityProviders, updatePayload

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mule.runtime.core.api.security.SecurityFilter

getSecurityManager, getSecurityProviders, setSecurityManager, setSecurityProviders

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

initialise

Field Detail

logger

protected static final org.apache.commons.logging.Log logger

Constructor Detail

HttpBasicAuthenticationFilter

public HttpBasicAuthenticationFilter()

Creates a filter based on the HTTP listener error response builder status code and headers configuration.

Method Detail

doInitialise

protected void doInitialise()
                     throws org.mule.runtime.api.lifecycle.InitialisationException

Overrides:

doInitialise in class AbstractSecurityFilter

Throws:

org.mule.runtime.api.lifecycle.InitialisationException

getRealm

public String getRealm()

setRealm

public void setRealm(String realm)

isRealmRequired

public boolean isRealmRequired()

setRealmRequired

public void setRealmRequired(boolean realmRequired)

createAuthentication

protected Authentication createAuthentication(String username,
                                              String password,
                                              Event event)

setUnauthenticated

protected Event setUnauthenticated(Event event,
                                   InternalMessage message)

authenticate

public Event authenticate(Event event)
                   throws SecurityException,
                          UnknownAuthenticationTypeException,
                          CryptoFailureException,
                          SecurityProviderNotFoundException,
                          EncryptionStrategyNotFoundException,
                          org.mule.runtime.api.lifecycle.InitialisationException

Authenticates the current message if authenticate is set to true. This method will always populate the secure context in the Event session

Specified by:

authenticate in interface AuthenticationFilter

Specified by:

authenticate in class AbstractAuthenticationFilter

Parameters:

event - the current message received

Throws:

SecurityException - if authentication fails

UnknownAuthenticationTypeException

CryptoFailureException

SecurityProviderNotFoundException

EncryptionStrategyNotFoundException

org.mule.runtime.api.lifecycle.InitialisationException