io.fabric8.gateway.model

Class HttpProxyRule

java.lang.Object

io.fabric8.gateway.model.HttpProxyRule

public class HttpProxyRule
extends Object

Represents a HTTP mapping rule from an input URI pattern to some back end service

Constructor Summary

Constructors

Constructor and Description
HttpProxyRule()
HttpProxyRule(String uriTemplate)

Method Summary

Methods

Modifier and Type	Method and Description
UriTemplateDefinition	chooseBackEndService(ClientRequestFacade requestFacade) Chooses a back end service from the set of destination templates
String	getCookieDomain() Returns the value that should be used when rewriting the domain attribute of the Set-Cookie header.
String	getCookiePath() Returns the value that should be used when rewriting the path attribute of the Set-Cookie header.
Set<UriTemplateDefinition>	getDestinationUriTemplates()
LoadBalancerDefinition	getLoadBalancer() Returns the kind of load balancing strategy used to bridge from
UriTemplateDefinition	getUriTemplate()
UriTemplate	getUriTemplateObject()
boolean	isReverseHeaders() Returns whether or not reverseHeaders is enabled.
MappingResult	matches(String[] paths)
HttpProxyRule	setCookieDomain(String cookieDomain) Sets the value that should be used when rewriting the domain attribute of the Set-Cookie header.
HttpProxyRule	setCookiePath(String cookiePath) Sets the value that should be used when rewriting the path attribute of the Set-Cookie header.
HttpProxyRule	setDestinationUriTemplates(Set<UriTemplateDefinition> destinationUriTemplates)
HttpProxyRule	setLoadBalancer(LoadBalancerDefinition loadBalancer)
HttpProxyRule	setReverseHeaders(boolean reverseHeaders)
HttpProxyRule	setUriTemplate(UriTemplateDefinition uriTemplate)
HttpProxyRule	to(String destinationUriTemplate) Adds a destination URI template mapping; such as a physical endpoint we can proxy to if there are multiple possible physical endpoints and we are not using a load balancer service to hide the mapping of a logical URI to physical URI.
HttpProxyRule	to(UriTemplateDefinition templateDefinition)

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpProxyRule

public HttpProxyRule()

HttpProxyRule

public HttpProxyRule(String uriTemplate)

Method Detail

matches

public MappingResult matches(String[] paths)

chooseBackEndService

public UriTemplateDefinition chooseBackEndService(ClientRequestFacade requestFacade)

Chooses a back end service from the set of destination templates

to

public HttpProxyRule to(String destinationUriTemplate)

Adds a destination URI template mapping; such as a physical endpoint we can proxy to if there are multiple possible physical endpoints and we are not using a load balancer service to hide the mapping of a logical URI to physical URI.

to

public HttpProxyRule to(UriTemplateDefinition templateDefinition)

getUriTemplateObject

public UriTemplate getUriTemplateObject()

getUriTemplate

public UriTemplateDefinition getUriTemplate()

setUriTemplate

public HttpProxyRule setUriTemplate(UriTemplateDefinition uriTemplate)

getDestinationUriTemplates

public Set<UriTemplateDefinition> getDestinationUriTemplates()

setDestinationUriTemplates

public HttpProxyRule setDestinationUriTemplates(Set<UriTemplateDefinition> destinationUriTemplates)

isReverseHeaders

public boolean isReverseHeaders()

Returns whether or not reverseHeaders is enabled.

If enabled then the URL in the Location, Content-Location and URI headers from the proxied HTTP responses are rewritten from the back end service URL to match the front end URL on the gateway. This is equivalent to the ProxyPassReverse directive in mod_proxy.

setReverseHeaders

public HttpProxyRule setReverseHeaders(boolean reverseHeaders)

getLoadBalancer

public LoadBalancerDefinition getLoadBalancer()

Returns the kind of load balancing strategy used to bridge from

setLoadBalancer

public HttpProxyRule setLoadBalancer(LoadBalancerDefinition loadBalancer)

getCookiePath

public String getCookiePath()

Returns the value that should be used when rewriting the path attribute of the Set-Cookie header.

If the path was passed unmodified by the proxy it would case the browser to not send the cookie for subsequent requests as the browser will think that the cookie is not for that path. By being able to specify the path the browser will include the cookie when calling the proxy.

Returns:

String the path to be used in replacement of path attribute from the backend service.

setCookiePath

public HttpProxyRule setCookiePath(String cookiePath)

Sets the value that should be used when rewriting the path attribute of the Set-Cookie header.

If the path was passed unmodified by the proxy it would cause the browser to not send the cookie for subsequent requests as the browser will think that the cookie is not for that path. By being able to specify the path the browser will include the cookie when calling the proxy.

Parameters:

cookiePath - the path to be used in replacement of path attribute from the backend service.

getCookieDomain

public String getCookieDomain()

Returns the value that should be used when rewriting the domain attribute of the Set-Cookie header.

If the domain was passed unmodified by the proxy it would cause the browser to not send the cookie for subsequent requests as the browser will think that the cookie is not for that domain. By being able to specify the path the browser will include the cookie when calling the proxy.

Returns:

String the path to be used in replacement of domain attribute from the backend service.

setCookieDomain

public HttpProxyRule setCookieDomain(String cookieDomain)

Sets the value that should be used when rewriting the domain attribute of the Set-Cookie header.

If the domain was passed unmodified by the proxy it would cause the browser to not send the cookie for subsequent requests as the browser will think that the cookie is not for that domain. By being able to specify the path the browser will include the cookie when calling the proxy.

Parameters:

cookieDomain - the path to be used in replacement of domain attribute from the backend service.