raboof/pekko
1
0
Fork 0
Code Issues Pull requests Projects Releases 6 Packages Wiki Activity Actions 10

=doc,htp #18657 document Headers request values

Browse source
This commit is contained in:
Konrad Malawski 2015-10-07 15:55:04 +02:00
parent 58e59d6943
commit 27eba7ffa3
4 changed files with 112 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

33
akka-docs-dev/rst/java/http/routing-dsl/request-vals/header-request-vals.rst Normal file
View file

@ -0,0 +1,33 @@
.. _header-request-vals-java:
Request Values: Headers
=======================
A collection of pre-defined :ref:`request-vals-java` that can be used to extract header values from incoming requests.
Description
-----------
Header request values allow extracting ``HttpHeader`` values or concrete instances from HTTP requests.
The ``RequestVal`` builder is made up of 2 steps, initially you need to pick which Header to extract (``byName`` or
``byClass``) and then you need to pick if the header is optionally available or required (i.e. the route should not
match if the header is not present in the request). This is done using one of the below depicted methods::
RequestVal<T> instance()
RequestVal<<Option<T>> optionalInstance()
RequestVal<String> value()
RequestVal<Option<String>> optionalValue()
Examples
--------
``Headers.byClass(Class[HttpHeader])``
.. includecode:: ../../../code/docs/http/javadsl/server/HeaderRequestValsExampleTest.java
:include: by-class
``Headers.byName(String)``
.. includecode:: ../../../code/docs/http/javadsl/server/HeaderRequestValsExampleTest.java
:include: by-name

18
akka-docs-dev/rst/java/http/routing-dsl/request-vals/index.rst
View file

@ -25,21 +25,21 @@ Predefined Request values
akka-http provides a set of predefined request values for request data commonly accessed in a web
service.
These request values are defined:
These request values are defined in the following objects:
RequestVals
akka.http.javadsl.server.values.FormFieldsRequestVals
Contains request values for basic data like URI components, request method, peer address, or the entity data.
Cookies
akka.http.javadsl.server.values.FormFieldsCookies
Contains request values representing cookies.
FormFields
akka.http.javadsl.server.values.FormFields
Contains request values to access form fields unmarshalled to various primitive Java types.
Headers
:ref:`akka.http.javadsl.server.values.Headers <header-request-vals-java>`
Contains request values to access request headers or header values.
HttpBasicAuthenticator
akka.http.javadsl.server.values.FormFieldsHttpBasicAuthenticator
An abstract class to implement to create a request value representing a HTTP basic authenticated principal.
Parameters
akka.http.javadsl.server.values.FormFieldsParameters
Contains request values to access URI paramaters unmarshalled to various primitive Java types.
PathMatchers
akka.http.javadsl.server.values.FormFieldsPathMatchers
Contains request values to match and access URI path segments.
CustomRequestVal
akka.http.javadsl.server.values.FormFieldsCustomRequestVal
An abstract class to implement arbitrary custom request values.