Package com.predic8.membrane.core.interceptor.swagger

Class SwaggerRewriterInterceptor

java.lang.Object

com.predic8.membrane.core.interceptor.AbstractInterceptor

com.predic8.membrane.core.interceptor.swagger.SwaggerRewriterInterceptor

All Implemented Interfaces:

Interceptor

public class SwaggerRewriterInterceptor
extends AbstractInterceptor

Description

Allow Swagger proxying

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
SwaggerRewriterInterceptor()
SwaggerRewriterInterceptor(SwaggerCompatibleOpenAPI swag)
SwaggerRewriterInterceptor(SwaggerCompatibleOpenAPI swag, boolean rewrite)
SwaggerRewriterInterceptor(SwaggerCompatibleOpenAPI swag, boolean rewrite, String json)
SwaggerRewriterInterceptor(SwaggerCompatibleOpenAPI swag, String swagUrl)

Method Summary

Modifier and Type	Method	Description
String	getShortDescription()
SwaggerCompatibleOpenAPI	getSwagger()
String	getSwaggerJson()
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).
boolean	isRewriteUI()
void	setRewriteUI(boolean rewriteUI)
void	setSwagger(SwaggerCompatibleOpenAPI swagger)
void	setSwaggerJson(String swaggerJson)

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

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

Methods inherited from class java.lang.Object

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

Constructor Details

SwaggerRewriterInterceptor

public SwaggerRewriterInterceptor()

SwaggerRewriterInterceptor

public SwaggerRewriterInterceptor(SwaggerCompatibleOpenAPI swag)

SwaggerRewriterInterceptor

public SwaggerRewriterInterceptor(SwaggerCompatibleOpenAPI swag,
 boolean rewrite)

SwaggerRewriterInterceptor

public SwaggerRewriterInterceptor(SwaggerCompatibleOpenAPI swag,
 boolean rewrite,
 String json)

SwaggerRewriterInterceptor

public SwaggerRewriterInterceptor(SwaggerCompatibleOpenAPI swag,
 String swagUrl)

Method Details

init

public void init()
          throws Exception

Description copied from class: AbstractInterceptor

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

Overrides:

init in class AbstractInterceptor

Throws:

Exception

handleRequest

public Outcome handleRequest(Exchange exc)
                      throws Exception

Specified by:

handleRequest in interface Interceptor

Overrides:

handleRequest in class AbstractInterceptor

Throws:

Exception

handleResponse

public Outcome handleResponse(Exchange exc)
                       throws Exception

Specified by:

handleResponse in interface Interceptor

Overrides:

handleResponse in class AbstractInterceptor

Throws:

Exception

getShortDescription

public String getShortDescription()

Specified by:

getShortDescription in interface Interceptor

Overrides:

getShortDescription in class AbstractInterceptor

getSwagger

public SwaggerCompatibleOpenAPI getSwagger()

setSwagger

public void setSwagger(SwaggerCompatibleOpenAPI swagger)

isRewriteUI

public boolean isRewriteUI()

setRewriteUI

public void setRewriteUI(boolean rewriteUI)

Default

true

Description

Whether a Swagger-UI should also be rewritten.

getSwaggerJson

public String getSwaggerJson()

setSwaggerJson

public void setSwaggerJson(String swaggerJson)

Default

swagger.json

Description

Swagger specification filename. The default is 'swagger.json', which is also recommended.