RuleKey (service-proxy-core 4.6.2 API)

All Known Implementing Classes:

AbstractRuleKey, FakeKey, ProxyRuleKey, ServiceProxyKey, SwaggerProxyKey
```
public interface RuleKey
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`complexMatch(String hostHeader, String method, String uri, String version, int port, String localIP)`
`String`	`getHost()`
`String`	`getIp()` IP address to bind to, or null to bind to 0.0.0.0 (=any local address).
`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`	`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`	`matchesHostHeader(String hostHeader)`
`boolean`	`matchesPath(String path)`
`boolean`	`matchesVersion(String version)`
`void`	`setIp(String ip)`
`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.htm it is index.htm
    
    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
  - 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)
```
  - getIp
```
String getIp()
```
    IP address to bind to, or null to bind to 0.0.0.0 (=any local address).
  - setIp
```
void setIp(String ip)
```
  - matchesHostHeader
```
boolean matchesHostHeader(String hostHeader)
```
  - matchesVersion
```
boolean matchesVersion(String version)
```
  - complexMatch
```
boolean complexMatch(String hostHeader,
                     String method,
                     String uri,
                     String version,
                     int port,
                     String localIP)
```

Interface RuleKey

Method Summary

Method Detail

getPort

getMethod

getPath

getHost

isMethodWildcard

isPathRegExp

isUsePathPattern

setUsePathPattern

setPathRegExp

setPath

matchesPath

getIp

setIp

matchesHostHeader

matchesVersion

complexMatch