Class UriTemplate

java.lang.Object
org.apache.tomcat.websocket.server.UriTemplate
public class UriTemplate extends Object
Extracts path parameters from URIs used to create web socket connections using the URI template defined for the associated Endpoint.

  • Constructor Details

    • UriTemplate

      public UriTemplate(String path) throws DeploymentException
      Creates a new UriTemplate from the given path.
      Parameters:
      path - the URI template path
      Throws:
      DeploymentException - if the path is invalid

    • UriTemplate

      public UriTemplate(String path, boolean parseParameters) throws DeploymentException
      Creates a new UriTemplate from the given path.
      Parameters:
      path - the URI template path
      parseParameters - whether to parse path parameters
      Throws:
      DeploymentException - if the path is invalid

  • Method Details

    • match

      public Map<String,String> match(UriTemplate candidate)
      Matches this template against a candidate URI path.
      Parameters:
      candidate - the candidate URI path
      Returns:
      the path parameters if matched, or null

    • hasParameters

      public boolean hasParameters()
      Returns whether this template contains path parameters.
      Returns:
      true if there are parameters

    • getSegmentCount

      public int getSegmentCount()
      Returns the number of path segments.
      Returns:
      the segment count

    • getNormalizedPath

      public String getNormalizedPath()
      Returns the normalized path with numeric parameter indices.
      Returns:
      the normalized path