29029be31d
* !htt #18919 #19519 Align Java HTTP server DSL with Scala This commits replaces the Java HTTP server DSL with a Java-8 centric one which exposes all scala DSL concepts to be usable from Java, including custom directives, (un)marshallers, rejections, headers, and type safety for path and query parameters. * Add RequestContext and RouteResult to Java DSL fix websockets WIP bring java docs up to date. This applies some updates to the root-level documentation * [htp] Fix java documentation to correctly mention timeouts Timeouts are configured the same in Java and Scala. Hence, linking to the scala docs for timeouts from Java. * =htc fix optionalHeaderValueByType in Java * =htt #20200 fix java testkit always using NoLogging instead logger * +htt actually run new javadsl tests, allow overriding config * =htt improve javadsl test infra with more details when fails * =htt fix bug in wrong path matcher exposed * +htp add missing remaining path matcher * =htp Java DSL cookie tests fixed * =htt Java DSL ParameterDirectivesTest fixed Protect the tweets from scalariform Incorrect response expectations in cache condition directives spec fixed * =htt Path directives for Java DSL * +!htt PathMatchers rewritten, made uniform and tests passing * Bugfix in java reject and a little test-boyscouting * Revert "Incorrect response expectations in cache condition directives spec fixed" This reverts commit cd50e89d45db010309f8249b090ea654ebb11c7a. * +htc HttpAPIsTest is compile time only, not for running Also, moved from the client package since not strictly a client test. SecurityDirectives passing Two faulty tests and two actual bugs. Fix for cache condition spec not working * Not sending in Unit instad of the implicit magnet in the test * HeaderMagnet now works as expected * Java API added for - and + on DateTime PetStore example and test fixed * Annotations to make marshalling work without default constructor * Made model class immutable Incorrect tests fixed Some scaladoc boyscouting as bonus * =htt RequestValTest sprinkled out across multiple directive tests Client ip extraction test with incorrect header name fixed. * =htt Incorrect CodingDirectivesTest fixed. * =htt Bugfix for Java Unmarshaller.firstOf and fixes to JavaRouteTest * =htt MarshallerTest fixed * Missing seal signature added to JavaDSL * More consistent (with Scala) test kit setup for Java * missing Javadocs added * Thread.sleep in default exception handler removed * =htt copy directive docs, prepare for finishing it up * +htt SecurityDirectives.authorize variants and test coverage added * +htt Custom headers in Java DSL * =htt WIP on java docs * +htp add missing parameterOrDefault directive Fixed a lot of doc warnings * =htc intense progress on javadsl docs * =htc #20470 Link to issue about docs and fix compile error compile, migration guide don't mima check http-experimental * =htt Java DSL doc warnings fixed. Only `Could not lex literal_block` ones left now * =htc fix mima settings * =doc fix MethodDirectives doc test with custom method * =htc fix coding directives spec after bad merge * =htc fix concat being corresponding to route() in javadsl * =htt Disable consistency check for route/concat as it fails only on ci server * !htt Minor fixes to PathMatchers
88 lines
2.9 KiB
ReStructuredText
88 lines
2.9 KiB
ReStructuredText
.. _directives-java:
|
|
|
|
Directives
|
|
==========
|
|
|
|
A "Directive" is a small building block used for creating arbitrarily complex :ref:`route structures <Routes>`.
|
|
Akka HTTP already pre-defines a large number of directives and you can easily construct your own:
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
alphabetically
|
|
by-trait
|
|
custom-directives
|
|
|
|
|
|
Basics
|
|
------
|
|
|
|
:ref:`Routes-java` effectively are simply highly specialised functions that take a ``RequestContext`` and eventually ``complete`` it,
|
|
which could (and often should) happen asynchronously.
|
|
|
|
With the :ref:`-complete-java-` directive this becomes even shorter::
|
|
|
|
Route route = complete("yeah");
|
|
|
|
Writing multiple routes that are tried as alternatives (in-order of definition), is as simple as using the ``route(route1, route2)``,
|
|
method::
|
|
|
|
Route routes = route(
|
|
pathSingleSlash(() ->
|
|
getFromResource("web/calculator.html")
|
|
),
|
|
path("hello", () -> complete("World!))
|
|
);
|
|
|
|
|
|
You could also simply define a "catch all" completion by providing it as the last route to attempt to match.
|
|
In the example below we use the ``get()`` (one of the :ref:`MethodDirectives-java`) to match all incoming ``GET``
|
|
requests for that route, and all other requests will be routed towards the other "catch all" route, that completes the route::
|
|
|
|
Route route =
|
|
get(
|
|
() -> complete("Received GET")
|
|
).orElse(
|
|
() -> complete("Received something else")
|
|
)
|
|
|
|
|
|
If no route matches a given request, a default ``404 Not Found`` response will be returned as response.
|
|
|
|
Structure
|
|
---------
|
|
|
|
The general anatomy of a directive is as follows::
|
|
|
|
directiveName(arguments [, ...], (extractions [, ...]) -> {
|
|
... // inner route
|
|
})
|
|
|
|
It has a name, zero or more arguments and optionally an inner route (The :ref:`RouteDirectives-java` are special in that they
|
|
are always used at the leaf-level and as such cannot have inner routes).
|
|
|
|
Additionally directives can "extract" a number of values and make them available to their inner routes as function
|
|
arguments. When seen "from the outside" a directive with its inner route form an expression of type ``Route``.
|
|
|
|
|
|
What Directives do
|
|
------------------
|
|
|
|
A directive can do one or more of the following:
|
|
|
|
.. rst-class:: wide
|
|
|
|
* Transform the incoming ``RequestContext`` before passing it on to its inner route (i.e. modify the request)
|
|
* Filter the ``RequestContext`` according to some logic, i.e. only pass on certain requests and reject others
|
|
* Extract values from the ``RequestContext`` and make them available to its inner route as "extractions"
|
|
* Chain some logic into the :class:`RouteResult` future transformation chain (i.e. modify the response or rejection)
|
|
* Complete the request
|
|
|
|
This means a ``Directive`` completely wraps the functionality of its inner route and can apply arbitrarily complex
|
|
transformations, both (or either) on the request and on the response side.
|
|
|
|
|
|
Composing Directives
|
|
--------------------
|
|
|
|
TODO rewrite for Java API
|