Package de.craftsblock.craftsnet.api.requirements.websocket

Class WSDomainRequirement

java.lang.Object

de.craftsblock.craftsnet.api.requirements.Requirement<T,RouteRegistry.EndpointMapping>

de.craftsblock.craftsnet.api.requirements.websocket.WebSocketRequirement<WebSocketClient>

de.craftsblock.craftsnet.api.requirements.websocket.WSDomainRequirement

public class WSDomainRequirement
extends WebSocketRequirement<WebSocketClient>

A specific websocket requirement that checks if the domain of a websocket connection matches certain criteria.

Since:

3.0.5-SNAPSHOT

See Also:

• WebRequirement

Constructor Summary

Constructors

Constructor	Description
WSDomainRequirement()	Constructs a new websocket domain requirement.

Method Summary

Modifier and Type	Method	Description
boolean	applies(WebSocketClient client, RouteRegistry.EndpointMapping endpointMapping)	Checks if the requirement applies given the specified websocket client and socket mapping.

Methods inherited from class de.craftsblock.craftsnet.api.requirements.Requirement

getAnnotation

Methods inherited from class java.lang.Object

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

Constructor Details

WSDomainRequirement

public WSDomainRequirement()

Constructs a new websocket domain requirement.

Method Details

applies

public boolean applies(WebSocketClient client,
 RouteRegistry.EndpointMapping endpointMapping)

Checks if the requirement applies given the specified websocket client and socket mapping.

Specified by:

applies in class Requirement<WebSocketClient,RouteRegistry.EndpointMapping>

Parameters:

client - the websocket client

endpointMapping - the socket mapping

Returns:

true if the requirement applies, false otherwise