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

Modifier and Type	Field and Description
pack-priv static final InvokerUtils.Arg[]	binaryPartialArrayCallingArgs
pack-priv static final InvokerUtils.Arg[]	binaryPartialBufferCallingArgs
protected final WebSocketComponents	components
protected final JakartaWebSocketContainer	container
private static final MethodHandle	FILTER_RETURN_TYPE_METHOD
protected final InvokerUtils.ParamIdentifier	paramIdentifier
pack-priv static final InvokerUtils.Arg[]	pongCallingArgs
pack-priv static final InvokerUtils.Arg[]	textPartialCallingArgs

Access	Constructor and Description
public	JakartaWebSocketFrameHandlerFactory(JakartaWebSocketContainer container, InvokerUtils.ParamIdentifier paramIdentifier)

Method Summary

Modifier and Type	Method and Description
private void	assertSignatureValid(Class<?> endpointClass, Method method, Class<? extends Annotation> annotationClass)
public static MethodHandle	Returns: a MethodHandle where all of the `namedVariables` in the target type have been statically assigned a converted value (and removed from the resulting `MethodHandle#type()`, or null if no `target` MethodHandle was provided. bindTemplateVariables(MethodHandle the target MethodHandle to work with. This is assumed to contain a `MethodHandle#type()` where all of the initial parameters are the same parameters as found in the provided `namedVariables` array. target, String[] the array of named variables. Can be null. namedVariables, Map<String, String> the Map of template values (Key to Value), must have same number of entries that `namedVariables` has. templateValues) Bind the URI Template Variables to their provided values, converting to the type that the MethodHandle target has declared.
protected JakartaWebSocketFrameHandlerMetadata	createEndpointMetadata(EndpointConfig endpointConfig)
public static MessageSink	createMessageSink(JakartaWebSocketSession session, JakartaWebSocketMessageMetadata msgMetadata)
protected JakartaWebSocketFrameHandlerMetadata	discoverJakartaFrameHandlerMetadata(Class<?> endpointClass, JakartaWebSocketFrameHandlerMetadata metadata)
public static MethodHandles.Lookup	Returns: a lookup object to be used to find methods on the lookupClass. getApplicationMethodHandleLookup(Class<?> the desired lookup class for the new lookup object. lookupClass) Gives a `MethodHandles.Lookup` instance to be used to find public methods in application classes.
pack-priv static InvokerUtils.Arg[]	getArgsFor(Class<?> objectType)
public abstract JakartaWebSocketFrameHandlerMetadata	getMetadata(Class<?> endpointClass, EndpointConfig endpointConfig)
public static MethodHandles.Lookup	Returns: a lookup object to be used to find methods on server classes. getServerMethodHandleLookup() Gives a `MethodHandles.Lookup` instance to be used to find methods in server classes.
private boolean	matchDecoders(Method onMsg, JakartaWebSocketFrameHandlerMetadata metadata, JakartaWebSocketMessageMetadata msgMetadata, Function<InvokerUtils.Arg[], MethodHandle> getMethodHandle)
private boolean	matchOnMessage(Method onMsg, JakartaWebSocketFrameHandlerMetadata metadata, JakartaWebSocketMessageMetadata msgMetadata, Function<InvokerUtils.Arg[], MethodHandle> getMethodHandle)
public abstract EndpointConfig	newDefaultEndpointConfig(Class<?> endpointClass)
public JakartaWebSocketFrameHandler	newJakartaWebSocketFrameHandler(Object endpointInstance, UpgradeRequest upgradeRequest)
private MethodHandle	toMethodHandle(MethodHandles.Lookup lookup, Method method)
public static MethodHandle	wrapNonVoidReturnType(MethodHandle handle, JakartaWebSocketSession session)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

binaryPartialArrayCallingArgs	back to summary
pack-priv static final InvokerUtils.Arg[] binaryPartialArrayCallingArgs

binaryPartialBufferCallingArgs	back to summary
pack-priv static final InvokerUtils.Arg[] binaryPartialBufferCallingArgs

components	back to summary
protected final WebSocketComponents components

container	back to summary
protected final JakartaWebSocketContainer container

FILTER_RETURN_TYPE_METHOD	back to summary
private static final MethodHandle FILTER_RETURN_TYPE_METHOD

paramIdentifier	back to summary
protected final InvokerUtils.ParamIdentifier paramIdentifier

pongCallingArgs	back to summary
pack-priv static final InvokerUtils.Arg[] pongCallingArgs

textPartialCallingArgs	back to summary
pack-priv static final InvokerUtils.Arg[] textPartialCallingArgs

JakartaWebSocketFrameHandlerFactory	back to summary
public JakartaWebSocketFrameHandlerFactory(JakartaWebSocketContainer container, InvokerUtils.ParamIdentifier paramIdentifier)

Method Detail

assertSignatureValid	back to summary
private void assertSignatureValid(Class<?> endpointClass, Method method, Class<? extends Annotation> annotationClass)

bindTemplateVariables back to summary

bindTemplateVariables	back to summary
public static MethodHandle bindTemplateVariables(MethodHandle target, String[] namedVariables, Map<String, String> templateValues) Bind the URI Template Variables to their provided values, converting to the type that the MethodHandle target has declared. Conversion follows the JSR356 rules for @PathParam and only supports String, Primitive Types (and their Boxed version) Parameters target:MethodHandle the target MethodHandle to work with. This is assumed to contain a `MethodHandle#type()` where all of the initial parameters are the same parameters as found in the provided `namedVariables` array. namedVariables:String[] the array of named variables. Can be null. templateValues:Map<String, String> the Map of template values (Key to Value), must have same number of entries that `namedVariables` has. Returns:MethodHandle a MethodHandle where all of the `namedVariables` in the target type have been statically assigned a converted value (and removed from the resulting `MethodHandle#type()`, or null if no `target` MethodHandle was provided.

public static MethodHandle bindTemplateVariables(MethodHandle target, String[] namedVariables, Map<String, String> templateValues)

Bind the URI Template Variables to their provided values, converting to the type that the MethodHandle target has declared.

Conversion follows the JSR356 rules for @PathParam and only supports String, Primitive Types (and their Boxed version)

Parameters

target:MethodHandle: the target MethodHandle to work with. This is assumed to contain a MethodHandle#type() where all of the initial parameters are the same parameters as found in the provided namedVariables array.
namedVariables:String[]: the array of named variables. Can be null.
templateValues:Map<String, String>: the Map of template values (Key to Value), must have same number of entries that namedVariables has.

Returns:MethodHandle

a MethodHandle where all of the namedVariables in the target type have been statically assigned a converted value (and removed from the resulting MethodHandle#type(), or null if no target MethodHandle was provided.

createEndpointMetadata	back to summary
protected JakartaWebSocketFrameHandlerMetadata createEndpointMetadata(EndpointConfig endpointConfig)

createMessageSink	back to summary
public static MessageSink createMessageSink(JakartaWebSocketSession session, JakartaWebSocketMessageMetadata msgMetadata)

discoverJakartaFrameHandlerMetadata	back to summary
protected JakartaWebSocketFrameHandlerMetadata discoverJakartaFrameHandlerMetadata(Class<?> endpointClass, JakartaWebSocketFrameHandlerMetadata metadata)

getApplicationMethodHandleLookup back to summary

getApplicationMethodHandleLookup	back to summary
public static MethodHandles.Lookup getApplicationMethodHandleLookup(Class<?> lookupClass) Gives a `MethodHandles.Lookup` instance to be used to find public methods in application classes. For lookups on server classes use `getServerMethodHandleLookup()` instead. This uses `MethodHandles#publicLookup()` as we only need access to public method of the lookupClass. To look up a method on the lookupClass, it must be public and the class must be accessible from this module, so if the lookupClass is in a JPMS module it must be exported so that the public methods of the lookupClass are accessible outside of the module. The `java.lang.invoke.MethodHandles.Lookup#in(Class)` allows us to search specifically in the endpoint Class to avoid any potential linkage errors which could occur if the same class is present in multiple web apps. Unlike using `MethodHandles#publicLookup()` using `MethodHandles#lookup()` with `java.lang.invoke.MethodHandles.Lookup#in(Class)` will cause the lookup to lose its public access to the lookup class if they are in different modules. `MethodHandles#privateLookupIn(Class, MethodHandles.Lookup)` is also unsuitable because it requires the caller module to read the target module, and the target module to open reflective access to the lookupClasses private methods. This is possible but requires extra configuration to provide private access which is not necessary for the purpose of accessing the public methods. Parameters lookupClass:Class<?> the desired lookup class for the new lookup object. Returns:MethodHandles.Lookup a lookup object to be used to find methods on the lookupClass.

public static MethodHandles.Lookup getApplicationMethodHandleLookup(Class<?> lookupClass)

Gives a MethodHandles.Lookup instance to be used to find public methods in application classes. For lookups on server classes use getServerMethodHandleLookup() instead.

This uses MethodHandles#publicLookup() as we only need access to public method of the lookupClass. To look up a method on the lookupClass, it must be public and the class must be accessible from this module, so if the lookupClass is in a JPMS module it must be exported so that the public methods of the lookupClass are accessible outside of the module.

The java.lang.invoke.MethodHandles.Lookup#in(Class) allows us to search specifically in the endpoint Class to avoid any potential linkage errors which could occur if the same class is present in multiple web apps. Unlike using MethodHandles#publicLookup() using MethodHandles#lookup() with java.lang.invoke.MethodHandles.Lookup#in(Class) will cause the lookup to lose its public access to the lookup class if they are in different modules.

MethodHandles#privateLookupIn(Class, MethodHandles.Lookup) is also unsuitable because it requires the caller module to read the target module, and the target module to open reflective access to the lookupClasses private methods. This is possible but requires extra configuration to provide private access which is not necessary for the purpose of accessing the public methods.

Parameters

lookupClass:Class<?>: the desired lookup class for the new lookup object.

Returns:MethodHandles.Lookup

a lookup object to be used to find methods on the lookupClass.

getArgsFor	back to summary
pack-priv static InvokerUtils.Arg[] getArgsFor(Class<?> objectType)

getMetadata	back to summary
public abstract JakartaWebSocketFrameHandlerMetadata getMetadata(Class<?> endpointClass, EndpointConfig endpointConfig)

getServerMethodHandleLookup back to summary

getServerMethodHandleLookup	back to summary
public static MethodHandles.Lookup getServerMethodHandleLookup() Gives a `MethodHandles.Lookup` instance to be used to find methods in server classes. For lookups on application classes use `getApplicationMethodHandleLookup(Class)` instead. This uses the caller sensitive `MethodHandles#lookup()`, this will allow MethodHandle access to server classes we need to use and will give access permissions to private methods as well. Returns:MethodHandles.Lookup a lookup object to be used to find methods on server classes.

public static MethodHandles.Lookup getServerMethodHandleLookup()

Gives a MethodHandles.Lookup instance to be used to find methods in server classes. For lookups on application classes use getApplicationMethodHandleLookup(Class) instead.

This uses the caller sensitive MethodHandles#lookup(), this will allow MethodHandle access to server classes we need to use and will give access permissions to private methods as well.

Returns:MethodHandles.Lookup: a lookup object to be used to find methods on server classes.

matchDecoders	back to summary
private boolean matchDecoders(Method onMsg, JakartaWebSocketFrameHandlerMetadata metadata, JakartaWebSocketMessageMetadata msgMetadata, Function<InvokerUtils.Arg[], MethodHandle> getMethodHandle)

matchOnMessage	back to summary
private boolean matchOnMessage(Method onMsg, JakartaWebSocketFrameHandlerMetadata metadata, JakartaWebSocketMessageMetadata msgMetadata, Function<InvokerUtils.Arg[], MethodHandle> getMethodHandle)

newDefaultEndpointConfig	back to summary
public abstract EndpointConfig newDefaultEndpointConfig(Class<?> endpointClass)

newJakartaWebSocketFrameHandler	back to summary
public JakartaWebSocketFrameHandler newJakartaWebSocketFrameHandler(Object endpointInstance, UpgradeRequest upgradeRequest)

toMethodHandle	back to summary
private MethodHandle toMethodHandle(MethodHandles.Lookup lookup, Method method)

wrapNonVoidReturnType	back to summary
public static MethodHandle wrapNonVoidReturnType(MethodHandle handle, JakartaWebSocketSession session)

public abstract Class JakartaWebSocketFrameHandlerFactory

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail