pekko/akka-docs/rst/java/http/routing-dsl/directives/by-trait.rst

111 lines
2.9 KiB
ReStructuredText
Raw Normal View History

!htp #18919 #19519 New JavaDSL for Akka HTTP (#20518) * !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
2016-05-16 10:38:40 +02:00
Predefined Directives (by trait)
================================
All predefined directives are organized into traits that form one part of the overarching ``Directives`` trait.
.. _Request Directives-java:
Directives filtering or extracting from the request
---------------------------------------------------
:ref:`MethodDirectives-java`
Filter and extract based on the request method.
:ref:`HeaderDirectives-java`
Filter and extract based on request headers.
:ref:`PathDirectives-java`
Filter and extract from the request URI path.
:ref:`HostDirectives-java`
Filter and extract based on the target host.
:ref:`ParameterDirectives-java`, :ref:`FormFieldDirectives-java`
Filter and extract based on query parameters or form fields.
:ref:`CodingDirectives-java`
Filter and decode compressed request content.
:ref:`MarshallingDirectives-java`
Extract the request entity.
:ref:`SchemeDirectives-java`
Filter and extract based on the request scheme.
:ref:`SecurityDirectives-java`
Handle authentication data from the request.
:ref:`CookieDirectives-java`
Filter and extract cookies.
:ref:`BasicDirectives-java` and :ref:`MiscDirectives-java`
Directives handling request properties.
:ref:`FileUploadDirectives-java`
Handle file uploads.
.. _Response Directives-java:
Directives creating or transforming the response
------------------------------------------------
:ref:`CacheConditionDirectives-java`
Support for conditional requests (``304 Not Modified`` responses).
:ref:`CookieDirectives-java`
Set, modify, or delete cookies.
:ref:`CodingDirectives-java`
Compress responses.
:ref:`FileAndResourceDirectives-java`
Deliver responses from files and resources.
:ref:`RangeDirectives-java`
Support for range requests (``206 Partial Content`` responses).
:ref:`RespondWithDirectives-java`
Change response properties.
:ref:`RouteDirectives-java`
Complete or reject a request with a response.
:ref:`BasicDirectives-java` and :ref:`MiscDirectives-java`
Directives handling or transforming response properties.
:ref:`TimeoutDirectives-java`
Configure request timeouts and automatic timeout responses.
List of predefined directives by trait
--------------------------------------
.. toctree::
:maxdepth: 1
basic-directives/index
cache-condition-directives/index
coding-directives/index
cookie-directives/index
debugging-directives/index
execution-directives/index
file-and-resource-directives/index
file-upload-directives/index
form-field-directives/index
future-directives/index
header-directives/index
host-directives/index
marshalling-directives/index
method-directives/index
misc-directives/index
parameter-directives/index
path-directives/index
range-directives/index
respond-with-directives/index
route-directives/index
scheme-directives/index
security-directives/index
websocket-directives/index
timeout-directives/index