pekko/akka-docs/rst/java/http/routing-dsl/directives/path-directives/rawPathPrefixTest.rst
Fabian Gutierrez ee77273fac akka http javadsl - add path directive tests (#20813)
* akka http javadsl - add debugging directive test

* fixes line breaks

* add additional examples on PathDirectives

* link documentation to test examples

* include example on redirectToNoTrailingSlashIfPresent and redirectToTrailingSlashIfMissing

* include example on redirectToNoTrailingSlashIfPresent and redirectToTrailingSlashIfMissing
2016-06-22 01:13:27 +02:00

27 lines
1.3 KiB
ReStructuredText

.. _-rawPathPrefixTest-java-:
rawPathPrefixTest
=================
Description
-----------
Checks whether the unmatched path of the ``RequestContext`` has a prefix matched by the given ``PathMatcher``.
Potentially extracts one or more values (depending on the type of the argument) but doesn't consume its match from
the unmatched path.
This directive is very similar to the :ref:`-pathPrefix-java-` directive with the one difference that the path prefix
it matched (if it matched) is *not* consumed. The unmatched path of the ``RequestContext`` is therefore left as
is even in the case that the directive successfully matched and the request is passed on to its inner route.
For more info on how to create a ``PathMatcher`` see :ref:`pathmatcher-dsl`.
As opposed to its :ref:`-pathPrefixTest-java-` counterpart ``rawPathPrefixTest`` does *not* automatically add a leading slash
to its ``PathMatcher`` argument. Rather its ``PathMatcher`` argument is applied to the unmatched path as is.
Depending on the type of its ``PathMatcher`` argument the ``rawPathPrefixTest`` directive extracts zero or more values
from the URI. If the match fails the request is rejected with an :ref:`empty rejection set <empty rejections>`.
Example
-------
.. includecode:: ../../../../code/docs/http/javadsl/server/directives/PathDirectivesExamplesTest.java#raw-path-prefix-test