Package com.predic8.membrane.core.interceptor

Interface Interceptor

All Known Implementing Classes:

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

public interface Interceptor

TODO describe in short what an interceptor is.

Interceptor implementations need to be thread safe.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	Interceptor.Flow

Method Summary

Modifier and Type	Method	Description
String	getDisplayName()
EnumSet<Interceptor.Flow>	getFlow()
String	getHelpId()
String	getLongDescription()
Router	getRouter()
String	getShortDescription()
void	handleAbort(Exchange exchange)	Called when any handleRequest(Exchange) or handleResponse(Exchange) later in the chain returned Outcome.ABORT or threw an exception.
Outcome	handleRequest(Exchange exc)
Outcome	handleResponse(Exchange exc)
void	init(Router router)
void	setDisplayName(String name)
void	setFlow(EnumSet<Interceptor.Flow> flow)

Method Details

handleRequest

Outcome handleRequest(Exchange exc)
               throws Exception

Throws:

Exception

handleResponse

Outcome handleResponse(Exchange exc)
                throws Exception

Throws:

Exception

handleAbort

void handleAbort(Exchange exchange)

Called when any handleRequest(Exchange) or 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).

getDisplayName

String getDisplayName()

setDisplayName

void setDisplayName(String name)

getRouter

Router getRouter()

setFlow

void setFlow(EnumSet<Interceptor.Flow> flow)

getFlow

EnumSet<Interceptor.Flow> getFlow()

getShortDescription

String getShortDescription()

getLongDescription

String getLongDescription()

getHelpId

String getHelpId()

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

void init(Router router)
   throws Exception

Throws:

Exception