org.mule.transport.http.filters
Class HttpBasicAuthenticationFilter

java.lang.Object
  org.mule.security.AbstractSecurityFilter
      org.mule.security.AbstractAuthenticationFilter
          org.mule.security.AbstractEndpointSecurityFilter
              org.mule.transport.http.filters.HttpBasicAuthenticationFilter

All Implemented Interfaces:

org.mule.api.context.MuleContextAware, org.mule.api.lifecycle.Initialisable, org.mule.api.security.AuthenticationFilter, org.mule.api.security.EndpointSecurityFilter, org.mule.api.security.SecurityFilter, org.mule.endpoint.EndpointAware

public class HttpBasicAuthenticationFilter
extends org.mule.security.AbstractEndpointSecurityFilter

HttpBasicAuthenticationFilter TODO

Field Summary

protected static Log

logger logger used by this class

Fields inherited from class org.mule.security.AbstractEndpointSecurityFilter

endpoint

Fields inherited from class org.mule.security.AbstractSecurityFilter

muleContext, securityManager

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

PHASE_NAME

Constructor Summary

HttpBasicAuthenticationFilter()

HttpBasicAuthenticationFilter(String realm)

Method Summary

void	authenticateInbound(org.mule.api.MuleEvent event) Authenticates the current message if authenticate is set to true.
void	authenticateOutbound(org.mule.api.MuleEvent event) Authenticates the current message if authenticate is set to true.
protected org.mule.api.security.Authentication	createAuthentication(String username, String password, org.mule.api.MuleEvent event)
protected void	doInitialise()
String	getRealm()
boolean	isRealmRequired()
void	setRealm(String realm)
void	setRealmRequired(boolean realmRequired)
protected void	setUnauthenticated(org.mule.api.MuleEvent event)

Methods inherited from class org.mule.security.AbstractEndpointSecurityFilter

authenticate, doFilter, getEndpoint, setEndpoint

Methods inherited from class org.mule.security.AbstractAuthenticationFilter

getCredentialsAccessor, isAuthenticate, setAuthenticate, setCredentialsAccessor

Methods inherited from class org.mule.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.api.security.AuthenticationFilter

getCredentialsAccessor, setCredentialsAccessor

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

getSecurityManager, getSecurityProviders, setSecurityManager, setSecurityProviders

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

initialise

Field Detail

logger

protected static final Log logger

logger used by this class

Constructor Detail

HttpBasicAuthenticationFilter

public HttpBasicAuthenticationFilter()

HttpBasicAuthenticationFilter

public HttpBasicAuthenticationFilter(String realm)

Method Detail

doInitialise

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

Overrides:

doInitialise in class org.mule.security.AbstractSecurityFilter

Throws:

org.mule.api.lifecycle.InitialisationException

getRealm

public String getRealm()

setRealm

public void setRealm(String realm)

isRealmRequired

public boolean isRealmRequired()

setRealmRequired

public void setRealmRequired(boolean realmRequired)

authenticateInbound

public void authenticateInbound(org.mule.api.MuleEvent event)
                         throws org.mule.api.security.SecurityException,
                                org.mule.api.security.SecurityProviderNotFoundException,
                                org.mule.api.security.UnknownAuthenticationTypeException

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

Specified by:

authenticateInbound in class org.mule.security.AbstractEndpointSecurityFilter

Parameters:

event - the current message recieved

Throws:

org.mule.api.security.SecurityException - if authentication fails

org.mule.api.security.SecurityProviderNotFoundException

org.mule.api.security.UnknownAuthenticationTypeException

createAuthentication

protected org.mule.api.security.Authentication createAuthentication(String username,
                                                                    String password,
                                                                    org.mule.api.MuleEvent event)

setUnauthenticated

protected void setUnauthenticated(org.mule.api.MuleEvent event)

authenticateOutbound

public void authenticateOutbound(org.mule.api.MuleEvent event)
                          throws org.mule.api.security.SecurityException,
                                 org.mule.api.security.SecurityProviderNotFoundException

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

Specified by:

authenticateOutbound in class org.mule.security.AbstractEndpointSecurityFilter

Parameters:

event - the current event being dispatched

Throws:

org.mule.api.security.SecurityException - if authentication fails

org.mule.api.security.SecurityProviderNotFoundException