com.predic8.membrane.core.rules

Interface RuleKey

All Known Implementing Classes:

AbstractRuleKey, ProxyRuleKey, ServiceProxyKey

public interface RuleKey

Method Summary

Methods

Modifier and Type	Method and Description
String	getHost()
String	getMethod() Returns the name of the HTTP method
String	getPath() Returns the request URI.
int	getPort() Returns the TCP port that receives the messages
boolean	isHostWildcard() When isHostWidldcard is set to true any value of the HTTP Host header will match.
boolean	isMethodWildcard() When isMethodWildcard is set to true any value of the HTTP Host header will match
boolean	isPathRegExp() If isPathRegExp is true, than the path will be treated as a regexp pattern.
boolean	isUsePathPattern()
boolean	matchesPath(String path)
void	setPath(String path)
void	setPathRegExp(boolean pathRegExp)
void	setUsePathPattern(boolean usePathPattern)

Method Detail

getPort

int getPort()

Returns the TCP port that receives the messages

Returns:

an integer value which corresponds to TCP port

getMethod

String getMethod()

Returns the name of the HTTP method

Returns:

a String specifying the name of the HTTP method

getPath

String getPath()

Returns the request URI. For the request GET index.html it is index.html

Returns:

a String specifying the request URI

getHost

String getHost()

Returns:

the value of the HTTP Host header field

isMethodWildcard

boolean isMethodWildcard()

When isMethodWildcard is set to true any value of the HTTP Host header will match

Returns:

true if HTTP method wildcard is set to true false otherwise

isHostWildcard

boolean isHostWildcard()

When isHostWidldcard is set to true any value of the HTTP Host header will match.

Returns:

whether the host wildcard is set to true

isPathRegExp

boolean isPathRegExp()

If isPathRegExp is true, than the path will be treated as a regexp pattern. The path of the incoming request will be match against this regexp. return true if a path is an regexp expression false otherwise

isUsePathPattern

boolean isUsePathPattern()

setUsePathPattern

void setUsePathPattern(boolean usePathPattern)

setPathRegExp

void setPathRegExp(boolean pathRegExp)

setPath

void setPath(String path)

matchesPath

boolean matchesPath(String path)