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

Class WebSocketDirectives

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

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

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

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

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

Direct Known Subclasses:

TimeoutDirectives

public abstract class WebSocketDirectives
extends SecurityDirectives

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.pekko.http.javadsl.server.directives.SecurityDirectives

SecurityDirectives.ProvidedCredentials, SecurityDirectives.ProvidedCredentials$

Constructor Summary

Constructors

Constructor	Description
WebSocketDirectives()

Method Summary

Modifier and Type	Method	Description
Route	extractOfferedWsProtocols(Function<List<String>,Route> inner)	Extract the list of WebSocket subprotocols as offered by the client in the Sec-WebSocket-Protocol header if this is a WebSocket request.
Route	extractWebSocketUpgrade(Function<WebSocketUpgrade,Route> inner)	Extract the WebSocketUpgrade attribute if this is a WebSocket request.
<T> Route	handleWebSocketMessages(org.apache.pekko.stream.javadsl.Flow<Message,Message,T> handler)	Handles WebSocket requests with the given handler and rejects other requests with an ExpectedWebSocketRequestRejection.
<T> Route	handleWebSocketMessages(org.apache.pekko.stream.javadsl.Flow<Message,Message,T> handler, Predicate<Message> shouldCompress)	Handles WebSocket requests with the given handler and selectively compresses outbound messages for which shouldCompress returns true when permessage-deflate was negotiated.
<T> Route	handleWebSocketMessagesForOptionalProtocol(org.apache.pekko.stream.javadsl.Flow<Message,Message,T> handler, Optional<String> subprotocol)	Handles WebSocket requests with the given handler and rejects other requests with an ExpectedWebSocketRequestRejection.
<T> Route	handleWebSocketMessagesForOptionalProtocol(org.apache.pekko.stream.javadsl.Flow<Message,Message,T> handler, Optional<String> subprotocol, Predicate<Message> shouldCompress)	Handles WebSocket requests with the given handler and selectively compresses outbound messages for which shouldCompress returns true when permessage-deflate was negotiated.
<T> Route	handleWebSocketMessagesForProtocol(org.apache.pekko.stream.javadsl.Flow<Message,Message,T> handler, String subprotocol)	Handles WebSocket requests with the given handler if the given subprotocol is offered in the request and rejects other requests with an ExpectedWebSocketRequestRejection or an UnsupportedWebSocketSubprotocolRejection.
<T> Route	handleWebSocketMessagesForProtocol(org.apache.pekko.stream.javadsl.Flow<Message,Message,T> handler, String subprotocol, Predicate<Message> shouldCompress)	Handles WebSocket requests with the given handler if the given subprotocol is offered and selectively compresses outbound messages for which shouldCompress returns true when permessage-deflate was negotiated.

Methods inherited from class org.apache.pekko.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 org.apache.pekko.http.javadsl.server.directives.SchemeDirectives

extractScheme, scheme

Methods inherited from class org.apache.pekko.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

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

respondWithDefaultHeader, respondWithDefaultHeaders, respondWithHeader, respondWithHeaders

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, query

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

WebSocketDirectives

public WebSocketDirectives()

Method Details

extractOfferedWsProtocols

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

Extract the list of WebSocket subprotocols as offered by the client in the Sec-WebSocket-Protocol header if this is a WebSocket request. Rejects with an ExpectedWebSocketRequestRejection, otherwise.

Parameters:

inner - (undocumented)

Returns:

(undocumented)

extractWebSocketUpgrade

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

Extract the WebSocketUpgrade attribute if this is a WebSocket request. Rejects with an ExpectedWebSocketRequestRejection, otherwise.

Parameters:

inner - (undocumented)

Returns:

(undocumented)

handleWebSocketMessages

public <T> Route handleWebSocketMessages(org.apache.pekko.stream.javadsl.Flow<Message,Message,T> handler)

Handles WebSocket requests with the given handler and rejects other requests with an ExpectedWebSocketRequestRejection.

Parameters:

handler - (undocumented)

Returns:

(undocumented)

handleWebSocketMessages

public <T> Route handleWebSocketMessages(org.apache.pekko.stream.javadsl.Flow<Message,Message,T> handler,
 Predicate<Message> shouldCompress)

Handles WebSocket requests with the given handler and selectively compresses outbound messages for which shouldCompress returns true when permessage-deflate was negotiated.

Parameters:

handler - (undocumented)

shouldCompress - (undocumented)

Returns:

(undocumented)

Since:

2.0.0

handleWebSocketMessagesForOptionalProtocol

public <T> Route handleWebSocketMessagesForOptionalProtocol(org.apache.pekko.stream.javadsl.Flow<Message,Message,T> handler,
 Optional<String> subprotocol)

Handles WebSocket requests with the given handler and rejects other requests with an ExpectedWebSocketRequestRejection.

If the subprotocol parameter is None any WebSocket request is accepted. If the subprotocol parameter is Some(protocol) a WebSocket request is only accepted if the list of subprotocols supported by the client (as announced in the WebSocket request) contains protocol. If the client did not offer the protocol in question the request is rejected with an UnsupportedWebSocketSubprotocolRejection rejection.

To support several subprotocols you may chain several handleWebSocketMessagesForOptionalProtocol routes.

Parameters:

handler - (undocumented)

subprotocol - (undocumented)

Returns:

(undocumented)

handleWebSocketMessagesForOptionalProtocol

public <T> Route handleWebSocketMessagesForOptionalProtocol(org.apache.pekko.stream.javadsl.Flow<Message,Message,T> handler,
 Optional<String> subprotocol,
 Predicate<Message> shouldCompress)

Handles WebSocket requests with the given handler and selectively compresses outbound messages for which shouldCompress returns true when permessage-deflate was negotiated.

Parameters:

handler - (undocumented)

subprotocol - (undocumented)

shouldCompress - (undocumented)

Returns:

(undocumented)

Since:

2.0.0

handleWebSocketMessagesForProtocol

public <T> Route handleWebSocketMessagesForProtocol(org.apache.pekko.stream.javadsl.Flow<Message,Message,T> handler,
 String subprotocol)

Handles WebSocket requests with the given handler if the given subprotocol is offered in the request and rejects other requests with an ExpectedWebSocketRequestRejection or an UnsupportedWebSocketSubprotocolRejection.

Parameters:

handler - (undocumented)

subprotocol - (undocumented)

Returns:

(undocumented)

handleWebSocketMessagesForProtocol

public <T> Route handleWebSocketMessagesForProtocol(org.apache.pekko.stream.javadsl.Flow<Message,Message,T> handler,
 String subprotocol,
 Predicate<Message> shouldCompress)

Handles WebSocket requests with the given handler if the given subprotocol is offered and selectively compresses outbound messages for which shouldCompress returns true when permessage-deflate was negotiated.

Parameters:

handler - (undocumented)

subprotocol - (undocumented)

shouldCompress - (undocumented)

Returns:

(undocumented)

Since:

2.0.0