Package com.predic8.membrane.core.rules

Interface RuleKey

All Known Implementing Classes:
AbstractRuleKey, APIProxyKey, FakeKey, ProxyRuleKey, ServiceProxyKey, SwaggerProxyKey
public interface RuleKey

  • Method Details

    • 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

    • 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(Exchange exc)