Package org.apache.pekko.http.scaladsl.server

Interface Directives

All Superinterfaces:

AttributeDirectives, BasicDirectives, CacheConditionDirectives, CodingDirectives, CookieDirectives, DebuggingDirectives, ExecutionDirectives, FileAndResourceDirectives, FileUploadDirectives, FormFieldDirectives, FormFieldDirectivesInstances, FramedEntityStreamingDirectives, FutureDirectives, HeaderDirectives, HostDirectives, ImplicitPathMatcherConstruction, MarshallingDirectives, MethodDirectives, MiscDirectives, ParameterDirectives, ParameterDirectivesInstances, PathDirectives, PathMatchers, RangeDirectives, RespondWithDirectives, RouteConcatenation, RouteDirectives, SchemeDirectives, SecurityDirectives, TimeoutDirectives, ToNameReceptacleEnhancements, WebSocketDirectives

All Known Implementing Classes:

Directives$, HttpApp

public interface Directives
extends RouteConcatenation, BasicDirectives, CacheConditionDirectives, CookieDirectives, DebuggingDirectives, CodingDirectives, ExecutionDirectives, FileAndResourceDirectives, FileUploadDirectives, FormFieldDirectives, FutureDirectives, HeaderDirectives, HostDirectives, MarshallingDirectives, MethodDirectives, MiscDirectives, ParameterDirectives, TimeoutDirectives, PathDirectives, RangeDirectives, RespondWithDirectives, RouteDirectives, SchemeDirectives, SecurityDirectives, WebSocketDirectives, FramedEntityStreamingDirectives, AttributeDirectives

Collects all default directives into one trait for simple importing.

See pekko.http.javadsl.server.AllDirectives for JavaDSL equivalent of this trait.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.pekko.http.scaladsl.server.directives.FileAndResourceDirectives

FileAndResourceDirectives.DirectoryRenderer, FileAndResourceDirectives.DirectoryRenderer$, FileAndResourceDirectives.LowLevelDirectoryRenderer, FileAndResourceDirectives.ResourceFile, FileAndResourceDirectives.ResourceFile$

Nested classes/interfaces inherited from interface org.apache.pekko.http.scaladsl.server.directives.FormFieldDirectives

FormFieldDirectives.FieldSpec, FormFieldDirectives.FieldSpec$, FormFieldDirectives.Impl$

Nested classes/interfaces inherited from interface org.apache.pekko.http.scaladsl.server.directives.ParameterDirectives

ParameterDirectives.ParamSpec, ParameterDirectives.ParamSpec$

Nested classes/interfaces inherited from interface org.apache.pekko.http.scaladsl.server.directives.PathDirectives

PathDirectives.TrailingRetryRejection$

Nested classes/interfaces inherited from interface org.apache.pekko.http.scaladsl.server.PathMatchers

PathMatchers.HexIntNumber$, PathMatchers.HexLongNumber$, PathMatchers.IntNumber$, PathMatchers.LongNumber$, PathMatchers.NumberMatcher<T>, PathMatchers.PathEnd$, PathMatchers.Remaining$, PathMatchers.RemainingPath$, PathMatchers.Segment$, PathMatchers.Slash$

Nested classes/interfaces inherited from interface org.apache.pekko.http.scaladsl.server.RouteConcatenation

RouteConcatenation.RouteWithConcatenation

Method Summary

Methods inherited from interface org.apache.pekko.http.scaladsl.server.directives.AttributeDirectives

attribute, optionalAttribute

Methods inherited from interface org.apache.pekko.http.scaladsl.server.directives.BasicDirectives

cancelRejection, cancelRejections, cancelRejections, extract, extractActorSystem, extractDataBytes, 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, textract, toStrictEntity, toStrictEntity, tprovide, withExecutionContext, withLog, withMaterializer, withSettings

Methods inherited from interface org.apache.pekko.http.scaladsl.server.directives.CacheConditionDirectives

conditional, conditional, conditional, conditional

Methods inherited from interface org.apache.pekko.http.scaladsl.server.directives.CodingDirectives

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

Methods inherited from interface org.apache.pekko.http.scaladsl.server.directives.CookieDirectives

cookie, deleteCookie, deleteCookie, findCookie, optionalCookie, setCookie

Methods inherited from interface org.apache.pekko.http.scaladsl.server.directives.DebuggingDirectives

logRequest, logRequestResult, logResult

Methods inherited from interface org.apache.pekko.http.scaladsl.server.directives.ExecutionDirectives

handleExceptions, handleRejections

Methods inherited from interface org.apache.pekko.http.scaladsl.server.directives.FileAndResourceDirectives

_defaultClassLoader, conditionalFor, getFromBrowseableDirectories, getFromBrowseableDirectory, getFromDirectory, getFromFile, getFromFile, getFromFile, getFromResource, getFromResource, getFromResourceDirectory, listDirectoryContents

Methods inherited from interface org.apache.pekko.http.scaladsl.server.directives.FileUploadDirectives

fileUpload, fileUploadAll, storeUploadedFile, storeUploadedFiles

Methods inherited from interface org.apache.pekko.http.scaladsl.server.directives.FormFieldDirectives

formFieldMap, formFieldMultiMap, formFieldSeq

Methods inherited from interface org.apache.pekko.http.scaladsl.server.directives.FormFieldDirectivesInstances

formField, formField, formField, formField, formField, formField, formField, formField, formField, formField, formField, formField, formField, formField, formField, formField, formField, formField, formField, formField, formField, formField, formFields, formFields, formFields, formFields, formFields, formFields, formFields, formFields, formFields, formFields, formFields, formFields, formFields, formFields, formFields, formFields, formFields, formFields, formFields, formFields, formFields, formFields

Methods inherited from interface org.apache.pekko.http.scaladsl.server.directives.FramedEntityStreamingDirectives

asSourceOf, asSourceOf, asSourceOfInternal

Methods inherited from interface org.apache.pekko.http.scaladsl.server.directives.FutureDirectives

completeOrRecoverWith, onComplete, onCompleteWithBreaker, onSuccess

Methods inherited from interface org.apache.pekko.http.scaladsl.server.directives.HeaderDirectives

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

Methods inherited from interface org.apache.pekko.http.scaladsl.server.directives.HostDirectives

extractHost, host, host, host

Methods inherited from interface org.apache.pekko.http.scaladsl.server.ImplicitPathMatcherConstruction

_regex2PathMatcher, _segmentStringToPathMatcher, _stringExtractionPair2PathMatcher, _stringNameOptionReceptacle2PathMatcher, _valueMap2PathMatcher

Methods inherited from interface org.apache.pekko.http.scaladsl.server.directives.MarshallingDirectives

as, completeWith, entity, handleWith, instanceOf

Methods inherited from interface org.apache.pekko.http.scaladsl.server.directives.MethodDirectives

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

Methods inherited from interface org.apache.pekko.http.scaladsl.server.directives.MiscDirectives

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

Methods inherited from interface org.apache.pekko.http.scaladsl.server.directives.ParameterDirectives

parameterMap, parameterMultiMap, parameterSeq

Methods inherited from interface org.apache.pekko.http.scaladsl.server.directives.ParameterDirectivesInstances

parameter, parameter, parameter, parameter, parameter, parameter, parameter, parameter, parameter, parameter, parameter, parameter, parameter, parameter, parameter, parameter, parameter, parameter, parameter, parameter, parameter, parameter, parameters, parameters, parameters, parameters, parameters, parameters, parameters, parameters, parameters, parameters, parameters, parameters, parameters, parameters, parameters, parameters, parameters, parameters, parameters, parameters, parameters, parameters

Methods inherited from interface org.apache.pekko.http.scaladsl.server.directives.PathDirectives

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

Methods inherited from interface org.apache.pekko.http.scaladsl.server.PathMatchers

DoubleNumber, HexIntNumber, HexLongNumber, IntNumber, JavaUUID, LongNumber, Neutral, not, nothingMatcher, PathEnd, Remaining, RemainingPath, Segment, Segments, Segments, Segments, separateOnSlashes, Slash

Methods inherited from interface org.apache.pekko.http.scaladsl.server.directives.RangeDirectives

withRangeSupport

Methods inherited from interface org.apache.pekko.http.scaladsl.server.directives.RespondWithDirectives

respondWithDefaultHeader, respondWithDefaultHeaders, respondWithDefaultHeaders, respondWithHeader, respondWithHeaders, respondWithHeaders

Methods inherited from interface org.apache.pekko.http.scaladsl.server.RouteConcatenation

_enhanceRouteWithConcatenation, concat

Methods inherited from interface org.apache.pekko.http.scaladsl.server.directives.RouteDirectives

complete, complete, complete, failWith, handle, handle, handle, handleSync, handleSync, handleSync, redirect, reject, reject

Methods inherited from interface org.apache.pekko.http.scaladsl.server.directives.SchemeDirectives

extractScheme, scheme

Methods inherited from interface org.apache.pekko.http.scaladsl.server.directives.SecurityDirectives

authenticateBasic, authenticateBasicAsync, authenticateBasicPF, authenticateBasicPFAsync, authenticateOAuth2, authenticateOAuth2Async, authenticateOAuth2PF, authenticateOAuth2PFAsync, authenticateOrRejectWithChallenge, authenticateOrRejectWithChallenge, authorize, authorize, authorizeAsync, authorizeAsync, extractCredentials, extractCredentialsAndAuthenticateOrRejectWithChallenge

Methods inherited from interface org.apache.pekko.http.scaladsl.server.directives.TimeoutDirectives

extractRequestTimeout, withoutRequestTimeout, withRequestTimeout, withRequestTimeout, withRequestTimeout, withRequestTimeoutResponse

Methods inherited from interface org.apache.pekko.http.scaladsl.common.ToNameReceptacleEnhancements

_string2NR, _symbol2NR

Methods inherited from interface org.apache.pekko.http.scaladsl.server.directives.WebSocketDirectives

extractOfferedWsProtocols, extractWebSocketUpgrade, handleWebSocketMessages, handleWebSocketMessagesForOptionalProtocol, handleWebSocketMessagesForProtocol