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

Class FutureDirectives

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

Direct Known Subclasses:

HeaderDirectives

public abstract class FutureDirectives
extends FormFieldDirectives

Constructor Summary

Constructors

Constructor	Description
FutureDirectives()

Method Summary

Modifier and Type	Method	Description
<T> Route	completeOrRecoverWith(Supplier<CompletionStage<T>> f, Marshaller<T,RequestEntity> marshaller, Function<Throwable,Route> inner)	"Unwraps" a CompletionStage and runs the inner route when the stage has failed with the stage's failure exception as an extraction of type Throwable.
<T> RouteAdapter	onComplete(CompletionStage<T> cs, Function<scala.util.Try<T>,Route> inner)	"Unwraps" a CompletionStage and runs the inner route after future completion with the future's value as an extraction of type Try.
<T> RouteAdapter	onComplete(Supplier<CompletionStage<T>> f, Function<scala.util.Try<T>,Route> inner)	"Unwraps" a CompletionStage and runs the inner route after future completion with the future's value as an extraction of type Try.
<T> RouteAdapter	onCompleteWithBreaker(org.apache.pekko.pattern.CircuitBreaker breaker, Supplier<CompletionStage<T>> f, Function<scala.util.Try<T>,Route> inner)	"Unwraps" a CompletionStage[T] and runs the inner route after future completion with the future's value as an extraction of type T if the supplied CircuitBreaker is closed.
<T> RouteAdapter	onSuccess(CompletionStage<T> cs, Function<T,Route> inner)	"Unwraps" a CompletionStage and runs the inner route after stage completion with the stage's value as an extraction of type T.
<T> RouteAdapter	onSuccess(Supplier<CompletionStage<T>> f, Function<T,Route> inner)	"Unwraps" a CompletionStage and runs the inner route after stage completion with the stage's value as an extraction of type T.

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

FutureDirectives

public FutureDirectives()

Method Details

completeOrRecoverWith

public <T> Route completeOrRecoverWith(Supplier<CompletionStage<T>> f,
 Marshaller<T,RequestEntity> marshaller,
 Function<Throwable,Route> inner)

"Unwraps" a CompletionStage and runs the inner route when the stage has failed with the stage's failure exception as an extraction of type Throwable. If the completion stage succeeds the request is completed using the values marshaller (This directive therefore requires a marshaller for the completion stage value type to be provided.)

Parameters:

f - (undocumented)

marshaller - (undocumented)

inner - (undocumented)

Returns:

(undocumented)

onComplete

public <T> RouteAdapter onComplete(Supplier<CompletionStage<T>> f,
 Function<scala.util.Try<T>,Route> inner)

"Unwraps" a CompletionStage and runs the inner route after future completion with the future's value as an extraction of type Try.

Parameters:

f - (undocumented)

inner - (undocumented)

Returns:

(undocumented)

onComplete

public <T> RouteAdapter onComplete(CompletionStage<T> cs,
 Function<scala.util.Try<T>,Route> inner)

"Unwraps" a CompletionStage and runs the inner route after future completion with the future's value as an extraction of type Try.

Parameters:

cs - (undocumented)

inner - (undocumented)

Returns:

(undocumented)

onCompleteWithBreaker

public <T> RouteAdapter onCompleteWithBreaker(org.apache.pekko.pattern.CircuitBreaker breaker,
 Supplier<CompletionStage<T>> f,
 Function<scala.util.Try<T>,Route> inner)

"Unwraps" a CompletionStage[T] and runs the inner route after future completion with the future's value as an extraction of type T if the supplied CircuitBreaker is closed.

If the supplied CircuitBreaker is open the request is rejected with a pekko.http.javadsl.server.CircuitBreakerOpenRejection.

Parameters:

breaker - (undocumented)

f - (undocumented)

inner - (undocumented)

Returns:

(undocumented)

onSuccess

public <T> RouteAdapter onSuccess(Supplier<CompletionStage<T>> f,
 Function<T,Route> inner)

"Unwraps" a CompletionStage and runs the inner route after stage completion with the stage's value as an extraction of type T. If the stage fails its failure Throwable is bubbled up to the nearest ExceptionHandler.

Parameters:

f - (undocumented)

inner - (undocumented)

Returns:

(undocumented)

onSuccess

public <T> RouteAdapter onSuccess(CompletionStage<T> cs,
 Function<T,Route> inner)

"Unwraps" a CompletionStage and runs the inner route after stage completion with the stage's value as an extraction of type T. If the stage fails its failure Throwable is bubbled up to the nearest ExceptionHandler.

Parameters:

cs - (undocumented)

inner - (undocumented)

Returns:

(undocumented)