| Package | Description | 
|---|---|
| jakarta.websocket | This package contains all the Jakartq WebSocket APIs common to both the client and server side. | 
| jakarta.websocket.server | This package contains all the Jakarta WebSocket APIs used only by server side applications. | 
| org.glassfish.tyrus.client | Common Client. | 
| org.glassfish.tyrus.core | Core classes. | 
| org.glassfish.tyrus.core.cluster | Cluster relates classes and interfaces. | 
| org.glassfish.tyrus.core.extension | WebSocket Extension support. | 
| org.glassfish.tyrus.server | Server implementation. | 
| Modifier and Type | Method and Description | 
|---|---|
| java.util.List<Extension> | ClientEndpointConfig. getExtensions()Return the extensions, in order of preference, favorite first, that this client would like to use for its
 sessions. | 
| java.util.Set<Extension> | WebSocketContainer. getInstalledExtensions()Return the set of Extensions installed in the container. | 
| java.util.List<Extension> | Session. getNegotiatedExtensions()Return the list of extensions currently in use for this conversation. | 
| Modifier and Type | Method and Description | 
|---|---|
| ClientEndpointConfig.Builder | ClientEndpointConfig.Builder. extensions(java.util.List<Extension> extensions)Set the extensions for the configuration this builder will build. | 
| Modifier and Type | Method and Description | 
|---|---|
| java.util.List<Extension> | ServerEndpointConfig. getExtensions()Return the websocket extensions configured. | 
| java.util.List<Extension> | ServerEndpointConfig.Configurator. getNegotiatedExtensions(java.util.List<Extension> installed,
                       java.util.List<Extension> requested)Return the ordered list of extensions that t server endpoint will support given the requested extension list
 passed in, the empty list if none. | 
| Modifier and Type | Method and Description | 
|---|---|
| ServerEndpointConfig.Builder | ServerEndpointConfig.Builder. extensions(java.util.List<Extension> extensions)Sets the extensions to use in the configuration. | 
| java.util.List<Extension> | ServerEndpointConfig.Configurator. getNegotiatedExtensions(java.util.List<Extension> installed,
                       java.util.List<Extension> requested)Return the ordered list of extensions that t server endpoint will support given the requested extension list
 passed in, the empty list if none. | 
| java.util.List<Extension> | ServerEndpointConfig.Configurator. getNegotiatedExtensions(java.util.List<Extension> installed,
                       java.util.List<Extension> requested)Return the ordered list of extensions that t server endpoint will support given the requested extension list
 passed in, the empty list if none. | 
| Modifier and Type | Method and Description | 
|---|---|
| java.util.Set<Extension> | ClientManager. getInstalledExtensions() | 
| Modifier and Type | Class and Description | 
|---|---|
| class  | TyrusExtensionWebSocket  Extensionimplementation. | 
| Modifier and Type | Method and Description | 
|---|---|
| static java.util.List<Extension> | TyrusExtension. fromHeaders(java.util.List<java.lang.String> extensionHeaders)Parse  Extensionfrom headers (represented asListof strings). | 
| static java.util.List<Extension> | TyrusExtension. fromString(java.util.List<java.lang.String> s)Parsing of one  Extension. | 
| java.util.List<Extension> | TyrusSession. getNegotiatedExtensions() | 
| java.util.List<Extension> | TyrusServerEndpointConfigurator. getNegotiatedExtensions(java.util.List<Extension> installed,
                       java.util.List<Extension> requested) | 
| Modifier and Type | Method and Description | 
|---|---|
| Session | TyrusEndpointWrapper. createSessionForRemoteEndpoint(TyrusWebSocket socket,
                              java.lang.String subprotocol,
                              java.util.List<Extension> extensions,
                              DebugContext debugContext)Creates a Session based on the  TyrusWebSocket, subprotocols and extensions. | 
| TyrusServerEndpointConfig.Builder | TyrusServerEndpointConfig.Builder. extensions(java.util.List<Extension> extensions)Sets the extensions to use in the configuration. | 
| static AnnotatedEndpoint | AnnotatedEndpoint. fromClass(java.lang.Class<?> annotatedClass,
         ComponentProviderService componentProvider,
         boolean isServerEndpoint,
         int incomingBufferSize,
         ErrorCollector collector,
         EndpointEventListener endpointEventListener,
         java.util.Set<Extension> extensions)Create  AnnotatedEndpointfrom class. | 
| static AnnotatedEndpoint | AnnotatedEndpoint. fromInstance(java.lang.Object annotatedInstance,
            ComponentProviderService componentProvider,
            boolean isServerEndpoint,
            int incomingBufferSize,
            ErrorCollector collector,
            java.util.Set<Extension> extensions)Create  AnnotatedEndpointfrom instance. | 
| java.util.List<Extension> | TyrusServerEndpointConfigurator. getNegotiatedExtensions(java.util.List<Extension> installed,
                       java.util.List<Extension> requested) | 
| java.util.List<Extension> | TyrusServerEndpointConfigurator. getNegotiatedExtensions(java.util.List<Extension> installed,
                       java.util.List<Extension> requested) | 
| void | TyrusWebSocket. onConnect(UpgradeRequest upgradeRequest,
         java.lang.String subProtocol,
         java.util.List<Extension> extensions,
         java.lang.String connectionId,
         DebugContext debugContext)This callback will be invoked when the opening handshake between both
 endpoints has been completed. | 
| void | Handshake. setExtensions(java.util.List<Extension> extensions)Client side only - set the list of supported extensions. | 
| void | ProtocolHandler. setExtensions(java.util.List<Extension> extensions)Client side. | 
| Modifier and Type | Method and Description | 
|---|---|
| java.util.List<Extension> | RemoteSession. getNegotiatedExtensions()Get the list of extensions currently in use for this conversation. | 
| Modifier and Type | Interface and Description | 
|---|---|
| interface  | ExtendedExtensionWebSocket  Extension. | 
| Modifier and Type | Method and Description | 
|---|---|
| java.util.Set<Extension> | TyrusServerContainer. getInstalledExtensions() | 
Copyright © 2012–2020 Oracle Corporation. All rights reserved.