Package com.predic8.membrane.core.openapi.serviceproxy

Class APIProxy

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.openapi.serviceproxy.APIProxy

All Implemented Interfaces:

Rule, Cloneable

public class APIProxy
extends ServiceProxy

Description

The api proxy extends the serviceProxy with API related functions like OpenAPI support.

Topic

2. Proxies

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	APIProxy.ApiDescription

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

AbstractServiceProxy.Target

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,OpenAPIRecord>	apiRecords
protected Map<String,OpenAPIRecord>	basePaths
static final String	REQUESTS
static final String	RESPONSES
static final String	SECURITY
protected List<OpenAPISpec>	specs
protected ValidationStatisticsCollector	statisticCollector
static final String	VALIDATION_DETAILS
static final String	X_MEMBRANE_ID
static final String	X_MEMBRANE_VALIDATION

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

Method Summary

Modifier and Type	Method	Description
Map<String,OpenAPIRecord>	getApiRecords()
Map<String,OpenAPIRecord>	getBasePaths()
APIProxy.ApiDescription	getDescription()
String	getId()
protected AbstractProxy	getNewInstance()
List<OpenAPISpec>	getSpecs()
String	getTest()
ValidationStatisticsCollector	getValidationStatisticCollector()
void	init()
void	setDescription(APIProxy.ApiDescription description)
void	setId(String id)
void	setSpecs(List<OpenAPISpec> specs)
void	setTest(String test)

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

Field Details

X_MEMBRANE_VALIDATION

public static final String X_MEMBRANE_VALIDATION

See Also:

• Constant Field Values

X_MEMBRANE_ID

public static final String X_MEMBRANE_ID

See Also:

• Constant Field Values

REQUESTS

public static final String REQUESTS

See Also:

• Constant Field Values

RESPONSES

public static final String RESPONSES

See Also:

• Constant Field Values

SECURITY

public static final String SECURITY

See Also:

• Constant Field Values

VALIDATION_DETAILS

public static final String VALIDATION_DETAILS

See Also:

• Constant Field Values

apiRecords

protected Map<String,OpenAPIRecord> apiRecords

basePaths

protected Map<String,OpenAPIRecord> basePaths

statisticCollector

protected ValidationStatisticsCollector statisticCollector

specs

protected List<OpenAPISpec> specs

Constructor Details

APIProxy

public APIProxy()

Method Details

getNewInstance

protected AbstractProxy getNewInstance()

Overrides:

getNewInstance in class ServiceProxy

getSpecs

public List<OpenAPISpec> getSpecs()

setSpecs

public void setSpecs(List<OpenAPISpec> specs)

Description

Deploys an API from an OpenAPI document.

init

public void init()
          throws Exception

Overrides:

init in class ServiceProxy

Throws:

Exception

getValidationStatisticCollector

public ValidationStatisticsCollector getValidationStatisticCollector()

getApiRecords

public Map<String,OpenAPIRecord> getApiRecords()

getBasePaths

public Map<String,OpenAPIRecord> getBasePaths()

getTest

public String getTest()

setTest

public void setTest(String test)

getId

public String getId()

getDescription

public APIProxy.ApiDescription getDescription()

setId

public void setId(String id)

setDescription

public void setDescription(APIProxy.ApiDescription description)