Package io.quarkus.websockets.next.runtime

Class SecurityHttpUpgradeCheck

java.lang.Object

io.quarkus.websockets.next.runtime.SecurityHttpUpgradeCheck

All Implemented Interfaces:

HttpUpgradeCheck

public final class SecurityHttpUpgradeCheck
extends Object
implements HttpUpgradeCheck

Nested Class Summary

Nested classes/interfaces inherited from interface io.quarkus.websockets.next.HttpUpgradeCheck

HttpUpgradeCheck.CheckResult, HttpUpgradeCheck.HttpUpgradeContext

Field Summary

Fields

Modifier and Type	Field	Description
static final int	BEAN_PRIORITY
static final String	HTTP_REQUEST_KEY
static final String	SECURED_ENDPOINT_ID_KEY

Constructor Summary

Constructors

Constructor	Description
SecurityHttpUpgradeCheck(String redirectUrl, Map<String,io.quarkus.security.spi.runtime.SecurityCheck> endpointToCheck, io.quarkus.security.spi.runtime.SecurityEventHelper<io.quarkus.security.spi.runtime.AuthorizationSuccessEvent,io.quarkus.security.spi.runtime.AuthorizationFailureEvent> securityEventHelper)

Method Summary

Modifier and Type	Method	Description
boolean	appliesTo(String endpointId)	Determines WebSocket endpoints this check is applied to.
io.smallrye.mutiny.Uni<HttpUpgradeCheck.CheckResult>	perform(HttpUpgradeCheck.HttpUpgradeContext context)	This method inspects HTTP Upgrade context and either allows or denies upgrade to a WebSocket connection.

Methods inherited from class java.lang.Object

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

Field Details

BEAN_PRIORITY

public static final int BEAN_PRIORITY

See Also:

• Constant Field Values

SECURED_ENDPOINT_ID_KEY

public static final String SECURED_ENDPOINT_ID_KEY

HTTP_REQUEST_KEY

public static final String HTTP_REQUEST_KEY

Constructor Details

SecurityHttpUpgradeCheck

SecurityHttpUpgradeCheck(String redirectUrl,
 Map<String,io.quarkus.security.spi.runtime.SecurityCheck> endpointToCheck,
 io.quarkus.security.spi.runtime.SecurityEventHelper<io.quarkus.security.spi.runtime.AuthorizationSuccessEvent,io.quarkus.security.spi.runtime.AuthorizationFailureEvent> securityEventHelper)

Method Details

perform

public io.smallrye.mutiny.Uni<HttpUpgradeCheck.CheckResult> perform(HttpUpgradeCheck.HttpUpgradeContext context)

Description copied from interface: HttpUpgradeCheck

This method inspects HTTP Upgrade context and either allows or denies upgrade to a WebSocket connection.

Use VertxContextSupport.executeBlocking(java.util.concurrent.Callable) in order to execute some blocking code in the check.

Specified by:

perform in interface HttpUpgradeCheck

Parameters:

context - HttpUpgradeCheck.HttpUpgradeContext

Returns:

check result; must never be null

appliesTo

public boolean appliesTo(String endpointId)

Description copied from interface: HttpUpgradeCheck

Determines WebSocket endpoints this check is applied to.

Specified by:

appliesTo in interface HttpUpgradeCheck

Parameters:

endpointId - WebSocket endpoint id, @see WebSocket.endpointId() for more information

Returns:

true if this check should be applied on a WebSocket endpoint with given id