com.predic8.membrane.core.interceptor

Class AbstractInterceptor

java.lang.Object

com.predic8.membrane.core.config.AbstractXmlElement

com.predic8.membrane.core.config.AbstractConfigElement

com.predic8.membrane.core.interceptor.AbstractInterceptor

All Implemented Interfaces:

XMLElement, Interceptor

Direct Known Subclasses:

AccessControlInterceptor, AdminConsoleInterceptor, AuthHead2BodyInterceptor, BasicAuthenticationInterceptor, ClusterNotificationInterceptor, CoachDBInterceptor, CountInterceptor, DispatchingInterceptor, DynamicAdminPageInterceptor, ExchangeStoreInterceptor, FormValidationInterceptor, GroovyInterceptor, HTTP2XMLInterceptor, HTTPClientInterceptor, LoadBalancingInterceptor, LogInterceptor, RegExReplaceInterceptor, RelocatingInterceptor, REST2SOAPInterceptor, ReverseProxyingInterceptor, RewriteInterceptor, RuleMatchingInterceptor, SimpleURLRewriteInterceptor, SOAPStackTraceFilterInterceptor, StatisticsCSVInterceptor, StatisticsJDBCInterceptor, ThrottleInterceptor, UserFeatureInterceptor, ValidatorInterceptor, WebServerInterceptor, XMLContentFilterInterceptor, XMLProtectionInterceptor, XPathCBRInterceptor, XSLTInterceptor

public class AbstractInterceptor
extends AbstractConfigElement
implements Interceptor

Nested Class Summary

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

Interceptor.Flow

Field Summary

Fields

Modifier and Type	Field and Description
static String	ELEMENT_NAME
protected String	id
protected String	name

Fields inherited from class com.predic8.membrane.core.config.AbstractConfigElement

router

Constructor Summary

Constructors

Constructor and Description
AbstractInterceptor()
AbstractInterceptor(Router router)

Method Summary

Methods

Modifier and Type	Method and Description
String	getDisplayName()
protected String	getElementName()
Interceptor.Flow	getFlow()
String	getHelpId()
String	getId()
String	getLongDescription()
String	getShortDescription()
Outcome	handleRequest(Exchange exc)
Outcome	handleResponse(Exchange exc)
protected void	parseAttributes(XMLStreamReader token)
void	setDisplayName(String name)
void	setFlow(Interceptor.Flow flow)
void	setId(String id)
void	write(XMLStreamWriter out)
protected void	writeInterceptor(XMLStreamWriter out)

Methods inherited from class com.predic8.membrane.core.config.AbstractConfigElement

getRouter, setRouter

Methods inherited from class com.predic8.membrane.core.config.AbstractXmlElement

doAfterParsing, getBoolean, move2RootElementIfNeeded, parse, parseCharacters, parseChildren, toXml, writeIfNotNull

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.predic8.membrane.core.interceptor.Interceptor

getRouter, setRouter

Methods inherited from interface com.predic8.membrane.core.config.XMLElement

parse

Field Detail

ELEMENT_NAME

public static final String ELEMENT_NAME

See Also:

Constant Field Values

name

protected String name

id

protected String id

Constructor Detail

AbstractInterceptor

public AbstractInterceptor()

AbstractInterceptor

public AbstractInterceptor(Router router)

Method Detail

handleRequest

public Outcome handleRequest(Exchange exc)
                      throws Exception

Specified by:

handleRequest in interface Interceptor

Throws:

Exception

handleResponse

public Outcome handleResponse(Exchange exc)
                       throws Exception

Specified by:

handleResponse in interface Interceptor

Throws:

Exception

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface Interceptor

setDisplayName

public void setDisplayName(String name)

Specified by:

setDisplayName in interface Interceptor

getElementName

protected String getElementName()

Overrides:

getElementName in class AbstractXmlElement

parseAttributes

protected void parseAttributes(XMLStreamReader token)
                        throws Exception

Overrides:

parseAttributes in class AbstractXmlElement

Throws:

Exception

write

public void write(XMLStreamWriter out)
           throws XMLStreamException

Specified by:

write in interface XMLElement

Overrides:

write in class AbstractXmlElement

Throws:

XMLStreamException

writeInterceptor

protected void writeInterceptor(XMLStreamWriter out)
                         throws XMLStreamException

Throws:

XMLStreamException

getId

public String getId()

Specified by:

getId in interface Interceptor

setId

public void setId(String id)

Specified by:

setId in interface Interceptor

setFlow

public void setFlow(Interceptor.Flow flow)

Specified by:

setFlow in interface Interceptor

getFlow

public Interceptor.Flow getFlow()

Specified by:

getFlow in interface Interceptor

getShortDescription

public String getShortDescription()

Specified by:

getShortDescription in interface Interceptor

getLongDescription

public String getLongDescription()

Specified by:

getLongDescription in interface Interceptor

getHelpId

public String getHelpId()

Specified by:

getHelpId in interface Interceptor

Returns:

"access-control" if http://membrane-soa.org/esb-doc/current/configuration/reference/access-control.htm is the documentation page for this interceptor, or null if there is no such page.