Package com.predic8.membrane.core.interceptor.acl

Class AccessControlInterceptor

java.lang.Object

com.predic8.membrane.core.interceptor.AbstractInterceptor

com.predic8.membrane.core.interceptor.acl.AccessControlInterceptor

All Implemented Interfaces:

Interceptor

public class AccessControlInterceptor
extends AbstractInterceptor

Description

Blocks requests whose origin TCP/IP address (hostname or IP address) is not allowed to access the requested resource.

Topic

6. Security

Nested Class Summary

Nested classes/interfaces inherited from interface com.predic8.membrane.core.interceptor.Interceptor

Interceptor.Flow

Field Summary

Fields inherited from class com.predic8.membrane.core.interceptor.AbstractInterceptor

name, router

Constructor Summary

Constructors

Constructor	Description
AccessControlInterceptor()

Method Summary

Modifier and Type	Method	Description
AccessControl	getAccessControl()
String	getFile()
String	getShortDescription()
Outcome	handleRequest(Exchange exc)
void	init()	Called after parsing is complete and this has been added to the object tree (whose root is Router).
boolean	isUseXForwardedForAsClientAddr()
protected AccessControl	parse(String fileName, Router router)
void	setAccessControl(AccessControl ac)
void	setFile(String file)
void	setUseXForwardedForAsClientAddr(boolean useXForwardedForAsClientAddr)

Methods inherited from class com.predic8.membrane.core.interceptor.AbstractInterceptor

getDisplayName, getFlow, getHelpId, getLongDescription, getMessage, getRouter, getRule, handleAbort, handleResponse, init, setDisplayName, setFlow

Methods inherited from class java.lang.Object

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

Constructor Details

AccessControlInterceptor

public AccessControlInterceptor()

Method Details

handleRequest

public Outcome handleRequest(Exchange exc)
                      throws Exception

Specified by:

handleRequest in interface Interceptor

Overrides:

handleRequest in class AbstractInterceptor

Throws:

Exception

isUseXForwardedForAsClientAddr

public boolean isUseXForwardedForAsClientAddr()

setUseXForwardedForAsClientAddr

public void setUseXForwardedForAsClientAddr(boolean useXForwardedForAsClientAddr)

Default

false

Description

whether to use the last value of the last "X-Forwarded-For" header instead of the remote IP address

setFile

public void setFile(String file)

Description

Location of the ACL file.

Example

acl/acl.xml

getFile

public String getFile()

init

public void init()
          throws Exception

Description copied from class: AbstractInterceptor

Called after parsing is complete and this has been added to the object tree (whose root is Router).

Overrides:

init in class AbstractInterceptor

Throws:

Exception

setAccessControl

public void setAccessControl(AccessControl ac)

getAccessControl

public AccessControl getAccessControl()

parse

protected AccessControl parse(String fileName,
 Router router)
                       throws Exception

Throws:

Exception

getShortDescription

public String getShortDescription()

Specified by:

getShortDescription in interface Interceptor

Overrides:

getShortDescription in class AbstractInterceptor