Package com.predic8.membrane.core.interceptor.misc

Class ReturnInterceptor

java.lang.Object

com.predic8.membrane.core.interceptor.AbstractInterceptor

com.predic8.membrane.core.interceptor.misc.ReturnInterceptor

All Implemented Interfaces:

Interceptor

public class ReturnInterceptor
extends AbstractInterceptor

Description

Terminates the exchange flow. The returned response is determined in the following order:

1. If there is already a response in the exchange, that response is returned 2. If there is no response in the exchange, the body and contentType of the request is copied into a new response.

The options statusCode and contentType will overwrite the values from the messages.

This plugin is useful together with the template plugin. See examples/template.

Topic

4. Interceptors/Features

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

Method Summary

Modifier and Type	Method	Description
String	getContentType()
String	getDisplayName()
String	getShortDescription()
int	getStatusCode()
Outcome	handleRequest(Exchange exc)
void	setContentType(String contentType)
void	setStatusCode(int statusCode)

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

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

Methods inherited from class java.lang.Object

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

Constructor Details

ReturnInterceptor

public ReturnInterceptor()

Method Details

setStatusCode

public void setStatusCode(int statusCode)

getStatusCode

public int getStatusCode()

setContentType

public void setContentType(String contentType)

getContentType

public String getContentType()

handleRequest

public Outcome handleRequest(Exchange exc)
                      throws Exception

Specified by:

handleRequest in interface Interceptor

Overrides:

handleRequest in class AbstractInterceptor

Throws:

Exception

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface Interceptor

Overrides:

getDisplayName in class AbstractInterceptor

getShortDescription

public String getShortDescription()

Specified by:

getShortDescription in interface Interceptor

Overrides:

getShortDescription in class AbstractInterceptor