Package com.predic8.membrane.core.interceptor.administration

Class AdminConsoleInterceptor

java.lang.Object

com.predic8.membrane.core.interceptor.AbstractInterceptor

com.predic8.membrane.core.interceptor.administration.AdminConsoleInterceptor

All Implemented Interfaces:

Interceptor

public class AdminConsoleInterceptor
extends AbstractInterceptor

Description

Displays up-to-date statistics, recent exchanges and, by default, allows live modification of Membrane's configuration.

Topic

5. Monitoring, Logging and Statistics

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
AdminConsoleInterceptor()

Method Summary

Modifier and Type	Method	Description
String	getShortDescription()
Outcome	handleRequest(Exchange exc)
void	init(Router router)
boolean	isReadOnly()
boolean	isUseXForwardedForAsClientAddr()
void	setReadOnly(boolean readOnly)
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

AdminConsoleInterceptor

public AdminConsoleInterceptor()

Method Details

handleRequest

public Outcome handleRequest(Exchange exc)
                      throws Exception

Specified by:

handleRequest in interface Interceptor

Overrides:

handleRequest in class AbstractInterceptor

Throws:

Exception

init

public void init(Router router)
          throws Exception

Specified by:

init in interface Interceptor

Overrides:

init in class AbstractInterceptor

Throws:

Exception

isReadOnly

public boolean isReadOnly()

setReadOnly

public void setReadOnly(boolean readOnly)

Default

false

Description

Whether runtime changes to Membrane's configuration can be committed in the admin console.

isUseXForwardedForAsClientAddr

public boolean isUseXForwardedForAsClientAddr()

setUseXForwardedForAsClientAddr

public void setUseXForwardedForAsClientAddr(boolean useXForwardedForAsClientAddr)

Default

false

Description

whether to show the value of the first "X-Forwarded-For" header instead of the client IP address

getShortDescription

public String getShortDescription()

Specified by:

getShortDescription in interface Interceptor

Overrides:

getShortDescription in class AbstractInterceptor