Jetty 12.0.6 · org.eclipse.jetty.ee10.websocket.jakarta.common.JakartaWebSocketFrameHandlerMetadata

Modifier and Type	Field and Description
private final AvailableDecoders	availableDecoders
private final AvailableEncoders	availableEncoders
private JakartaWebSocketMessageMetadata	binaryMetadata
private MethodHandle	closeHandle
private MethodHandle	errorHandle
private static final String[]	NO_VARIABLES
private MethodHandle	openHandle
private MethodHandle	pongHandle
private JakartaWebSocketMessageMetadata	textMetadata
private UriTemplatePathSpec	uriTemplatePathSpec For `@ServerEndpoint` or `ServerEndpointConfig` based endpoints, this holds the `UriTemplatePathSpec` based off of the configured url-pattern.

Modifier and Type

Field and Description

private final AvailableDecoders

availableDecoders

private final AvailableEncoders

availableEncoders

private JakartaWebSocketMessageMetadata

binaryMetadata

private MethodHandle

closeHandle

private MethodHandle

errorHandle

private static final String[]

NO_VARIABLES

private MethodHandle

openHandle

private MethodHandle

pongHandle

private JakartaWebSocketMessageMetadata

textMetadata

private UriTemplatePathSpec

uriTemplatePathSpec

For @ServerEndpoint or ServerEndpointConfig based endpoints, this holds the UriTemplatePathSpec based off of the configured url-pattern.

Access	Constructor and Description
public	JakartaWebSocketFrameHandlerMetadata(EndpointConfig endpointConfig, WebSocketComponents components)

Access

Constructor and Description

public

JakartaWebSocketFrameHandlerMetadata(EndpointConfig endpointConfig, WebSocketComponents components)

Modifier and Type	Method and Description
private void	assertNotSet(Object val, String role, Object origin)
private String	describeOrigin(Object obj)
public AvailableDecoders	getAvailableDecoders()
public AvailableEncoders	getAvailableEncoders()
public JakartaWebSocketMessageMetadata	getBinaryMetadata()
public MethodHandle	getCloseHandle()
public MethodHandle	getErrorHandle()
public String[]	getNamedTemplateVariables()
public MethodHandle	getOpenHandle()
public MethodHandle	getPongHandle()
public JakartaWebSocketMessageMetadata	getTextMetadata()
public UriTemplatePathSpec	getUriTemplatePathSpec()
public boolean	hasBinaryMetadata()
public boolean	hasTextMetdata()
public void	setBinaryMetadata(JakartaWebSocketMessageMetadata metadata, Object origin)
public void	setCloseHandler(MethodHandle close, Object origin)
public void	setEncoders(Class<? extends Encoder>[] encoders)
public void	setErrorHandler(MethodHandle error, Object origin)
public void	setOpenHandler(MethodHandle open, Object origin)
public void	setPongHandle(MethodHandle pong, Object origin)
public void	setTextMetadata(JakartaWebSocketMessageMetadata metadata, Object origin)
public void	setUriTemplatePathSpec(UriTemplatePathSpec pathSpec)

Modifier and Type

Method and Description

private void

assertNotSet(Object val, String role, Object origin)

private String

describeOrigin(Object obj)

public AvailableDecoders

getAvailableDecoders()

public AvailableEncoders

getAvailableEncoders()

public JakartaWebSocketMessageMetadata

getBinaryMetadata()

public MethodHandle

getCloseHandle()

public MethodHandle

getErrorHandle()

public String[]

getNamedTemplateVariables()

public MethodHandle

getOpenHandle()

public MethodHandle

getPongHandle()

public JakartaWebSocketMessageMetadata

getTextMetadata()

public UriTemplatePathSpec

getUriTemplatePathSpec()

public boolean

hasBinaryMetadata()

public boolean

hasTextMetdata()

public void

setBinaryMetadata(JakartaWebSocketMessageMetadata metadata, Object origin)

public void

setCloseHandler(MethodHandle close, Object origin)

public void

setEncoders(Class<? extends Encoder>[] encoders)

public void

setErrorHandler(MethodHandle error, Object origin)

public void

setOpenHandler(MethodHandle open, Object origin)

public void

setPongHandle(MethodHandle pong, Object origin)

public void

setTextMetadata(JakartaWebSocketMessageMetadata metadata, Object origin)

public void

setUriTemplatePathSpec(UriTemplatePathSpec pathSpec)

Field Detail

availableDecoders	back to summary
private final AvailableDecoders availableDecoders

availableEncoders	back to summary
private final AvailableEncoders availableEncoders

binaryMetadata	back to summary
private JakartaWebSocketMessageMetadata binaryMetadata

closeHandle	back to summary
private MethodHandle closeHandle

errorHandle	back to summary
private MethodHandle errorHandle

NO_VARIABLES	back to summary
private static final String[] NO_VARIABLES

openHandle	back to summary
private MethodHandle openHandle

pongHandle	back to summary
private MethodHandle pongHandle

textMetadata	back to summary
private JakartaWebSocketMessageMetadata textMetadata

uriTemplatePathSpec back to summary

uriTemplatePathSpec	back to summary
private UriTemplatePathSpec uriTemplatePathSpec For `@ServerEndpoint` or `ServerEndpointConfig` based endpoints, this holds the `UriTemplatePathSpec` based off of the configured url-pattern. This is the source of the configured uri-template variables names, as well as the parser for the incoming URI to obtain the values for those variables. Used to bind uri-template variables, with their values from the upgrade, to the methods that have declared their interest in these values via `@PathParam` annotations. The parsed values from the `UriTemplatePathSpec` are returned as a Map of String names to String values. This Metadata Object does not keep track of the parsed values, as they are request specific. This can be null if Metadata is from a client endpoint, or the server endpoint doesn't use uri-template variables.

private UriTemplatePathSpec uriTemplatePathSpec

For @ServerEndpoint or ServerEndpointConfig based endpoints, this holds the UriTemplatePathSpec based off of the configured url-pattern.

This is the source of the configured uri-template variables names, as well as the parser for the incoming URI to obtain the values for those variables.

Used to bind uri-template variables, with their values from the upgrade, to the methods that have declared their interest in these values via @PathParam annotations.

The parsed values from the UriTemplatePathSpec are returned as a Map of String names to String values.

This Metadata Object does not keep track of the parsed values, as they are request specific.

This can be null if Metadata is from a client endpoint, or the server endpoint doesn't use uri-template variables.

JakartaWebSocketFrameHandlerMetadata

back to summary

public JakartaWebSocketFrameHandlerMetadata(EndpointConfig endpointConfig, WebSocketComponents components)

Method Detail

assertNotSet	back to summary
private void assertNotSet(Object val, String role, Object origin) Annotations @SuppressWarnings:Duplicates

describeOrigin	back to summary
private String describeOrigin(Object obj)

getAvailableDecoders	back to summary
public AvailableDecoders getAvailableDecoders()

getAvailableEncoders	back to summary
public AvailableEncoders getAvailableEncoders()

getBinaryMetadata	back to summary
public JakartaWebSocketMessageMetadata getBinaryMetadata()

getCloseHandle	back to summary
public MethodHandle getCloseHandle()

getErrorHandle	back to summary
public MethodHandle getErrorHandle()

getNamedTemplateVariables	back to summary
public String[] getNamedTemplateVariables()

getOpenHandle	back to summary
public MethodHandle getOpenHandle()

getPongHandle	back to summary
public MethodHandle getPongHandle()

getTextMetadata	back to summary
public JakartaWebSocketMessageMetadata getTextMetadata()

getUriTemplatePathSpec	back to summary
public UriTemplatePathSpec getUriTemplatePathSpec()

hasBinaryMetadata	back to summary
public boolean hasBinaryMetadata()

hasTextMetdata	back to summary
public boolean hasTextMetdata()

setBinaryMetadata	back to summary
public void setBinaryMetadata(JakartaWebSocketMessageMetadata metadata, Object origin)

setCloseHandler	back to summary
public void setCloseHandler(MethodHandle close, Object origin)

setEncoders	back to summary
public void setEncoders(Class<? extends Encoder>[] encoders)

setErrorHandler	back to summary
public void setErrorHandler(MethodHandle error, Object origin)

setOpenHandler	back to summary
public void setOpenHandler(MethodHandle open, Object origin)

setPongHandle	back to summary
public void setPongHandle(MethodHandle pong, Object origin)

setTextMetadata	back to summary
public void setTextMetadata(JakartaWebSocketMessageMetadata metadata, Object origin)

setUriTemplatePathSpec	back to summary
public void setUriTemplatePathSpec(UriTemplatePathSpec pathSpec)

public Class JakartaWebSocketFrameHandlerMetadata

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail