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
123 lines
2.8 KiB
ReStructuredText
123 lines
2.8 KiB
ReStructuredText
.. _BasicDirectives-java:
|
|
|
|
BasicDirectives
|
|
===============
|
|
|
|
Basic directives are building blocks for building :ref:`Custom Directives`. As such they
|
|
usually aren't used in a route directly but rather in the definition of new directives.
|
|
|
|
|
|
.. _ProvideDirectives-java:
|
|
|
|
Providing Values to Inner Routes
|
|
--------------------------------
|
|
|
|
These directives provide values to the inner routes with extractions. They can be distinguished
|
|
on two axes: a) provide a constant value or extract a value from the ``RequestContext`` b) provide
|
|
a single value or a tuple of values.
|
|
|
|
* :ref:`-extract-java-`
|
|
* :ref:`-extractExecutionContext-java-`
|
|
* :ref:`-extractMaterializer-java-`
|
|
* :ref:`-extractLog-java-`
|
|
* :ref:`-extractRequest-java-`
|
|
* :ref:`-extractRequestContext-java-`
|
|
* :ref:`-extractSettings-java-`
|
|
* :ref:`-extractUnmatchedPath-java-`
|
|
* :ref:`-extractUri-java-`
|
|
* :ref:`-provide-java-`
|
|
|
|
|
|
.. _Request Transforming Directives-java:
|
|
|
|
Transforming the Request(Context)
|
|
---------------------------------
|
|
|
|
* :ref:`-mapRequest-java-`
|
|
* :ref:`-mapRequestContext-java-`
|
|
* :ref:`-mapSettings-java-`
|
|
* :ref:`-mapUnmatchedPath-java-`
|
|
* :ref:`-withExecutionContext-java-`
|
|
* :ref:`-withMaterializer-java-`
|
|
* :ref:`-withLog-java-`
|
|
* :ref:`-withSettings-java-`
|
|
|
|
|
|
.. _Response Transforming Directives-java:
|
|
|
|
Transforming the Response
|
|
-------------------------
|
|
|
|
These directives allow to hook into the response path and transform the complete response or
|
|
the parts of a response or the list of rejections:
|
|
|
|
* :ref:`-mapResponse-java-`
|
|
* :ref:`-mapResponseEntity-java-`
|
|
* :ref:`-mapResponseHeaders-java-`
|
|
|
|
|
|
.. _Result Transformation Directives-java:
|
|
|
|
Transforming the RouteResult
|
|
----------------------------
|
|
|
|
These directives allow to transform the RouteResult of the inner route.
|
|
|
|
* :ref:`-cancelRejection-java-`
|
|
* :ref:`-cancelRejections-java-`
|
|
* :ref:`-mapRejections-java-`
|
|
* :ref:`-mapRouteResult-java-`
|
|
* :ref:`-mapRouteResultFuture-java-`
|
|
* :ref:`-mapRouteResultPF-java-`
|
|
* :ref:`-mapRouteResultWith-java-`
|
|
* :ref:`-mapRouteResultWithPF-java-`
|
|
* :ref:`-recoverRejections-java-`
|
|
* :ref:`-recoverRejectionsWith-java-`
|
|
|
|
|
|
Other
|
|
-----
|
|
|
|
* :ref:`-mapInnerRoute-java-`
|
|
* :ref:`-pass-java-`
|
|
|
|
|
|
Alphabetically
|
|
--------------
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
cancelRejection
|
|
cancelRejections
|
|
extract
|
|
extractExecutionContext
|
|
extractMaterializer
|
|
extractLog
|
|
extractRequest
|
|
extractRequestContext
|
|
extractSettings
|
|
extractUnmatchedPath
|
|
extractUri
|
|
mapInnerRoute
|
|
mapRejections
|
|
mapRequest
|
|
mapRequestContext
|
|
mapResponse
|
|
mapResponseEntity
|
|
mapResponseHeaders
|
|
mapRouteResult
|
|
mapRouteResultFuture
|
|
mapRouteResultPF
|
|
mapRouteResultWith
|
|
mapRouteResultWithPF
|
|
mapSettings
|
|
mapUnmatchedPath
|
|
pass
|
|
provide
|
|
recoverRejections
|
|
recoverRejectionsWith
|
|
withExecutionContext
|
|
withMaterializer
|
|
withLog
|
|
withSettings
|