Package com.predic8.membrane.core.interceptor

Class AbstractInterceptor

java.lang.Object

com.predic8.membrane.core.interceptor.AbstractInterceptor

All Implemented Interfaces:

Interceptor

Direct Known Subclasses:

AbstractFlowInterceptor, AbstractInterceptorWithSession, AbstractScriptInterceptor, AbstractSetterInterceptor, AccessControlInterceptor, AccessLogInterceptor, AcmeHttpChallengeInterceptor, AdminConsoleInterceptor, ApiDocsInterceptor, ApiKeyCheckerInterceptor, ApiKeysInterceptor, ApiManagementInterceptor, ApisJsonInterceptor, AuthHead2BodyInterceptor, BasicAuthenticationInterceptor, BeautifierInterceptor, CacheInterceptor, ClamAntiVirusInterceptor, ClusterNotificationInterceptor, CountInterceptor, DecoupledEndpointRewriterInterceptor, DispatchingInterceptor, DynamicAdminPageInterceptor, ExchangeStoreInterceptor, FlowInitiator, FormValidationInterceptor, GateKeeperClientInterceptor, GraphQLProtectionInterceptor, GreaseInterceptor, GroovyTemplateInterceptor, HeaderFilterInterceptor, HTTP2XMLInterceptor, HTTPClientInterceptor, IndexInterceptor, Json2XmlInterceptor, JsonPointerExtractorInterceptor, JsonProtectionInterceptor, JwtAuthInterceptor, KubernetesValidationInterceptor, LimitInterceptor, LoadBalancingInterceptor, LoggingContextInterceptor, LoginInterceptor, LogInterceptor, MessageAnalyser, MethodOverrideInterceptor, NtlmInterceptor, OAuth2AuthorizationServerInterceptor, OAuth2PermissionCheckerInterceptor, OAuth2ResourceInterceptor, OAuth2TokenValidatorInterceptor, OpenAPIInterceptor, OpenAPIPublisherInterceptor, OpenTelemetryInterceptor, PaddingHeaderInterceptor, PrometheusInterceptor, RateLimitInterceptor, RegExReplaceInterceptor, RegistrationInterceptor, RelocatingInterceptor, ReplaceInterceptor, RequireAuth, REST2SOAPInterceptor, RESTInterceptor, ReturnInterceptor, ReverseProxyingInterceptor, RewriteInterceptor, RouterIpResolverInterceptor, RuleMatchingInterceptor, SampleSoapServiceInterceptor, ShadowingInterceptor, ShutdownInterceptor, SOAP2RESTInterceptor, SoapOperationExtractor, SOAPStackTraceFilterInterceptor, SPDYInterceptor, SpringInterceptor, StaticInterceptor, StatisticsCSVInterceptor, StatisticsJDBCInterceptor, StatisticsProvider, STOMPClient, SwaggerApiKeyRequirer, SwaggerRewriterInterceptor, TCPInterceptor, TestServiceInterceptor, ThrottleInterceptor, URLNormalizerInterceptor, UserFeatureInterceptor, ValidatorInterceptor, WebServerInterceptor, WebSocketInterceptor, WsaEndpointRewriterInterceptor, WSDLPublisherInterceptor, XenAuthenticationInterceptor, Xml2JsonInterceptor, XMLContentFilterInterceptor, XmlPathExtractorInterceptor, XMLProtectionInterceptor, XPathCBRInterceptor, XSLTInterceptor

public class AbstractInterceptor
extends Object
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	Description
protected String	name
protected Router	router

Constructor Summary

Constructors

Constructor	Description
AbstractInterceptor()

Method Summary

Modifier and Type	Method	Description
String	getDisplayName()
EnumSet<Interceptor.Flow>	getFlow()
final String	getHelpId()
String	getLongDescription()
static Message	getMessage(Exchange exc, Interceptor.Flow flow)
Router	getRouter()
<T extends Rule> T	getRule()
String	getShortDescription()
void	handleAbort(Exchange exchange)	Called when any Interceptor.handleRequest(Exchange) or Interceptor.handleResponse(Exchange) later in the chain returned Outcome.ABORT or threw an exception.
Outcome	handleRequest(Exchange exc)
Outcome	handleResponse(Exchange exc)
void	init()	Called after parsing is complete and this has been added to the object tree (whose root is Router).
void	init(Router router)
void	setDisplayName(String name)
void	setFlow(EnumSet<Interceptor.Flow> flow)

Methods inherited from class java.lang.Object

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

Field Details

name

protected String name

router

protected Router router

Constructor Details

AbstractInterceptor

public AbstractInterceptor()

Method Details

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

handleAbort

public void handleAbort(Exchange exchange)

Description copied from interface: Interceptor

Called when any Interceptor.handleRequest(Exchange) or Interceptor.handleResponse(Exchange) later in the chain returned Outcome.ABORT or threw an exception.

handleAbort is called in the reverse order of the chain (as handleResponse is).

Specified by:

handleAbort in interface Interceptor

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface Interceptor

setDisplayName

public void setDisplayName(String name)

Specified by:

setDisplayName in interface Interceptor

setFlow

public void setFlow(EnumSet<Interceptor.Flow> flow)

Specified by:

setFlow in interface Interceptor

getFlow

public EnumSet<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 final String getHelpId()

Specified by:

getHelpId in interface Interceptor

Returns:

"accessControl" if https://membrane-soa.org/service-proxy-doc/current/configuration/reference/accessControl.htm is the documentation page for this interceptor, or null if there is no such page.

init

public void init()
          throws Exception

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

Throws:

Exception

init

public void init(Router router)
          throws Exception

Specified by:

init in interface Interceptor

Throws:

Exception

getRule

public <T extends Rule> T getRule()

getRouter

public Router getRouter()

Specified by:

getRouter in interface Interceptor

getMessage

public static Message getMessage(Exchange exc,
 Interceptor.Flow flow)