Package com.predic8.membrane.core.rules

Class SwaggerProxy

java.lang.Object

com.predic8.membrane.core.rules.AbstractProxy

com.predic8.membrane.core.rules.SSLableProxy

com.predic8.membrane.core.rules.AbstractServiceProxy

com.predic8.membrane.core.rules.ServiceProxy

com.predic8.membrane.core.rules.SwaggerProxy

All Implemented Interfaces:

Rule, Cloneable

public class SwaggerProxy
extends ServiceProxy

Description

A service proxy that handles Swagger REST API calls. It includes a SwaggerRewriterInterceptor ex factory.

Nested Class Summary

Nested classes/interfaces inherited from class com.predic8.membrane.core.rules.AbstractServiceProxy

AbstractServiceProxy.Target

Field Summary

Fields inherited from class com.predic8.membrane.core.rules.AbstractServiceProxy

target

Fields inherited from class com.predic8.membrane.core.rules.AbstractProxy

blockRequest, blockResponse, interceptors, key, localHost, name, router

Constructor Summary

Constructors

Constructor	Description
SwaggerProxy()
SwaggerProxy(SwaggerProxyKey ruleKey, String targetHost, int targetPort)

Method Summary

Modifier and Type	Method	Description
protected AbstractProxy	getNewInstance()
SwaggerCompatibleOpenAPI	getSwagger()
String	getUrl()
void	init()
boolean	isAllowUI()
void	setAllowUI(boolean allowUI)
void	setUrl(String swaggerUrl)

Methods inherited from class com.predic8.membrane.core.rules.ServiceProxy

etcdRegistryApiConfigExists, getExternalHostname, getMethod, getTarget, hasAdminConsole, setExternalHostname, setMethod, setTarget, setTargetHost, setTargetPort, setTargetURL

Methods inherited from class com.predic8.membrane.core.rules.AbstractServiceProxy

getHost, getPath, getTargetHost, getTargetPort, getTargetScheme, getTargetSSL, getTargetURL, isTargetAdjustHostHeader, setHost, setPath

Methods inherited from class com.predic8.membrane.core.rules.SSLableProxy

getIp, getName, getPort, getSslOutboundContext, setIp, setPort, setSslOutboundContext

Methods inherited from class com.predic8.membrane.core.rules.AbstractProxy

clone, getErrorState, getInterceptors, getKey, getSslInboundContext, getSslInboundParser, getStatisticCollector, init, isActive, isBlockRequest, isBlockResponse, setBlockRequest, setBlockResponse, setInterceptors, setKey, setName, setSslInboundContext, setSslInboundParser, toString

Methods inherited from class java.lang.Object

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

Constructor Details

SwaggerProxy

public SwaggerProxy()

SwaggerProxy

public SwaggerProxy(SwaggerProxyKey ruleKey,
 String targetHost,
 int targetPort)

Method Details

getNewInstance

protected AbstractProxy getNewInstance()

Overrides:

getNewInstance in class ServiceProxy

init

public void init()
          throws Exception

Overrides:

init in class ServiceProxy

Throws:

Exception

getUrl

public String getUrl()

setUrl

public void setUrl(String swaggerUrl)

Description

The Swagger URL. Preferably ends with 'swagger.json'.

Example

...

isAllowUI

public boolean isAllowUI()

setAllowUI

public void setAllowUI(boolean allowUI)

Default

true

Description

Whether to allow Swagger UI forwarding

getSwagger

public SwaggerCompatibleOpenAPI getSwagger()