* !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
This commit is contained in:
Johan Andrén
Konrad Malawski
parent
094c8974ed
commit
29029be31d
381 changed files with 12616 additions and 6630 deletions
|
|
@ -10,7 +10,7 @@ Consider this example:
|
|||
.. includecode2:: ../../code/docs/http/scaladsl/server/CaseClassExtractionExamplesSpec.scala
|
||||
:snippet: example-1
|
||||
|
||||
Here the :ref:`-parameters-` directives is employed to extract three ``Int`` values, which are then used to construct an
|
||||
Here the :ref:`-parameters-scala-` directives is employed to extract three ``Int`` values, which are then used to construct an
|
||||
instance of the ``Color`` case class. So far so good. However, if the model classes we'd like to work with have more
|
||||
than just a few parameters the overhead introduced by capturing the arguments as extractions only to feed them into the
|
||||
model class constructor directly afterwards can somewhat clutter up your route definitions.
|
||||
|
|
|
|||
|
|
@ -64,7 +64,7 @@ Directive Description
|
|||
:ref:`-failWith-` Bubbles the given error up the response chain where it is dealt with by the
|
||||
closest :ref:`-handleExceptions-` directive and its ``ExceptionHandler``
|
||||
:ref:`-fileUpload-` Provides a stream of an uploaded file from a multipart request
|
||||
:ref:`-formField-` Extracts an HTTP form field from the request
|
||||
:ref:`-formField-scala-` Extracts an HTTP form field from the request
|
||||
:ref:`-formFieldMap-` Extracts a number of HTTP form field from the request as
|
||||
a ``Map[String, String]``
|
||||
:ref:`-formFieldMultiMap-` Extracts a number of HTTP form field from the request as
|
||||
|
|
@ -150,7 +150,7 @@ Directive Description
|
|||
:ref:`-parameter-` Extracts a query parameter value from the request
|
||||
:ref:`-parameterMap-` Extracts the request's query parameters as a ``Map[String, String]``
|
||||
:ref:`-parameterMultiMap-` Extracts the request's query parameters as a ``Map[String, List[String]]``
|
||||
:ref:`-parameters-` Extracts a number of query parameter values from the request
|
||||
:ref:`-parameters-scala-` Extracts a number of query parameter values from the request
|
||||
:ref:`-parameterSeq-` Extracts the request's query parameters as a ``Seq[(String, String)]``
|
||||
:ref:`-pass-` Always simply passes the request on to its inner route, i.e. doesn't do
|
||||
anything, neither with the request nor the response
|
||||
|
|
@ -211,13 +211,13 @@ Directive Description
|
|||
:ref:`-tprovide-` Injects a given tuple of values into a directive
|
||||
:ref:`-uploadedFile-` Streams one uploaded file from a multipart request to a file on disk
|
||||
:ref:`-validate-` Checks a given condition before running its inner route
|
||||
:ref:`-withoutRequestTimeout-` Disables :ref:`request timeouts <request-timeout>` for a given route.
|
||||
:ref:`-withoutRequestTimeout-` Disables :ref:`request timeouts <request-timeout-scala>` for a given route.
|
||||
:ref:`-withExecutionContext-` Runs its inner route with the given alternative ``ExecutionContext``
|
||||
:ref:`-withMaterializer-` Runs its inner route with the given alternative ``Materializer``
|
||||
:ref:`-withLog-` Runs its inner route with the given alternative ``LoggingAdapter``
|
||||
:ref:`-withRangeSupport-` Adds ``Accept-Ranges: bytes`` to responses to GET requests, produces partial
|
||||
responses if the initial request contained a valid ``Range`` header
|
||||
:ref:`-withRequestTimeout-` Configures the :ref:`request timeouts <request-timeout>` for a given route.
|
||||
:ref:`-withRequestTimeout-` Configures the :ref:`request timeouts <request-timeout-scala>` for a given route.
|
||||
:ref:`-withRequestTimeoutResponse-` Prepares the ``HttpResponse`` that is emitted if a request timeout is triggered.
|
||||
``RequestContext => RequestContext`` function
|
||||
:ref:`-withSettings-` Runs its inner route with the given alternative ``RoutingSettings``
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.. _-formField-:
|
||||
.. _-formField-scala-:
|
||||
|
||||
formField
|
||||
=========
|
||||
|
|
|
|||
|
|
@ -52,9 +52,9 @@ instance.
|
|||
|
||||
Requests missing a required field or field value will be rejected with an appropriate rejection.
|
||||
|
||||
There's also a singular version, :ref:`-formField-`.
|
||||
There's also a singular version, :ref:`-formField-scala-`.
|
||||
|
||||
Query parameters can be handled in a similar way, see :ref:`-parameters-`.
|
||||
Query parameters can be handled in a similar way, see :ref:`-parameters-scala-`.
|
||||
|
||||
Unmarshalling
|
||||
-------------
|
||||
|
|
|
|||
|
|
@ -17,19 +17,19 @@ ParameterDirectives
|
|||
When to use which parameter directive?
|
||||
--------------------------------------
|
||||
|
||||
Usually, you want to use the high-level :ref:`-parameters-` directive. When you need
|
||||
Usually, you want to use the high-level :ref:`-parameters-scala-` directive. When you need
|
||||
more low-level access you can use the table below to decide which directive
|
||||
to use which shows properties of different parameter directives.
|
||||
|
||||
========================== ====== ======== =====
|
||||
directive level ordering multi
|
||||
========================== ====== ======== =====
|
||||
:ref:`-parameter-` high no no
|
||||
:ref:`-parameters-` high no yes
|
||||
:ref:`-parameterMap-` low no no
|
||||
:ref:`-parameterMultiMap-` low no yes
|
||||
:ref:`-parameterSeq-` low yes yes
|
||||
========================== ====== ======== =====
|
||||
================================ ====== ======== =====
|
||||
directive level ordering multi
|
||||
================================ ====== ======== =====
|
||||
:ref:`-parameter-` high no no
|
||||
:ref:`-parameters-scala-` high no yes
|
||||
:ref:`-parameterMap-` low no no
|
||||
:ref:`-parameterMultiMap-` low no yes
|
||||
:ref:`-parameterSeq-` low yes yes
|
||||
================================ ====== ======== =====
|
||||
|
||||
level
|
||||
high-level parameter directives extract subset of all parameters by name and allow conversions
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@ Description
|
|||
-----------
|
||||
Extracts a *query* parameter value from the request.
|
||||
|
||||
See :ref:`-parameters-` for a detailed description of this directive.
|
||||
See :ref:`-parameters-scala-` for a detailed description of this directive.
|
||||
|
||||
See :ref:`which-parameter-directive` to understand when to use which directive.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.. _-parameters-:
|
||||
.. _-parameters-scala-:
|
||||
|
||||
parameters
|
||||
==========
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@ Signature
|
|||
Description
|
||||
-----------
|
||||
|
||||
This directive enables "late" (during request processing) control over the :ref:`request-timeout` feature in Akka HTTP.
|
||||
This directive enables "late" (during request processing) control over the :ref:`request-timeout-scala` feature in Akka HTTP.
|
||||
|
||||
The timeout can be either loosened or made more tight using this directive, however one should be aware that it is
|
||||
inherently racy (which may especially show with very tight timeouts) since a timeout may already have been triggered
|
||||
|
|
@ -35,7 +35,7 @@ See also :ref:`-withRequestTimeoutResponse-` if only looking to customise the ti
|
|||
It is recommended to use a larger statically configured timeout (think of it as a "safety net" against programming errors
|
||||
or malicious attackers) and if needed tighten it using the directives – not the other way around.
|
||||
|
||||
For more information about various timeouts in Akka HTTP see :ref:`http-timeouts`.
|
||||
For more information about various timeouts in Akka HTTP see :ref:`http-timeouts-scala`.
|
||||
|
||||
Example
|
||||
-------
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@ Signature
|
|||
Description
|
||||
-----------
|
||||
|
||||
Allows customising the ``HttpResponse`` that will be sent to clients in case of a :ref:`request-timeout`.
|
||||
Allows customising the ``HttpResponse`` that will be sent to clients in case of a :ref:`request-timeout-scala`.
|
||||
|
||||
See also :ref:`-withRequestTimeout-` or :ref:`-withoutRequestTimeout-` if interested in dynamically changing the timeout
|
||||
for a given route instead.
|
||||
|
|
@ -25,7 +25,7 @@ for a given route instead.
|
|||
In practice this can only be a problem with very tight timeouts, so with default settings
|
||||
of request timeouts being measured in seconds it shouldn't be a problem in reality (though certainly a possibility still).
|
||||
|
||||
To learn more about various timeouts in Akka HTTP and how to configure them see :ref:`http-timeouts`.
|
||||
To learn more about various timeouts in Akka HTTP and how to configure them see :ref:`http-timeouts-scala`.
|
||||
|
||||
Example
|
||||
-------
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@ Signature
|
|||
Description
|
||||
-----------
|
||||
|
||||
This directive enables "late" (during request processing) control over the :ref:`request-timeout` feature in Akka HTTP.
|
||||
This directive enables "late" (during request processing) control over the :ref:`request-timeout-scala` feature in Akka HTTP.
|
||||
|
||||
It is not recommended to turn off request timeouts using this method as it is inherently racy and disabling request timeouts
|
||||
basically turns off the safety net against programming mistakes that it provides.
|
||||
|
|
@ -22,7 +22,7 @@ basically turns off the safety net against programming mistakes that it provides
|
|||
we're measuring the timeout" is already in the past (the moment we started handling the request), so if the existing
|
||||
timeout already was triggered before your directive had the chance to change it, an timeout may still be logged.
|
||||
|
||||
For more information about various timeouts in Akka HTTP see :ref:`http-timeouts`.
|
||||
For more information about various timeouts in Akka HTTP see :ref:`http-timeouts-scala`.
|
||||
|
||||
Example
|
||||
-------
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue