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
72 lines
3.2 KiB
ReStructuredText
72 lines
3.2 KiB
ReStructuredText
.. _http-high-level-server-side-api-java:
|
|
|
|
High-level Server-Side API
|
|
==========================
|
|
|
|
In addition to the :ref:`http-low-level-server-side-api-java` Akka HTTP provides a very flexible "Routing DSL" for elegantly
|
|
defining RESTful web services. It picks up where the low-level API leaves off and offers much of the higher-level
|
|
functionality of typical web servers or frameworks, like deconstruction of URIs, content negotiation or
|
|
static content serving.
|
|
|
|
To use the high-level API you need to add a dependency to the ``akka-http-experimental`` module.
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
overview
|
|
routes
|
|
directives/index
|
|
marshalling
|
|
exception-handling
|
|
rejections
|
|
testkit
|
|
|
|
Handling HTTP Server failures in the High-Level API
|
|
---------------------------------------------------
|
|
There are various situations when failure may occur while initialising or running an Akka HTTP server.
|
|
Akka by default will log all these failures, however sometimes one may want to react to failures in addition
|
|
to them just being logged, for example by shutting down the actor system, or notifying some external monitoring
|
|
end-point explicitly.
|
|
|
|
Bind failures
|
|
^^^^^^^^^^^^^
|
|
For example the server might be unable to bind to the given port. For example when the port
|
|
is already taken by another application, or if the port is privileged (i.e. only usable by ``root``).
|
|
In this case the "binding future" will fail immediatly, and we can react to if by listening on the CompletionStage's completion:
|
|
|
|
.. includecode:: ../../code/docs/http/javadsl/server/HighLevelServerBindFailureExample.java
|
|
:include: binding-failure-high-level-example
|
|
|
|
|
|
.. note::
|
|
For a more low-level overview of the kinds of failures that can happen and also more fine-grained control over them
|
|
refer to the :ref:`handling-http-server-failures-low-level-java` documentation.
|
|
|
|
Failures and exceptions inside the Routing DSL
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
Exception handling within the Routing DSL is done by providing :class:`ExceptionHandler` s which are documented in-depth
|
|
in the :ref:`exception-handling-java` section of the documtnation. You can use them to transform exceptions into
|
|
:class:`HttpResponse` s with apropriate error codes and human-readable failure descriptions.
|
|
|
|
File uploads
|
|
^^^^^^^^^^^^
|
|
TODO not possible in Java DSL since there
|
|
|
|
For high level directives to handle uploads see the :ref:`FileUploadDirectives-java`.
|
|
|
|
Handling a simple file upload from for example a browser form with a `file` input can be done
|
|
by accepting a `Multipart.FormData` entity, note that the body parts are `Source` rather than
|
|
all available right away, and so is the individual body part payload so you will need to consume
|
|
those streams both for the file and for the form fields.
|
|
|
|
Here is a simple example which just dumps the uploaded file into a temporary file on disk, collects
|
|
some form fields and saves an entry to a fictive database:
|
|
|
|
TODO missing example 1
|
|
|
|
You can transform the uploaded files as they arrive rather than storing then in a temporary file as
|
|
in the previous example. In this example we accept any number of ``.csv`` files, parse those into lines
|
|
and split each line before we send it to an actor for further processing:
|
|
|
|
TODO missing example 2
|