Package com.predic8.membrane.core.rules

Class ServiceProxy

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

All Implemented Interfaces:

Rule, Cloneable

Direct Known Subclasses:

APIProxy, SwaggerProxy

public class ServiceProxy
extends AbstractServiceProxy

Description

A service proxy can be deployed on front of a Web server, Web Service or a REST resource. It conceals the server and offers the same interface as the target server to its clients.

Topic

2. Proxies

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
ServiceProxy()
ServiceProxy(ServiceProxyKey ruleKey, String targetHost, int targetPort)

Method Summary

Modifier and Type	Method	Description
boolean	etcdRegistryApiConfigExists()
String	getExternalHostname()
String	getMethod()
protected AbstractProxy	getNewInstance()
AbstractServiceProxy.Target	getTarget()
boolean	hasAdminConsole()
void	init()
void	setExternalHostname(String externalHostname)
void	setMethod(String method)
void	setTarget(AbstractServiceProxy.Target target)
void	setTargetHost(String targetHost)
void	setTargetPort(int targetPort)
void	setTargetURL(String targetURL)

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

ServiceProxy

public ServiceProxy()

ServiceProxy

public ServiceProxy(ServiceProxyKey ruleKey,
 String targetHost,
 int targetPort)

Method Details

init

public void init()
          throws Exception

Overrides:

init in class AbstractServiceProxy

Throws:

Exception

hasAdminConsole

public boolean hasAdminConsole()

etcdRegistryApiConfigExists

public boolean etcdRegistryApiConfigExists()

getNewInstance

protected AbstractProxy getNewInstance()

Specified by:

getNewInstance in class AbstractProxy

getMethod

public String getMethod()

setMethod

public void setMethod(String method)

Default

*

Description

If set, Membrane will only consider this rule, if the method (GET, PUT, POST, DELETE, etc.) header of incoming HTTP requests matches. The asterisk '*' matches any method.

Example

GET

getExternalHostname

public String getExternalHostname()

setExternalHostname

public void setExternalHostname(String externalHostname)

getTarget

public AbstractServiceProxy.Target getTarget()

setTarget

public void setTarget(AbstractServiceProxy.Target target)

setTargetHost

public void setTargetHost(String targetHost)

setTargetPort

public void setTargetPort(int targetPort)

setTargetURL

public void setTargetURL(String targetURL)