org.apache.pekko.http.javadsl.server.directives

Class HeaderDirectives

java.lang.Object

org.apache.pekko.http.javadsl.server.directives.BasicDirectives

org.apache.pekko.http.javadsl.server.directives.CacheConditionDirectives

org.apache.pekko.http.javadsl.server.directives.CodingDirectives

org.apache.pekko.http.javadsl.server.directives.CookieDirectives

org.apache.pekko.http.javadsl.server.directives.DebuggingDirectives

org.apache.pekko.http.javadsl.server.directives.ExecutionDirectives

org.apache.pekko.http.javadsl.server.directives.FileAndResourceDirectives

org.apache.pekko.http.javadsl.server.directives.FileUploadDirectives

org.apache.pekko.http.javadsl.server.directives.FormFieldDirectives

org.apache.pekko.http.javadsl.server.directives.FutureDirectives

org.apache.pekko.http.javadsl.server.directives.HeaderDirectives

Direct Known Subclasses:

AttributeDirectives

public abstract class HeaderDirectives
extends FutureDirectives

Constructor Summary

Constructors

Constructor and Description
HeaderDirectives()

Method Summary

Modifier and Type	Method and Description
Route	checkSameOrigin(HttpOriginRange allowed, java.util.function.Supplier<Route> inner) Checks that request comes from the same origin.
<T> RouteAdapter	headerValue(java.util.function.Function<HttpHeader,java.util.Optional<T>> f, java.util.function.Function<T,Route> inner) Extracts an HTTP header value using the given function.
RouteAdapter	headerValueByName(java.lang.String headerName, java.util.function.Function<java.lang.String,Route> inner) Extracts the value of the first HTTP request header with the given name.
<T extends HttpHeader> RouteAdapter	headerValueByType(java.lang.Class<T> t, java.util.function.Function<T,Route> inner) Extracts the first HTTP request header of the given type.
<T> RouteAdapter	headerValuePF(scala.PartialFunction<HttpHeader,T> pf, java.util.function.Function<T,Route> inner) Extracts an HTTP header value using the given partial function.
<T> RouteAdapter	optionalHeaderValue(java.util.function.Function<HttpHeader,java.util.Optional<T>> f, java.util.function.Function<java.util.Optional<T>,Route> inner) Extracts an optional HTTP header value using the given function.
RouteAdapter	optionalHeaderValueByName(java.lang.String headerName, java.util.function.Function<java.util.Optional<java.lang.String>,Route> inner) Extracts the value of the optional HTTP request header with the given name.
<T extends HttpHeader> RouteAdapter	optionalHeaderValueByType(java.lang.Class<T> t, java.util.function.Function<java.util.Optional<T>,Route> inner) FIXME: WARNING: Custom headers don't work yet with this directive!
<T> RouteAdapter	optionalHeaderValuePF(scala.PartialFunction<HttpHeader,T> pf, java.util.function.Function<java.util.Optional<T>,Route> inner) Extracts an optional HTTP header value using the given partial function.

Methods inherited from class org.apache.pekko.http.javadsl.server.directives.FutureDirectives

completeOrRecoverWith, onComplete, onComplete, onCompleteWithBreaker, onSuccess, onSuccess

Methods inherited from class org.apache.pekko.http.javadsl.server.directives.FormFieldDirectives

formField, formField, formFieldList, formFieldList, formFieldList, formFieldMap, formFieldMultiMap, formFieldOptional, formFieldOptional

Methods inherited from class org.apache.pekko.http.javadsl.server.directives.FileUploadDirectives

fileUpload, fileUploadAll, storeUploadedFile, storeUploadedFiles

Methods inherited from class org.apache.pekko.http.javadsl.server.directives.FileAndResourceDirectives

defaultContentTypeResolver, defaultDirectoryRenderer, getFromBrowseableDirectories, getFromBrowseableDirectories, getFromBrowseableDirectories, getFromBrowseableDirectories, getFromBrowseableDirectories, getFromBrowseableDirectory, getFromBrowseableDirectory, getFromBrowseableDirectory, getFromBrowseableDirectory, getFromDirectory, getFromDirectory, getFromFile, getFromFile, getFromFile, getFromFile, getFromFile, getFromResource, getFromResource, getFromResource, getFromResource, getFromResourceDirectory, getFromResourceDirectory, getFromResourceDirectory, getFromResourceDirectory, listDirectoryContents, listDirectoryContents, listDirectoryContents, listDirectoryContents

Methods inherited from class org.apache.pekko.http.javadsl.server.directives.ExecutionDirectives

handleExceptions, handleRejections

Methods inherited from class org.apache.pekko.http.javadsl.server.directives.DebuggingDirectives

logRequest, logRequest, logRequest, logRequestResult, logRequestResultOptional, logResult, logResult, logResult

Methods inherited from class org.apache.pekko.http.javadsl.server.directives.CookieDirectives

cookie, deleteCookie, deleteCookie, deleteCookie, deleteCookie, deleteCookie, optionalCookie, setCookie, setCookie

Methods inherited from class org.apache.pekko.http.javadsl.server.directives.CodingDirectives

decodeRequest, decodeRequestWith, decodeRequestWith, encodeResponse, encodeResponseWith, requestEncodedWith, responseEncodingAccepted, withPrecompressedMediaTypeSupport

Methods inherited from class org.apache.pekko.http.javadsl.server.directives.CacheConditionDirectives

conditional, conditional, conditional, conditional

Methods inherited from class org.apache.pekko.http.javadsl.server.directives.BasicDirectives

cancelRejection, cancelRejections, cancelRejections, extract, extractActorSystem, extractDataBytes, extractEntity, extractExecutionContext, extractLog, extractMatchedPath, extractMaterializer, extractParserSettings, extractRequest, extractRequestContext, extractRequestEntity, extractSettings, extractStrictEntity, extractStrictEntity, extractUnmatchedPath, extractUri, mapInnerRoute, mapRejections, mapRequest, mapRequestContext, mapResponse, mapResponseEntity, mapResponseHeaders, mapRouteResult, mapRouteResultFuture, mapRouteResultPF, mapRouteResultWith, mapRouteResultWithPF, mapSettings, mapUnmatchedPath, pass, provide, recoverRejections, recoverRejectionsWith, toStrictEntity, toStrictEntity, withExecutionContext, withLog, withMaterializer, withSettings

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HeaderDirectives

public HeaderDirectives()

Method Detail

checkSameOrigin

public Route checkSameOrigin(HttpOriginRange allowed,
                             java.util.function.Supplier<Route> inner)

Checks that request comes from the same origin. Extracts the Origin header value and verifies that allowed range contains the obtained value. In the case of absent of the Origin header rejects with MissingHeaderRejection. If the origin value is not in the allowed range rejects with an InvalidOriginRejection and StatusCodes.FORBIDDEN status.

Parameters:

allowed - (undocumented)

inner - (undocumented)

Returns:

(undocumented)

headerValue

public <T> RouteAdapter headerValue(java.util.function.Function<HttpHeader,java.util.Optional<T>> f,
                                    java.util.function.Function<T,Route> inner)

Extracts an HTTP header value using the given function. If the function result is undefined for all headers the request is rejected with an empty rejection set. If the given function throws an exception the request is rejected with a pekko.http.javadsl.server.MalformedHeaderRejection.

Parameters:

f - (undocumented)

inner - (undocumented)

Returns:

(undocumented)

headerValueByName

public RouteAdapter headerValueByName(java.lang.String headerName,
                                      java.util.function.Function<java.lang.String,Route> inner)

Extracts the value of the first HTTP request header with the given name. If no header with a matching name is found the request is rejected with a pekko.http.javadsl.server.MissingHeaderRejection.

Parameters:

headerName - (undocumented)

inner - (undocumented)

Returns:

(undocumented)

headerValueByType

public <T extends HttpHeader> RouteAdapter headerValueByType(java.lang.Class<T> t,
                                                             java.util.function.Function<T,Route> inner)

Extracts the first HTTP request header of the given type. If no header with a matching type is found the request is rejected with a pekko.http.javadsl.server.MissingHeaderRejection.

Parameters:

t - (undocumented)

inner - (undocumented)

Returns:

(undocumented)

headerValuePF

public <T> RouteAdapter headerValuePF(scala.PartialFunction<HttpHeader,T> pf,
                                      java.util.function.Function<T,Route> inner)

Extracts an HTTP header value using the given partial function. If the function is undefined for all headers the request is rejected with an empty rejection set.

Parameters:

pf - (undocumented)

inner - (undocumented)

Returns:

(undocumented)

optionalHeaderValue

public <T> RouteAdapter optionalHeaderValue(java.util.function.Function<HttpHeader,java.util.Optional<T>> f,
                                            java.util.function.Function<java.util.Optional<T>,Route> inner)

Extracts an optional HTTP header value using the given function. If the given function throws an exception the request is rejected with a pekko.http.javadsl.server.MalformedHeaderRejection.

Parameters:

f - (undocumented)

inner - (undocumented)

Returns:

(undocumented)

optionalHeaderValueByName

public RouteAdapter optionalHeaderValueByName(java.lang.String headerName,
                                              java.util.function.Function<java.util.Optional<java.lang.String>,Route> inner)

Extracts the value of the optional HTTP request header with the given name.

Parameters:

headerName - (undocumented)

inner - (undocumented)

Returns:

(undocumented)

optionalHeaderValueByType

public <T extends HttpHeader> RouteAdapter optionalHeaderValueByType(java.lang.Class<T> t,
                                                                     java.util.function.Function<java.util.Optional<T>,Route> inner)

FIXME: WARNING: Custom headers don't work yet with this directive!

Extract the header value of the optional HTTP request header with the given type.

Parameters:

t - (undocumented)

inner - (undocumented)

Returns:

(undocumented)

optionalHeaderValuePF

public <T> RouteAdapter optionalHeaderValuePF(scala.PartialFunction<HttpHeader,T> pf,
                                              java.util.function.Function<java.util.Optional<T>,Route> inner)

Extracts an optional HTTP header value using the given partial function. If the given function throws an exception the request is rejected with a pekko.http.javadsl.server.MalformedHeaderRejection.

Parameters:

pf - (undocumented)

inner - (undocumented)

Returns:

(undocumented)