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
43 lines
No EOL
2.1 KiB
ReStructuredText
43 lines
No EOL
2.1 KiB
ReStructuredText
.. _marshalling-java:
|
|
|
|
Marshalling & Unmarshalling
|
|
===========================
|
|
|
|
"Marshalling" is the process of converting a higher-level (object) structure into some kind of lower-level
|
|
representation (and vice versa), often a binary wire format. Other popular names for it are "Serialization" or
|
|
"Pickling".
|
|
|
|
In akka-http "Marshalling" means the conversion of an object of type T into an HttpEntity, which forms the entity body
|
|
of an HTTP request or response (depending on whether used on the client or server side).
|
|
|
|
Marshalling
|
|
-----------
|
|
|
|
On the server-side marshalling is used to convert a application-domain object to a response (entity). Requests can
|
|
contain an ``Accept`` header that lists acceptable content types for the client. A marshaller contains the logic to
|
|
negotiate the result content types based on the ``Accept`` and the ``AcceptCharset`` headers.
|
|
|
|
Marshallers can be specified when completing a request with ``RequestContext.complete`` or by using one of the
|
|
``RouteDirectives.complete`` directives.
|
|
|
|
These marshallers are provided by akka-http:
|
|
|
|
* Use :ref:`json-jackson-support-java` to create an marshaller that can convert a POJO to an ``application/json``
|
|
response using jackson_.
|
|
* Use ``Marshaller.stringToEntity``, ``Marshaller.byteArrayToEntity``, ``Marshaller.byteStringToEntity``,
|
|
combined with ``Marshaller.entityToResponse`` to create custom marshallers.
|
|
|
|
Unmarshalling
|
|
-------------
|
|
|
|
On the server-side unmarshalling is used to convert a request (entity) to a application-domain object. This is done
|
|
in the ``MarshallingDirectives.request`` or ``MarshallingDirectives.entity`` directive. There are several unmarshallers
|
|
provided by akka-http:
|
|
|
|
* Use :ref:`json-jackson-support-java` to create an unmarshaller that can convert an ``application/json`` request
|
|
to a POJO using jackson_.
|
|
* Use the predefined ``Unmarshaller.entityToString``, ``Unmarshaller.entityToByteString``, ``Unmarshaller.entityToByteArray``,
|
|
``Unmarshaller.entityToCharArray`` to convert to those basic types.
|
|
* Use ``Unmarshaller.sync`` or ``Unmarshaller.async`` to create a custom unmarshaller.
|
|
|
|
.. _jackson: https://github.com/FasterXML/jackson |