Package akka.http.javadsl.server

Class Directives

java.lang.Object

akka.http.javadsl.server.Directives

public class Directives
extends Object

Collects all default directives into one class for simple importing of static functions.

See Directives for ScalaDSL equivalent of this class.

Constructor Summary

Constructors

Constructor	Description
Directives()

Method Summary

Modifier and Type	Method	Description
static <A, B> Route	allOf(Function<Function<A,Route>,Route> first, Function<Function<B,Route>,Route> second, BiFunction<A,B,Route> inner)	Nests two 1-argument directives together Usage example: allOf(this::extractScheme, this::extractMethod, (scheme, method) -> complete("You did a " + method.name() + " using " + scheme))
static <A> Route	allOf(Function<Supplier<Route>,Route> first, Function<Function<A,Route>,Route> second, Function<A,Route> inner)	Nests one 0-argument and 1-argument directives together Usage example: allOf(bindParameter(this::pathPrefix, "guess"), this::extractMethod, method -> complete("You did a " + method.name()))
static Route	allOf(Function<Supplier<Route>,Route> first, Function<Supplier<Route>,Route> second, Supplier<Route> inner)	Nests two 0-argument directives together Usage example: allOf(bindParameter(this::pathPrefix, "alice"), bindParameter(this::path, "bob"), () -> complete("Charlie!"))

Methods inherited from class java.lang.Object

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

Constructor Details

Directives

public Directives()

Method Details

route

public static Route route(Route... alternatives)

getFromBrowseableDirectories

public static Route getFromBrowseableDirectories(String... directories)

route

public static Route route(scala.collection.immutable.Seq<Route> alternatives)

getFromBrowseableDirectories

public static Route getFromBrowseableDirectories(scala.collection.immutable.Seq<String> directories)

anyOf

public static Route anyOf(Function<Supplier<Route>,Route> first,
 Function<Supplier<Route>,Route> second,
 Supplier<Route> inner)

Composes two 0-argument directives which share the same inner Route. This is equivalent to first(inner).orElse(second(inner)) Usage example: anyOf(this::get, this::post, () -> complete("hi")))

Parameters:

first - the first 0-argument directive

second - the second 0-argument directive

inner - the inner route Producer

Returns:

the resulting route

anyOf

public static <A> Route anyOf(Function<Function<A,Route>,Route> first,
 Function<Function<A,Route>,Route> second,
 Function<A,Route> inner)

Composes two 1-argument directives (directives whose inner route takes a parameter) which share the same inner route. This is the same as first(inner).orElse(second(inner)). This can be used also for directives that take an additional parameter if the directive is partially applied, ie. parameter Usage example: anyOf(bindParameter(this::path, "bar"), bindParameter(this::path, "baz"), () -> complete("bar or baz"))

Parameters:

first - the first 1-argument directive

second - the second 1-argument directive

inner - the inner route that takes one argument

Returns:

the resulting route

allOf

public static Route allOf(Function<Supplier<Route>,Route> first,
 Function<Supplier<Route>,Route> second,
 Supplier<Route> inner)

Nests two 0-argument directives together Usage example: allOf(bindParameter(this::pathPrefix, "alice"), bindParameter(this::path, "bob"), () -> complete("Charlie!"))

Parameters:

first - the 0-argument directive (outer one)

second - the 0-argument directive (inner one)

inner - the inner route function

Returns:

the resulting route

allOf

public static <A,
B> Route allOf(Function<Function<A,Route>,Route> first,
 Function<Function<B,Route>,Route> second,
 BiFunction<A,B,Route> inner)

Nests two 1-argument directives together Usage example: allOf(this::extractScheme, this::extractMethod, (scheme, method) -> complete("You did a " + method.name() + " using " + scheme))

Parameters:

first - the first 1-argument directive (outer one)

second - the second 1-argument directive (inner one)

inner - the inner route function that takes 2 different parameters

Returns:

the resulting route

allOf

public static <A> Route allOf(Function<Supplier<Route>,Route> first,
 Function<Function<A,Route>,Route> second,
 Function<A,Route> inner)

Nests one 0-argument and 1-argument directives together Usage example: allOf(bindParameter(this::pathPrefix, "guess"), this::extractMethod, method -> complete("You did a " + method.name()))

Parameters:

first - the 0-argument directive (outer one)

second - the 1-argument directive (inner one)

inner - the inner route function that takes 1 parameter

Returns:

the resulting route

mapRequest

public static Route mapRequest(Function<HttpRequest,HttpRequest> f,
 Supplier<Route> inner)

mapRequestContext

public static Route mapRequestContext(Function<RequestContext,RequestContext> f,
 Supplier<Route> inner)

mapRejections

public static Route mapRejections(Function<List<Rejection>,List<Rejection>> f,
 Supplier<Route> inner)

mapResponse

public static Route mapResponse(Function<HttpResponse,HttpResponse> f,
 Supplier<Route> inner)

mapResponseEntity

public static Route mapResponseEntity(Function<ResponseEntity,ResponseEntity> f,
 Supplier<Route> inner)

mapResponseHeaders

public static Route mapResponseHeaders(Function<List<HttpHeader>,List<HttpHeader>> f,
 Supplier<Route> inner)

mapInnerRoute

public static Route mapInnerRoute(Function<Route,Route> f,
 Supplier<Route> inner)

mapRouteResult

public static Route mapRouteResult(Function<RouteResult,RouteResult> f,
 Supplier<Route> inner)

mapRouteResultPF

public static Route mapRouteResultPF(scala.PartialFunction<RouteResult,RouteResult> f,
 Supplier<Route> inner)

mapRouteResultFuture

public static Route mapRouteResultFuture(Function<CompletionStage<RouteResult>,CompletionStage<RouteResult>> f,
 Supplier<Route> inner)

mapRouteResultWith

public static Route mapRouteResultWith(Function<RouteResult,CompletionStage<RouteResult>> f,
 Supplier<Route> inner)

mapRouteResultWithPF

public static Route mapRouteResultWithPF(scala.PartialFunction<RouteResult,CompletionStage<RouteResult>> f,
 Supplier<Route> inner)

mapSettings

public static Route mapSettings(Function<RoutingSettings,RoutingSettings> f,
 Supplier<Route> inner)

pass

public static Route pass(Supplier<Route> inner)

provide

public static <T> Route provide(T t,
 Function<T,Route> inner)

cancelRejection

public static Route cancelRejection(Rejection rejection,
 Supplier<Route> inner)

cancelRejections

public static Route cancelRejections(Iterable<Class<?>> classes,
 Supplier<Route> inner)

cancelRejections

public static Route cancelRejections(Predicate<Rejection> filter,
 Supplier<Route> inner)

recoverRejections

public static Route recoverRejections(Function<Iterable<Rejection>,RouteResult> f,
 Supplier<Route> inner)

recoverRejectionsWith

public static Route recoverRejectionsWith(Function<Iterable<Rejection>,CompletionStage<RouteResult>> f,
 Supplier<Route> inner)

mapUnmatchedPath

public static Route mapUnmatchedPath(Function<String,String> f,
 Supplier<Route> inner)

extractUnmatchedPath

public static RouteAdapter extractUnmatchedPath(Function<String,Route> inner)

extractMatchedPath

public static RouteAdapter extractMatchedPath(Function<String,Route> inner)

extractRequest

public static RouteAdapter extractRequest(Function<HttpRequest,Route> inner)

extractUri

public static RouteAdapter extractUri(Function<Uri,Route> inner)

extractEntity

public static Route extractEntity(Function<RequestEntity,Route> inner)

extractMaterializer

public static Route extractMaterializer(Function<akka.stream.Materializer,Route> inner)

extractActorSystem

public static Route extractActorSystem(Function<akka.actor.ActorSystem,Route> inner)

extractExecutionContext

public static Route extractExecutionContext(Function<scala.concurrent.ExecutionContextExecutor,Route> inner)

extract

public static <T> Route extract(Function<RequestContext,T> extract,
 Function<T,Route> inner)

withLog

public static Route withLog(akka.event.LoggingAdapter log,
 Supplier<Route> inner)

withExecutionContext

public static Route withExecutionContext(scala.concurrent.ExecutionContextExecutor ec,
 Supplier<Route> inner)

withMaterializer

public static Route withMaterializer(akka.stream.Materializer mat,
 Supplier<Route> inner)

withSettings

public static Route withSettings(RoutingSettings s,
 Supplier<Route> inner)

extractLog

public static Route extractLog(Function<akka.event.LoggingAdapter,Route> inner)

extractParserSettings

public static RouteAdapter extractParserSettings(Function<ParserSettings,Route> inner)

extractSettings

public static RouteAdapter extractSettings(Function<RoutingSettings,Route> inner)

extractRequestContext

public static RouteAdapter extractRequestContext(Function<RequestContext,Route> inner)

extractDataBytes

public static RouteAdapter extractDataBytes(Function<akka.stream.javadsl.Source<akka.util.ByteString,Object>,Route> inner)

extractRequestEntity

public static Route extractRequestEntity(Function<RequestEntity,Route> inner)

extractStrictEntity

public static Route extractStrictEntity(scala.concurrent.duration.FiniteDuration timeout,
 Function<HttpEntity.Strict,Route> inner)

extractStrictEntity

public static Route extractStrictEntity(scala.concurrent.duration.FiniteDuration timeout,
 long maxBytes,
 Function<HttpEntity.Strict,Route> inner)

toStrictEntity

public static Route toStrictEntity(scala.concurrent.duration.FiniteDuration timeout,
 Supplier<Route> inner)

toStrictEntity

public static Route toStrictEntity(scala.concurrent.duration.FiniteDuration timeout,
 long maxBytes,
 Supplier<Route> inner)

conditional

public static Route conditional(EntityTag eTag,
 Supplier<Route> inner)

conditional

public static Route conditional(DateTime lastModified,
 Supplier<Route> inner)

conditional

public static Route conditional(EntityTag eTag,
 DateTime lastModified,
 Supplier<Route> inner)

conditional

public static Route conditional(Optional<EntityTag> eTag,
 Optional<DateTime> lastModified,
 Supplier<Route> inner)

responseEncodingAccepted

public static Route responseEncodingAccepted(HttpEncoding encoding,
 Supplier<Route> inner)

encodeResponse

public static Route encodeResponse(Supplier<Route> inner)

encodeResponseWith

public static Route encodeResponseWith(Iterable<Coder> coders,
 Supplier<Route> inner)

decodeRequestWith

public static Route decodeRequestWith(Coder coder,
 Supplier<Route> inner)

requestEncodedWith

public static Route requestEncodedWith(HttpEncoding encoding,
 Supplier<Route> inner)

decodeRequestWith

public static Route decodeRequestWith(Iterable<Coder> coders,
 Supplier<Route> inner)

decodeRequest

public static Route decodeRequest(Supplier<Route> inner)

withPrecompressedMediaTypeSupport

public static Route withPrecompressedMediaTypeSupport(Supplier<Route> inner)

cookie

public static Route cookie(String name,
 Function<HttpCookiePair,Route> inner)

optionalCookie

public static Route optionalCookie(String name,
 Function<Optional<HttpCookiePair>,Route> inner)

setCookie

public static Route setCookie(HttpCookie cookie,
 Supplier<Route> inner)

setCookie

public static Route setCookie(Iterable<HttpCookie> cookies,
 Supplier<Route> inner)

deleteCookie

public static Route deleteCookie(HttpCookie cookie,
 Supplier<Route> inner)

deleteCookie

public static Route deleteCookie(Iterable<HttpCookie> cookies,
 Supplier<Route> inner)

deleteCookie

public static Route deleteCookie(String name,
 Supplier<Route> inner)

deleteCookie

public static Route deleteCookie(String name,
 String domain,
 Supplier<Route> inner)

deleteCookie

public static Route deleteCookie(String name,
 String domain,
 String path,
 Supplier<Route> inner)

logRequest

public static Route logRequest(String marker,
 Supplier<Route> inner)

logRequest

public static Route logRequest(String marker,
 akka.event.Logging.LogLevel level,
 Supplier<Route> inner)

logRequest

public static Route logRequest(Function<HttpRequest,LogEntry> show,
 Supplier<Route> inner)

logResult

public static Route logResult(String marker,
 Supplier<Route> inner)

logResult

public static Route logResult(String marker,
 akka.event.Logging.LogLevel level,
 Supplier<Route> inner)

logResult

public static RouteAdapter logResult(Function<HttpResponse,LogEntry> showSuccess,
 Function<List<Rejection>,LogEntry> showRejection,
 Supplier<Route> inner)

logRequestResult

public static RouteAdapter logRequestResult(BiFunction<HttpRequest,HttpResponse,LogEntry> showSuccess,
 BiFunction<HttpRequest,List<Rejection>,LogEntry> showRejection,
 Supplier<Route> inner)

logRequestResultOptional

public static RouteAdapter logRequestResultOptional(BiFunction<HttpRequest,HttpResponse,Optional<LogEntry>> showSuccess,
 BiFunction<HttpRequest,List<Rejection>,Optional<LogEntry>> showRejection,
 Supplier<Route> inner)

handleExceptions

public static RouteAdapter handleExceptions(ExceptionHandler handler,
 Supplier<Route> inner)

handleRejections

public static RouteAdapter handleRejections(RejectionHandler handler,
 Supplier<Route> inner)

getFromResource

public static Route getFromResource(String path)

getFromResource

public static Route getFromResource(String path,
 ContentTypeResolver resolver)

getFromResource

public static Route getFromResource(String path,
 ContentType contentType)

getFromResource

public static Route getFromResource(String path,
 ContentType contentType,
 ClassLoader classLoader)

getFromResourceDirectory

public static Route getFromResourceDirectory(String directoryName)

getFromResourceDirectory

public static Route getFromResourceDirectory(String directoryName,
 ClassLoader classLoader)

getFromResourceDirectory

public static Route getFromResourceDirectory(String directoryName,
 ContentTypeResolver resolver)

getFromResourceDirectory

public static Route getFromResourceDirectory(String directoryName,
 ContentTypeResolver resolver,
 ClassLoader classLoader)

getFromFile

public static Route getFromFile(File file)

getFromFile

public static Route getFromFile(File file,
 ContentTypeResolver resolver)

getFromFile

public static Route getFromFile(File file,
 ContentType contentType)

getFromFile

public static Route getFromFile(String file)

getFromFile

public static Route getFromFile(String file,
 ContentTypeResolver resolver)

getFromDirectory

public static Route getFromDirectory(String directoryPath)

getFromDirectory

public static Route getFromDirectory(String directoryPath,
 ContentTypeResolver resolver)

getFromBrowseableDirectory

public static Route getFromBrowseableDirectory(String directory,
 DirectoryRenderer renderer,
 ContentTypeResolver resolver)

getFromBrowseableDirectory

public static Route getFromBrowseableDirectory(String directory,
 DirectoryRenderer renderer)

getFromBrowseableDirectory

public static Route getFromBrowseableDirectory(String directory,
 ContentTypeResolver resolver)

getFromBrowseableDirectory

public static Route getFromBrowseableDirectory(String directory)

listDirectoryContents

public static Route listDirectoryContents(scala.collection.immutable.Seq<String> directories)

listDirectoryContents

public static Route listDirectoryContents(DirectoryRenderer directoryRenderer,
 scala.collection.immutable.Seq<String> directories)

defaultDirectoryRenderer

public static DirectoryRenderer defaultDirectoryRenderer()

defaultContentTypeResolver

public static ContentTypeResolver defaultContentTypeResolver()

listDirectoryContents

public static Route listDirectoryContents(String... directories)

listDirectoryContents

public static Route listDirectoryContents(DirectoryRenderer directoryRenderer,
 String... directories)

storeUploadedFile

public static Route storeUploadedFile(String fieldName,
 Function<FileInfo,File> destFn,
 BiFunction<FileInfo,File,Route> inner)

storeUploadedFiles

public static Route storeUploadedFiles(String fieldName,
 Function<FileInfo,File> destFn,
 Function<List<Map.Entry<FileInfo,File>>,Route> inner)

fileUpload

public static Route fileUpload(String fieldName,
 BiFunction<FileInfo,akka.stream.javadsl.Source<akka.util.ByteString,Object>,Route> inner)

fileUploadAll

public static Route fileUploadAll(String fieldName,
 Function<List<Map.Entry<FileInfo,akka.stream.javadsl.Source<akka.util.ByteString,Object>>>,Route> inner)

formField

public static Route formField(String name,
 Function<String,Route> inner)

formFieldOptional

public static Route formFieldOptional(String name,
 Function<Optional<String>,Route> inner)

formFieldList

public static Route formFieldList(String name,
 Function<List<String>,Route> inner)

formField

public static <T> Route formField(Unmarshaller<String,T> t,
 String name,
 Function<T,Route> inner)

formFieldOptional

public static <T> Route formFieldOptional(Unmarshaller<String,T> t,
 String name,
 Function<Optional<T>,Route> inner)

formFieldList

public static <T> Route formFieldList(Unmarshaller<String,T> t,
 String name,
 Function<List<T>,Route> inner)

formFieldMap

public static Route formFieldMap(Function<Map<String,String>,Route> inner)

formFieldMultiMap

public static Route formFieldMultiMap(Function<Map<String,List<String>>,Route> inner)

formFieldList

public static Route formFieldList(Function<List<Map.Entry<String,String>>,Route> inner)

onComplete

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

onComplete

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

onCompleteWithBreaker

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

onSuccess

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

onSuccess

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

completeOrRecoverWith

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

checkSameOrigin

public static Route checkSameOrigin(HttpOriginRange allowed,
 Supplier<Route> inner)

headerValue

public static <T> RouteAdapter headerValue(Function<HttpHeader,Optional<T>> f,
 Function<T,Route> inner)

headerValuePF

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

headerValueByName

public static RouteAdapter headerValueByName(String headerName,
 Function<String,Route> inner)

headerValueByType

public static <T extends HttpHeader> RouteAdapter headerValueByType(Class<T> t,
 Function<T,Route> inner)

optionalHeaderValue

public static <T> RouteAdapter optionalHeaderValue(Function<HttpHeader,Optional<T>> f,
 Function<Optional<T>,Route> inner)

optionalHeaderValuePF

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

optionalHeaderValueByName

public static RouteAdapter optionalHeaderValueByName(String headerName,
 Function<Optional<String>,Route> inner)

optionalHeaderValueByType

public static <T extends HttpHeader> RouteAdapter optionalHeaderValueByType(Class<T> t,
 Function<Optional<T>,Route> inner)

attribute

public static <T> RouteAdapter attribute(AttributeKey<T> key,
 Function<T,Route> inner)

optionalAttribute

public static <T> RouteAdapter optionalAttribute(AttributeKey<T> key,
 Function<Optional<T>,Route> inner)

extractHost

public static Route extractHost(Function<String,Route> inner)

host

public static Route host(Iterable<String> hostNames,
 Supplier<Route> inner)

host

public static Route host(String hostName,
 Supplier<Route> inner)

host

public static Route host(Predicate<String> predicate,
 Supplier<Route> inner)

host

public static Route host(Pattern regex,
 Function<String,Route> inner)

request

public static <T> Route request(Unmarshaller<? super HttpRequest,T> unmarshaller,
 Function<T,Route> inner)

entity

public static <T> Route entity(Unmarshaller<? super HttpEntity,T> unmarshaller,
 Function<T,Route> inner)

completeWith

public static <T> Route completeWith(Marshaller<T,? extends HttpResponse> marshaller,
 Consumer<Consumer<T>> inner)

handleWith

public static <T,
R> Route handleWith(Unmarshaller<? super HttpEntity,T> unmarshaller,
 Marshaller<R,? extends HttpResponse> marshaller,
 Function<T,R> inner)

delete

public static Route delete(Supplier<Route> inner)

get

public static Route get(Supplier<Route> inner)

head

public static Route head(Supplier<Route> inner)

options

public static Route options(Supplier<Route> inner)

patch

public static Route patch(Supplier<Route> inner)

post

public static Route post(Supplier<Route> inner)

put

public static Route put(Supplier<Route> inner)

extractMethod

public static RouteAdapter extractMethod(Function<HttpMethod,Route> inner)

method

public static Route method(HttpMethod method,
 Supplier<Route> inner)

overrideMethodWithParameter

public static Route overrideMethodWithParameter(String paramName,
 Supplier<Route> inner)

validate

public static Route validate(BooleanSupplier check,
 String errorMsg,
 Supplier<Route> inner)

extractClientIP

public static Route extractClientIP(Function<RemoteAddress,Route> inner)

requestEntityEmpty

public static Route requestEntityEmpty(Supplier<Route> inner)

requestEntityPresent

public static Route requestEntityPresent(Supplier<Route> inner)

rejectEmptyResponse

public static Route rejectEmptyResponse(Supplier<Route> inner)

withSizeLimit

public static Route withSizeLimit(long maxBytes,
 Supplier<Route> inner)

withoutSizeLimit

public static Route withoutSizeLimit(Supplier<Route> inner)

selectPreferredLanguage

public static Route selectPreferredLanguage(Iterable<Language> languages,
 Function<Language,Route> inner)

parameter

public static Route parameter(String name,
 Function<String,Route> inner)

parameterOptional

public static Route parameterOptional(String name,
 Function<Optional<String>,Route> inner)

parameterRequiredValue

public static <T> Route parameterRequiredValue(Unmarshaller<String,T> t,
 T requiredValue,
 String name,
 Supplier<Route> inner)

parameterList

public static Route parameterList(String name,
 Function<List<String>,Route> inner)

parameter

public static <T> Route parameter(Unmarshaller<String,T> t,
 String name,
 Function<T,Route> inner)

parameterOptional

public static <T> Route parameterOptional(Unmarshaller<String,T> t,
 String name,
 Function<Optional<T>,Route> inner)

parameterOrDefault

public static <T> Route parameterOrDefault(Unmarshaller<String,T> t,
 T defaultValue,
 String name,
 Function<T,Route> inner)

parameterList

public static <T> Route parameterList(Unmarshaller<String,T> t,
 String name,
 Function<List<T>,Route> inner)

parameterMap

public static Route parameterMap(Function<Map<String,String>,Route> inner)

parameterMultiMap

public static Route parameterMultiMap(Function<Map<String,List<String>>,Route> inner)

parameterList

public static Route parameterList(Function<List<Map.Entry<String,String>>,Route> inner)

pathEnd

public static Route pathEnd(Supplier<Route> inner)

pathEndOrSingleSlash

public static Route pathEndOrSingleSlash(Supplier<Route> inner)

pathSingleSlash

public static Route pathSingleSlash(Supplier<Route> inner)

path

public static Route path(String segment,
 Supplier<Route> inner)

path

public static Route path(Function<String,Route> inner)

path

public static Route path(PathMatcher0 p,
 Supplier<Route> inner)

path

public static <T> Route path(PathMatcher1<T> p,
 Function<T,Route> inner)

path

public static <T1,
T2> Route path(PathMatcher2<T1,T2> p,
 BiFunction<T1,T2,Route> inner)

pathPrefix

public static Route pathPrefix(String segment,
 Supplier<Route> inner)

pathPrefix

public static Route pathPrefix(Function<String,Route> inner)

pathPrefix

public static Route pathPrefix(PathMatcher0 p,
 Supplier<Route> inner)

pathPrefix

public static <T> Route pathPrefix(PathMatcher1<T> p,
 Function<T,Route> inner)

pathPrefix

public static <T1,
T2> Route pathPrefix(PathMatcher2<T1,T2> p,
 BiFunction<T1,T2,Route> inner)

rawPathPrefix

public static Route rawPathPrefix(String segment,
 Supplier<Route> inner)

rawPathPrefix

public static Route rawPathPrefix(PathMatcher0 pm,
 Supplier<Route> inner)

rawPathPrefix

public static <T1> Route rawPathPrefix(PathMatcher1<T1> pm,
 Function<T1,Route> inner)

rawPathPrefix

public static <T1,
T2> Route rawPathPrefix(PathMatcher2<T1,T2> pm,
 BiFunction<T1,T2,Route> inner)

pathPrefixTest

public static Route pathPrefixTest(String segment,
 Supplier<Route> inner)

pathPrefixTest

public static Route pathPrefixTest(PathMatcher0 pm,
 Supplier<Route> inner)

pathPrefixTest

public static <T1> Route pathPrefixTest(PathMatcher1<T1> pm,
 Function<T1,Route> inner)

pathPrefixTest

public static <T1,
T2> Route pathPrefixTest(PathMatcher2<T1,T2> pm,
 BiFunction<T1,T2,Route> inner)

rawPathPrefixTest

public static Route rawPathPrefixTest(String segment,
 Supplier<Route> inner)

rawPathPrefixTest

public static Route rawPathPrefixTest(PathMatcher0 pm,
 Supplier<Route> inner)

rawPathPrefixTest

public static <T1> Route rawPathPrefixTest(PathMatcher1<T1> pm,
 Function<T1,Route> inner)

rawPathPrefixTest

public static <T1,
T2> Route rawPathPrefixTest(PathMatcher2<T1,T2> pm,
 BiFunction<T1,T2,Route> inner)

pathSuffix

public static Route pathSuffix(String segment,
 Supplier<Route> inner)

pathSuffix

public static Route pathSuffix(PathMatcher0 pm,
 Supplier<Route> inner)

pathSuffix

public static <T1> Route pathSuffix(PathMatcher1<T1> pm,
 Function<T1,Route> inner)

pathSuffix

public static <T1,
T2> Route pathSuffix(PathMatcher2<T1,T2> pm,
 BiFunction<T1,T2,Route> inner)

pathSuffixTest

public static Route pathSuffixTest(String segment,
 Supplier<Route> inner)

pathSuffixTest

public static Route pathSuffixTest(PathMatcher0 pm,
 Supplier<Route> inner)

pathSuffixTest

public static <T1> Route pathSuffixTest(PathMatcher1<T1> pm,
 Function<T1,Route> inner)

pathSuffixTest

public static <T1,
T2> Route pathSuffixTest(PathMatcher2<T1,T2> pm,
 BiFunction<T1,T2,Route> inner)

redirectToTrailingSlashIfMissing

public static Route redirectToTrailingSlashIfMissing(StatusCode redirectionType,
 Supplier<Route> inner)

redirectToNoTrailingSlashIfPresent

public static Route redirectToNoTrailingSlashIfPresent(StatusCode redirectionType,
 Supplier<Route> inner)

pathPrefix

public static <T> Route pathPrefix(Unmarshaller<String,T> t,
 Function<T,Route> inner)

path

public static <T> Route path(Unmarshaller<String,T> t,
 Function<T,Route> inner)

ignoreTrailingSlash

public static Route ignoreTrailingSlash(Supplier<Route> inner)

withRangeSupport

public static Route withRangeSupport(Supplier<Route> inner)

respondWithHeader

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

respondWithDefaultHeader

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

respondWithHeaders

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

respondWithDefaultHeaders

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

concat

public static Route concat(Route first,
 scala.collection.immutable.Seq<Route> alternatives)

reject

public static Route reject(Rejection rejection,
 scala.collection.immutable.Seq<Rejection> rejections)

reject

public static Route reject()

redirect

public static Route redirect(Uri uri,
 StatusCode redirectionType)

failWith

public static Route failWith(Throwable error)

complete

public static Route complete(String body)

complete

public static Route complete(HttpResponse response)

complete

public static Route complete(StatusCode status)

complete

public static <T> RouteAdapter complete(T value,
 Marshaller<T,HttpResponse> marshaller)

complete

public static <T> RouteAdapter complete(StatusCode status,
 Iterable<HttpHeader> headers,
 T value,
 Marshaller<T,RequestEntity> marshaller)

complete

public static RouteAdapter complete(StatusCode status,
 Iterable<HttpHeader> headers,
 ResponseEntity entity)

complete

public static RouteAdapter complete(StatusCode status,
 Iterable<HttpHeader> headers,
 RequestEntity entity)

complete

public static <T> RouteAdapter complete(StatusCode status,
 T value,
 Marshaller<T,RequestEntity> marshaller)

complete

public static RouteAdapter complete(StatusCode status,
 ResponseEntity entity)

complete

public static RouteAdapter complete(StatusCode status,
 RequestEntity entity)

complete

public static RouteAdapter complete(StatusCode status,
 String entity)

complete

public static <T> RouteAdapter complete(Iterable<HttpHeader> headers,
 T value,
 Marshaller<T,RequestEntity> marshaller)

complete

public static RouteAdapter complete(Iterable<HttpHeader> headers,
 ResponseEntity entity)

complete

public static RouteAdapter complete(Iterable<HttpHeader> headers,
 RequestEntity entity)

completeOK

public static <T> RouteAdapter completeOK(T value,
 Marshaller<T,RequestEntity> marshaller)

complete

public static RouteAdapter complete(ResponseEntity entity)

complete

public static RouteAdapter complete(RequestEntity entity)

completeWithFutureResponse

public static RouteAdapter completeWithFutureResponse(scala.concurrent.Future<HttpResponse> value)

completeOKWithFutureString

public static RouteAdapter completeOKWithFutureString(scala.concurrent.Future<String> value)

completeWithFutureStatus

public static Route completeWithFutureStatus(scala.concurrent.Future<StatusCode> status)

completeOKWithFuture

public static <T> RouteAdapter completeOKWithFuture(scala.concurrent.Future<T> value,
 Marshaller<T,RequestEntity> marshaller)

completeWithFuture

public static <T> RouteAdapter completeWithFuture(scala.concurrent.Future<T> value,
 Marshaller<T,HttpResponse> marshaller)

completeWithFuture

public static RouteAdapter completeWithFuture(CompletionStage<HttpResponse> value)

completeOKWithFuture

public static RouteAdapter completeOKWithFuture(CompletionStage<RequestEntity> value)

completeOKWithFutureString

public static RouteAdapter completeOKWithFutureString(CompletionStage<String> value)

completeWithFutureStatus

public static Route completeWithFutureStatus(CompletionStage<StatusCode> status)

completeOKWithFuture

public static <T> RouteAdapter completeOKWithFuture(CompletionStage<T> value,
 Marshaller<T,RequestEntity> marshaller)

completeWithFuture

public static <T> RouteAdapter completeWithFuture(CompletionStage<T> value,
 Marshaller<T,HttpResponse> marshaller)

handle

public static Route handle(akka.japi.function.Function<HttpRequest,CompletionStage<HttpResponse>> handler)

handleSync

public static Route handleSync(akka.japi.function.Function<HttpRequest,HttpResponse> handler)

concat

public static Route concat(Route first,
 Route... alternatives)

reject

public static Route reject(Rejection rejection,
 Rejection... rejections)

extractScheme

public static Route extractScheme(Function<String,Route> inner)

scheme

public static Route scheme(String name,
 Supplier<Route> inner)

extractCredentials

public static Route extractCredentials(Function<Optional<HttpCredentials>,Route> inner)

authenticateBasic

public static <T> Route authenticateBasic(String realm,
 Function<Optional<SecurityDirectives.ProvidedCredentials>,Optional<T>> authenticator,
 Function<T,Route> inner)

authenticateBasicPF

public static <T> Route authenticateBasicPF(String realm,
 scala.PartialFunction<Optional<SecurityDirectives.ProvidedCredentials>,T> authenticator,
 Function<T,Route> inner)

authenticateBasicPFAsync

public static <T> Route authenticateBasicPFAsync(String realm,
 scala.PartialFunction<Optional<SecurityDirectives.ProvidedCredentials>,CompletionStage<T>> authenticator,
 Function<T,Route> inner)

authenticateBasicOptional

public static <T> Route authenticateBasicOptional(String realm,
 Function<Optional<SecurityDirectives.ProvidedCredentials>,Optional<T>> authenticator,
 Function<Optional<T>,Route> inner)

authenticateBasicAsync

public static <T> Route authenticateBasicAsync(String realm,
 Function<Optional<SecurityDirectives.ProvidedCredentials>,CompletionStage<Optional<T>>> authenticator,
 Function<T,Route> inner)

authenticateBasicAsyncOptional

public static <T> Route authenticateBasicAsyncOptional(String realm,
 Function<Optional<SecurityDirectives.ProvidedCredentials>,CompletionStage<Optional<T>>> authenticator,
 Function<Optional<T>,Route> inner)

authenticateOAuth2

public static <T> Route authenticateOAuth2(String realm,
 Function<Optional<SecurityDirectives.ProvidedCredentials>,Optional<T>> authenticator,
 Function<T,Route> inner)

authenticateOAuth2Optional

public static <T> Route authenticateOAuth2Optional(String realm,
 Function<Optional<SecurityDirectives.ProvidedCredentials>,Optional<T>> authenticator,
 Function<Optional<T>,Route> inner)

authenticateOAuth2Async

public static <T> Route authenticateOAuth2Async(String realm,
 Function<Optional<SecurityDirectives.ProvidedCredentials>,CompletionStage<Optional<T>>> authenticator,
 Function<T,Route> inner)

authenticateOAuth2AsyncOptional

public static <T> Route authenticateOAuth2AsyncOptional(String realm,
 Function<Optional<SecurityDirectives.ProvidedCredentials>,CompletionStage<Optional<T>>> authenticator,
 Function<Optional<T>,Route> inner)

authenticateOrRejectWithChallenge

public static <T> Route authenticateOrRejectWithChallenge(Function<Optional<HttpCredentials>,CompletionStage<scala.util.Either<HttpChallenge,T>>> authenticator,
 Function<T,Route> inner)

authenticateOrRejectWithChallenge

public static <C extends HttpCredentials,
T> Route authenticateOrRejectWithChallenge(Class<C> c,
 Function<Optional<C>,CompletionStage<scala.util.Either<HttpChallenge,T>>> authenticator,
 Function<T,Route> inner)

authorize

public static Route authorize(Supplier<Object> check,
 Supplier<Route> inner)

authorizeWithRequestContext

public static Route authorizeWithRequestContext(akka.japi.function.Function<RequestContext,Object> check,
 Supplier<Route> inner)

authorizeAsync

public static Route authorizeAsync(Supplier<CompletionStage<Object>> check,
 Supplier<Route> inner)

authorizeAsyncWithRequestContext

public static Route authorizeAsyncWithRequestContext(akka.japi.function.Function<RequestContext,CompletionStage<Object>> check,
 Supplier<Route> inner)

extractUpgradeToWebSocket

public static Route extractUpgradeToWebSocket(Function<UpgradeToWebSocket,Route> inner)

extractWebSocketUpgrade

public static Route extractWebSocketUpgrade(Function<WebSocketUpgrade,Route> inner)

extractOfferedWsProtocols

public static Route extractOfferedWsProtocols(Function<List<String>,Route> inner)

handleWebSocketMessages

public static <T> Route handleWebSocketMessages(akka.stream.javadsl.Flow<Message,Message,T> handler)

handleWebSocketMessagesForProtocol

public static <T> Route handleWebSocketMessagesForProtocol(akka.stream.javadsl.Flow<Message,Message,T> handler,
 String subprotocol)

handleWebSocketMessagesForOptionalProtocol

public static <T> Route handleWebSocketMessagesForOptionalProtocol(akka.stream.javadsl.Flow<Message,Message,T> handler,
 Optional<String> subprotocol)

extractRequestTimeout

public static RouteAdapter extractRequestTimeout(Function<scala.concurrent.duration.Duration,Route> inner)

withRequestTimeout

public static RouteAdapter withRequestTimeout(scala.concurrent.duration.Duration timeout,
 Supplier<Route> inner)

withRequestTimeout

public static RouteAdapter withRequestTimeout(scala.concurrent.duration.Duration timeout,
 Function<HttpRequest,HttpResponse> timeoutHandler,
 Supplier<Route> inner)

withoutRequestTimeout

public static RouteAdapter withoutRequestTimeout(Supplier<Route> inner)

withRequestTimeoutResponse

public static RouteAdapter withRequestTimeoutResponse(Function<HttpRequest,HttpResponse> timeoutHandler,
 Supplier<Route> inner)

entityAsSourceOf

public static <T> Route entityAsSourceOf(Unmarshaller<akka.util.ByteString,T> um,
 EntityStreamingSupport support,
 Function<akka.stream.javadsl.Source<T,akka.NotUsed>,Route> inner)

completeWithSource

public static <T,
M> Route completeWithSource(akka.stream.javadsl.Source<T,M> source,
 Marshaller<T,akka.util.ByteString> m,
 EntityStreamingSupport support)

completeOKWithSource

public static <T,
M> Route completeOKWithSource(akka.stream.javadsl.Source<T,M> source,
 Marshaller<T,RequestEntity> m,
 EntityStreamingSupport support)