Package akka.http.javadsl.testkit

Class RouteTest

java.lang.Object

akka.http.javadsl.server.directives.BasicDirectives

akka.http.javadsl.server.directives.CacheConditionDirectives

akka.http.javadsl.server.directives.CodingDirectives

akka.http.javadsl.server.directives.CookieDirectives

akka.http.javadsl.server.directives.DebuggingDirectives

akka.http.javadsl.server.directives.ExecutionDirectives

akka.http.javadsl.server.directives.FileAndResourceDirectives

akka.http.javadsl.server.directives.FileUploadDirectives

akka.http.javadsl.server.directives.FormFieldDirectives

akka.http.javadsl.server.directives.FutureDirectives

akka.http.javadsl.server.directives.HeaderDirectives

akka.http.javadsl.server.directives.AttributeDirectives

akka.http.javadsl.server.directives.HostDirectives

akka.http.javadsl.server.directives.MarshallingDirectives

akka.http.javadsl.server.directives.MethodDirectives

akka.http.javadsl.server.directives.MiscDirectives

akka.http.javadsl.server.directives.ParameterDirectives

akka.http.javadsl.server.directives.PathDirectives

akka.http.javadsl.server.directives.RangeDirectives

akka.http.javadsl.server.directives.RespondWithDirectives

akka.http.javadsl.server.directives.RouteDirectives

akka.http.javadsl.server.directives.SchemeDirectives

akka.http.javadsl.server.directives.SecurityDirectives

akka.http.javadsl.server.directives.WebSocketDirectives

akka.http.javadsl.server.directives.TimeoutDirectives

akka.http.javadsl.server.directives.FramedEntityStreamingDirectives

akka.http.javadsl.server.directives.CorsDirectives

akka.http.javadsl.server.directives.TlsDirectives

akka.http.javadsl.server.AllDirectives

akka.http.javadsl.testkit.RouteTest

All Implemented Interfaces:

WSTestRequestBuilding

Direct Known Subclasses:

JUnitRouteTestBase

public abstract class RouteTest
extends AllDirectives
implements WSTestRequestBuilding

A base class to create route tests for testing libraries. An implementation needs to provide code to provide and shutdown an ActorSystem, Materializer, and ExecutionContextExecutor.

See JUnitRouteTest for an example of a concrete implementation.

Nested Class Summary

Nested classes/interfaces inherited from class akka.http.javadsl.server.directives.SecurityDirectives

SecurityDirectives.ProvidedCredentials, SecurityDirectives.ProvidedCredentials$

Constructor Summary

Constructors

Constructor	Description
RouteTest()

Method Summary

Modifier and Type	Method	Description
protected scala.concurrent.duration.FiniteDuration	awaitDuration()
protected TestRouteResult	createTestRouteResult(HttpRequest request, RouteResult result)
protected abstract TestRouteResult	createTestRouteResultAsync(HttpRequest request, scala.concurrent.Future<RouteResult> result)
protected scala.concurrent.duration.FiniteDuration	defaultAwaitDuration()
protected DefaultHostInfo	defaultHostInfo()
scala.concurrent.ExecutionContextExecutor	executionContext()
abstract akka.stream.Materializer	materializer()
TestRouteResult	runRoute(Route route, HttpRequest request)
TestRouteResult	runRoute(Route route, HttpRequest request, DefaultHostInfo defaultHostInfo)
TestRouteResult	runRouteClientServer(Route route, HttpRequest request)
TestRouteResult	runRouteUnSealed(Route route, HttpRequest request)
TestRouteResult	runRouteUnSealed(Route route, HttpRequest request, DefaultHostInfo defaultHostInfo)
abstract akka.actor.ActorSystem	system()
TestRoute	testRoute(Route first, Route... others)	Wraps a list of route alternatives with testing support.
TestRoute	testRoute(Route first, scala.collection.immutable.Seq<Route> others)	Wraps a list of route alternatives with testing support.

Methods inherited from class akka.http.javadsl.server.directives.TlsDirectives

extractClientCertificate, extractSslSession, requireClientCertificateIdentity

Methods inherited from class akka.http.javadsl.server.directives.CorsDirectives

cors, cors

Methods inherited from class akka.http.javadsl.server.directives.FramedEntityStreamingDirectives

attribute, authenticateBasic, authenticateBasicAsync, authenticateBasicAsyncOptional, authenticateBasicOptional, authenticateBasicPF, authenticateBasicPFAsync, authenticateOAuth2, authenticateOAuth2Async, authenticateOAuth2AsyncOptional, authenticateOAuth2Optional, authenticateOrRejectWithChallenge, authenticateOrRejectWithChallenge, authorize, authorizeAsync, authorizeAsyncWithRequestContext, authorizeWithRequestContext, cancelRejection, cancelRejections, cancelRejections, checkSameOrigin, complete, complete, complete, complete, complete, complete, complete, complete, complete, complete, complete, complete, complete, complete, complete, complete, completeOK, completeOKWithFuture, completeOKWithFuture, completeOKWithFuture, completeOKWithFutureString, completeOKWithFutureString, completeOKWithSource, completeOrRecoverWith, completeWith, completeWithFuture, completeWithFuture, completeWithFuture, completeWithFutureResponse, completeWithFutureStatus, completeWithFutureStatus, completeWithSource, concat, concat, conditional, conditional, conditional, conditional, cookie, decodeRequest, decodeRequestWith, decodeRequestWith, defaultContentTypeResolver, defaultDirectoryRenderer, delete, deleteCookie, deleteCookie, deleteCookie, deleteCookie, deleteCookie, encodeResponse, encodeResponseWith, entity, entityAsSourceOf, extract, extractActorSystem, extractClientIP, extractCredentials, extractDataBytes, extractEntity, extractExecutionContext, extractHost, extractLog, extractMatchedPath, extractMaterializer, extractMethod, extractOfferedWsProtocols, extractParserSettings, extractRequest, extractRequestContext, extractRequestEntity, extractRequestTimeout, extractScheme, extractSettings, extractStrictEntity, extractStrictEntity, extractUnmatchedPath, extractUpgradeToWebSocket, extractUri, extractWebSocketUpgrade, failWith, fileUpload, fileUploadAll, formField, formField, formFieldList, formFieldList, formFieldList, formFieldMap, formFieldMultiMap, formFieldOptional, formFieldOptional, get, getFromBrowseableDirectories, getFromBrowseableDirectories, getFromBrowseableDirectories, getFromBrowseableDirectories, getFromBrowseableDirectories, getFromBrowseableDirectory, getFromBrowseableDirectory, getFromBrowseableDirectory, getFromBrowseableDirectory, getFromDirectory, getFromDirectory, getFromFile, getFromFile, getFromFile, getFromFile, getFromFile, getFromResource, getFromResource, getFromResource, getFromResource, getFromResourceDirectory, getFromResourceDirectory, getFromResourceDirectory, getFromResourceDirectory, handle, handleExceptions, handleRejections, handleSync, handleWebSocketMessages, handleWebSocketMessagesForOptionalProtocol, handleWebSocketMessagesForProtocol, handleWith, head, headerValue, headerValueByName, headerValueByType, headerValuePF, host, host, host, host, ignoreTrailingSlash, listDirectoryContents, listDirectoryContents, listDirectoryContents, listDirectoryContents, logRequest, logRequest, logRequest, logRequestResult, logRequestResultOptional, logResult, logResult, logResult, mapInnerRoute, mapRejections, mapRequest, mapRequestContext, mapResponse, mapResponseEntity, mapResponseHeaders, mapRouteResult, mapRouteResultFuture, mapRouteResultPF, mapRouteResultWith, mapRouteResultWithPF, mapSettings, mapUnmatchedPath, method, onComplete, onComplete, onCompleteWithBreaker, onSuccess, onSuccess, optionalAttribute, optionalCookie, optionalHeaderValue, optionalHeaderValueByName, optionalHeaderValueByType, optionalHeaderValuePF, options, overrideMethodWithParameter, parameter, parameter, parameterList, parameterList, parameterList, parameterMap, parameterMultiMap, parameterOptional, parameterOptional, parameterOrDefault, parameterRequiredValue, pass, patch, 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, post, provide, put, rawPathPrefix, rawPathPrefix, rawPathPrefix, rawPathPrefix, rawPathPrefixTest, rawPathPrefixTest, rawPathPrefixTest, rawPathPrefixTest, recoverRejections, recoverRejectionsWith, redirect, redirectToNoTrailingSlashIfPresent, redirectToTrailingSlashIfMissing, reject, reject, reject, rejectEmptyResponse, request, requestEncodedWith, requestEntityEmpty, requestEntityPresent, respondWithDefaultHeader, respondWithDefaultHeaders, respondWithHeader, respondWithHeaders, responseEncodingAccepted, route, route, scheme, selectPreferredLanguage, setCookie, setCookie, storeUploadedFile, storeUploadedFiles, toStrictEntity, toStrictEntity, validate, withExecutionContext, withLog, withMaterializer, withoutRequestTimeout, withoutSizeLimit, withPrecompressedMediaTypeSupport, withRangeSupport, withRequestTimeout, withRequestTimeout, withRequestTimeoutResponse, withSettings, withSizeLimit

Methods inherited from class akka.http.javadsl.server.directives.TimeoutDirectives

extractRequestTimeout, withoutRequestTimeout, withRequestTimeout, withRequestTimeout, withRequestTimeoutResponse

Methods inherited from class akka.http.javadsl.server.directives.WebSocketDirectives

extractOfferedWsProtocols, extractUpgradeToWebSocket, extractWebSocketUpgrade, handleWebSocketMessages, handleWebSocketMessagesForOptionalProtocol, handleWebSocketMessagesForProtocol

Methods inherited from class akka.http.javadsl.server.directives.SecurityDirectives

authenticateBasic, authenticateBasicAsync, authenticateBasicAsyncOptional, authenticateBasicOptional, authenticateBasicPF, authenticateBasicPFAsync, authenticateOAuth2, authenticateOAuth2Async, authenticateOAuth2AsyncOptional, authenticateOAuth2Optional, authenticateOrRejectWithChallenge, authenticateOrRejectWithChallenge, authorize, authorizeAsync, authorizeAsyncWithRequestContext, authorizeWithRequestContext, extractCredentials

Methods inherited from class akka.http.javadsl.server.directives.SchemeDirectives

extractScheme, scheme

Methods inherited from class akka.http.javadsl.server.directives.RouteDirectives

complete, complete, complete, complete, complete, complete, complete, complete, complete, complete, complete, complete, complete, complete, complete, complete, completeOK, completeOKWithFuture, completeOKWithFuture, completeOKWithFuture, completeOKWithFutureString, completeOKWithFutureString, completeWithFuture, completeWithFuture, completeWithFuture, completeWithFutureResponse, completeWithFutureStatus, completeWithFutureStatus, concat, concat, failWith, handle, handleSync, redirect, reject, reject, reject, route, route

Methods inherited from class akka.http.javadsl.server.directives.RespondWithDirectives

respondWithDefaultHeader, respondWithDefaultHeaders, respondWithHeader, respondWithHeaders

Methods inherited from class akka.http.javadsl.server.directives.RangeDirectives

withRangeSupport

Methods inherited from class akka.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 akka.http.javadsl.server.directives.ParameterDirectives

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

Methods inherited from class akka.http.javadsl.server.directives.MiscDirectives

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

Methods inherited from class akka.http.javadsl.server.directives.MethodDirectives

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

Methods inherited from class akka.http.javadsl.server.directives.MarshallingDirectives

completeWith, entity, handleWith, request

Methods inherited from class akka.http.javadsl.server.directives.HostDirectives

extractHost, host, host, host, host

Methods inherited from class akka.http.javadsl.server.directives.AttributeDirectives

attribute, optionalAttribute

Methods inherited from class akka.http.javadsl.server.directives.HeaderDirectives

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

Methods inherited from class akka.http.javadsl.server.directives.FutureDirectives

completeOrRecoverWith, onComplete, onComplete, onCompleteWithBreaker, onSuccess, onSuccess

Methods inherited from class akka.http.javadsl.server.directives.FormFieldDirectives

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

Methods inherited from class akka.http.javadsl.server.directives.FileUploadDirectives

fileUpload, fileUploadAll, storeUploadedFile, storeUploadedFiles

Methods inherited from class akka.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 akka.http.javadsl.server.directives.ExecutionDirectives

handleExceptions, handleRejections

Methods inherited from class akka.http.javadsl.server.directives.DebuggingDirectives

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

Methods inherited from class akka.http.javadsl.server.directives.CookieDirectives

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

Methods inherited from class akka.http.javadsl.server.directives.CodingDirectives

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

Methods inherited from class akka.http.javadsl.server.directives.CacheConditionDirectives

conditional, conditional, conditional, conditional

Methods inherited from class akka.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

Methods inherited from interface akka.http.javadsl.testkit.WSTestRequestBuilding

WS, WS

Constructor Detail

RouteTest

public RouteTest()

Method Detail

awaitDuration

protected scala.concurrent.duration.FiniteDuration awaitDuration()

createTestRouteResult

protected TestRouteResult createTestRouteResult(HttpRequest request,
                                                RouteResult result)

createTestRouteResultAsync

protected abstract TestRouteResult createTestRouteResultAsync(HttpRequest request,
                                                              scala.concurrent.Future<RouteResult> result)

defaultAwaitDuration

protected scala.concurrent.duration.FiniteDuration defaultAwaitDuration()

defaultHostInfo

protected DefaultHostInfo defaultHostInfo()

executionContext

public scala.concurrent.ExecutionContextExecutor executionContext()

materializer

public abstract akka.stream.Materializer materializer()

runRoute

public TestRouteResult runRoute(Route route,
                                HttpRequest request)

runRoute

public TestRouteResult runRoute(Route route,
                                HttpRequest request,
                                DefaultHostInfo defaultHostInfo)

runRouteClientServer

public TestRouteResult runRouteClientServer(Route route,
                                            HttpRequest request)

runRouteUnSealed

public TestRouteResult runRouteUnSealed(Route route,
                                        HttpRequest request)

runRouteUnSealed

public TestRouteResult runRouteUnSealed(Route route,
                                        HttpRequest request,
                                        DefaultHostInfo defaultHostInfo)

system

public abstract akka.actor.ActorSystem system()

testRoute

public TestRoute testRoute(Route first,
                           Route... others)

Wraps a list of route alternatives with testing support.

Parameters:

first - (undocumented)

others - (undocumented)

Returns:

(undocumented)

testRoute

public TestRoute testRoute(Route first,
                           scala.collection.immutable.Seq<Route> others)

Wraps a list of route alternatives with testing support.

Parameters:

first - (undocumented)

others - (undocumented)

Returns:

(undocumented)