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

Class RespondWithDirectives

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

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

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

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

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

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

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

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

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

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

Direct Known Subclasses:

RouteDirectives

public abstract class RespondWithDirectives
extends RangeDirectives

Constructor Summary

Constructors

Constructor	Description
RespondWithDirectives()

Method Summary

Modifier and Type	Method	Description
Route	respondWithDefaultHeader(HttpHeader responseHeader, Supplier<Route> inner)	Adds the given response header to all HTTP responses of its inner Route, if the response from the inner Route doesn't already contain a header with the same name.
Route	respondWithDefaultHeaders(Iterable<HttpHeader> responseHeaders, Supplier<Route> inner)	Adds the given response headers to all HTTP responses of its inner Route, if a header already exists it is not added again.
Route	respondWithHeader(HttpHeader responseHeader, Supplier<Route> inner)	Unconditionally adds the given response header to all HTTP responses of its inner Route.
Route	respondWithHeaders(Iterable<HttpHeader> responseHeaders, Supplier<Route> inner)	Unconditionally adds the given response headers to all HTTP responses of its inner Route.

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

withRangeSupport

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

ignoreTrailingSlash, path, path, path, path, path, path, pathEnd, pathEndOrSingleSlash, pathPrefix, pathPrefix, pathPrefix, pathPrefix, pathPrefix, pathPrefix, pathPrefixTest, pathPrefixTest, pathPrefixTest, pathPrefixTest, pathSingleSlash, pathSuffix, pathSuffix, pathSuffix, pathSuffix, pathSuffixTest, pathSuffixTest, pathSuffixTest, pathSuffixTest, rawPathPrefix, rawPathPrefix, rawPathPrefix, rawPathPrefix, rawPathPrefixTest, rawPathPrefixTest, rawPathPrefixTest, rawPathPrefixTest, redirectToNoTrailingSlashIfPresent, redirectToTrailingSlashIfMissing

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

parameter, parameter, parameterList, parameterList, parameterList, parameterMap, parameterMultiMap, parameterOptional, parameterOptional, parameterOrDefault, parameterRequiredValue

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

extractClientIP, rejectEmptyResponse, requestEntityEmpty, requestEntityPresent, selectPreferredLanguage, validate, withoutSizeLimit, withSizeLimit

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

delete, extractMethod, get, head, method, options, overrideMethodWithParameter, patch, post, put

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

completeWith, entity, handleWith, request

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

extractHost, host, host, host, host

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

attribute, optionalAttribute

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

checkSameOrigin, headerValue, headerValueByName, headerValueByType, headerValuePF, optionalHeaderValue, optionalHeaderValueByName, optionalHeaderValueByType, optionalHeaderValuePF

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, extractStrictEntity, extractStrictEntity, extractUnmatchedPath, extractUri, mapInnerRoute, mapRejections, mapRequest, mapRequestContext, mapResponse, mapResponseEntity, mapResponseHeaders, mapRouteResult, mapRouteResultFuture, mapRouteResultPF, mapRouteResultWith, mapRouteResultWithPF, mapSettings, mapUnmatchedPath, pass, provide, recoverRejections, recoverRejectionsWith, toStrictEntity, toStrictEntity, 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 Details

RespondWithDirectives

public RespondWithDirectives()

Method Details

respondWithDefaultHeader

public Route respondWithDefaultHeader(HttpHeader responseHeader,
 Supplier<Route> inner)

Adds the given response header to all HTTP responses of its inner Route, if the response from the inner Route doesn't already contain a header with the same name.

Parameters:

responseHeader - (undocumented)

inner - (undocumented)

Returns:

(undocumented)

respondWithDefaultHeaders

public Route respondWithDefaultHeaders(Iterable<HttpHeader> responseHeaders,
 Supplier<Route> inner)

Adds the given response headers to all HTTP responses of its inner Route, if a header already exists it is not added again.

Parameters:

responseHeaders - (undocumented)

inner - (undocumented)

Returns:

(undocumented)

respondWithHeader

public Route respondWithHeader(HttpHeader responseHeader,
 Supplier<Route> inner)

Unconditionally adds the given response header to all HTTP responses of its inner Route.

Parameters:

responseHeader - (undocumented)

inner - (undocumented)

Returns:

(undocumented)

respondWithHeaders

public Route respondWithHeaders(Iterable<HttpHeader> responseHeaders,
 Supplier<Route> inner)

Unconditionally adds the given response headers to all HTTP responses of its inner Route.

Parameters:

responseHeaders - (undocumented)

inner - (undocumented)

Returns:

(undocumented)