Package org.apache.pekko.http.scaladsl.server

Class PathMatcher<L>

java.lang.Object
org.apache.pekko.http.scaladsl.server.PathMatcher<L>
All Implemented Interfaces:
scala.Function1<Uri.Path,PathMatcher.Matching<L>>
Direct Known Subclasses:
PathMatchers.NumberMatcher, PathMatchers.PathEnd$, PathMatchers.Remaining$, PathMatchers.RemainingPath$, PathMatchers.Segment$, PathMatchers.Slash$
public abstract class PathMatcher<L> extends Object implements scala.Function1<Uri.Path,PathMatcher.Matching<L>>
A PathMatcher tries to match a prefix of a given string and returns either a PathMatcher.Matched instance if matched, otherwise PathMatcher.Unmatched.

Opentelemetry Java Instrumentation relies on the apply(Path) method of this class (and of every subclass) so avoid changing it. The agent uses it to derive the http.route attribute. See https://github.com/apache/pekko-http/issues/1241 and https://github.com/open-telemetry/opentelemetry-java-instrumentation/blob/6f9ca5672ce84edbbe36ce0e14386c31d68f479f/instrumentation/pekko/pekko-http-1.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/pekkohttp/v1_0/server/route/PathMatcherStaticInstrumentation.java

  • Constructor Details

    • PathMatcher

      public PathMatcher(Tuple<L> ev)

  • Method Details

    • provide

      public static <L> PathMatcher<L> provide(L extractions, Tuple<L> ev)
      Creates a PathMatcher that always matches, consumes nothing and extracts the given Tuple of values.
      Parameters:
      extractions - (undocumented)
      ev - (undocumented)
      Returns:
      (undocumented)

    • apply

      public static <L> PathMatcher<L> apply(Uri.Path prefix, L extractions, Tuple<L> ev)
      Creates a PathMatcher that matches and consumes the given path prefix and extracts the given list of extractions. If the given prefix is empty the returned PathMatcher matches always and consumes nothing.

      Opentelemetry Java Instrumentation relies on this method so avoid changing it. The agent matches on the method name, on the Path first parameter and on the PathMatcher return type, and uses it to derive the http.route attribute. See https://github.com/apache/pekko-http/issues/1241

      Parameters:
      prefix - (undocumented)
      extractions - (undocumented)
      ev - (undocumented)
      Returns:
      (undocumented)

    • apply

      public static <L> PathMatcher<L> apply(PathMatcher<L> magnet)
      Provoke implicit conversions to PathMatcher to be applied

    • EmptyMatch

      public static PathMatcher.Matched<scala.Tuple1<String>> EmptyMatch()
      The empty match returned when a Regex matcher matches the empty path

    • _stringExtractionPair2PathMatcher

      public static <T> PathMatcher<scala.Tuple1<T>> _stringExtractionPair2PathMatcher(scala.Tuple2<String,T> tuple)

    • _segmentStringToPathMatcher

      public static PathMatcher<scala.runtime.BoxedUnit> _segmentStringToPathMatcher(String segment)

    • _stringNameOptionReceptacle2PathMatcher

      public static PathMatcher<scala.runtime.BoxedUnit> _stringNameOptionReceptacle2PathMatcher(NameOptionReceptacle<String> nr)

    • _regex2PathMatcher

      public static PathMatcher<scala.Tuple1<String>> _regex2PathMatcher(scala.util.matching.Regex regex)

    • _valueMap2PathMatcher

      public static <T> PathMatcher<scala.Tuple1<T>> _valueMap2PathMatcher(scala.collection.immutable.Map<String,T> valueMap)

    • ev

      public Tuple<L> ev()

    • slash

      public PathMatcher<L> slash()

    • slash

      public <R> PathMatcher<Object> slash(PathMatcher<R> other, TupleOps.Join<L,R> join)

    • or

      public <R> PathMatcher<R> or(PathMatcher<? extends R> other, Tuple<R> evidence$2)

    • append

      public <R> PathMatcher<Object> append(PathMatcher<R> other, TupleOps.Join<L,R> join)

    • transform

      public <R> PathMatcher<R> transform(scala.Function1<PathMatcher.Matching<L>,PathMatcher.Matching<R>> f, Tuple<R> evidence$3)

    • tmap

      public <R> PathMatcher<R> tmap(scala.Function1<L,R> f, Tuple<R> evidence$4)

    • tflatMap

      public <R> PathMatcher<R> tflatMap(scala.Function1<L,scala.Option<R>> f, Tuple<R> evidence$5)

    • repeat

      public PathMatcher<Object> repeat(int count, PathMatcher.Lift<L,scala.collection.immutable.List> lift)
      Same as repeat(min = count, max = count).
      Parameters:
      count - (undocumented)
      lift - (undocumented)
      Returns:
      (undocumented)

    • repeat

      public PathMatcher<Object> repeat(int count, PathMatcher<scala.runtime.BoxedUnit> separator, PathMatcher.Lift<L,scala.collection.immutable.List> lift)
      Same as repeat(min = count, max = count, separator = separator).
      Parameters:
      count - (undocumented)
      separator - (undocumented)
      lift - (undocumented)
      Returns:
      (undocumented)

    • repeat

      public PathMatcher<Object> repeat(int min, int max, PathMatcher<scala.runtime.BoxedUnit> separator, PathMatcher.Lift<L,scala.collection.immutable.List> lift)
      Turns this PathMatcher into one that matches a number of times (with the given separator) and potentially extracts a List of the underlying matcher's extractions. If less than min applications of the underlying matcher have succeeded the produced matcher fails, otherwise it matches up to the given max number of applications. Note that it won't fail even if more than max applications could succeed! The "surplus" path elements will simply be left unmatched.

      The result type depends on the type of the underlying matcher:

      If a matcher is of typethen matcher.repeat(...) is of type
      PathMatcher0PathMatcher0
      PathMatcher1[T]PathMatcher1[List[T]
      PathMatcher[L :Tuple]PathMatcher[List[L}
      Parameters:
      min - (undocumented)
      max - (undocumented)
      separator - (undocumented)
      lift - (undocumented)
      Returns:
      (undocumented)