| 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.client.exception | Common Client Exceptions | 
| org.glassfish.tyrus.container.grizzly.client | Grizzly Client container. | 
| org.glassfish.tyrus.core | Core classes. | 
| org.glassfish.tyrus.server | Server implementation. | 
| org.glassfish.tyrus.spi | Tyrus SPI. | 
| Modifier and Type | Method and Description | 
|---|---|
| Session | WebSocketContainer. connectToServer(java.lang.Class<?> annotatedEndpointClass,
               java.net.URI path)Connect the supplied annotated endpoint to its server. | 
| Session | WebSocketContainer. connectToServer(java.lang.Class<? extends Endpoint> endpointClass,
               ClientEndpointConfig cec,
               java.net.URI path)Connect the supplied programmatic endpoint to its server with the given configuration. | 
| Session | WebSocketContainer. connectToServer(Endpoint endpointInstance,
               ClientEndpointConfig cec,
               java.net.URI path)Connect the supplied programmatic client endpoint instance to its server with the given configuration. | 
| Session | WebSocketContainer. connectToServer(java.lang.Object annotatedEndpointInstance,
               java.net.URI path)Connect the supplied annotated endpoint instance to its server. | 
| Modifier and Type | Method and Description | 
|---|---|
| void | ServerContainer. addEndpoint(java.lang.Class<?> endpointClass)Deploys the given annotated endpoint into this ServerContainer during the initialization phase of deploying the
 application. | 
| void | ServerContainer. addEndpoint(ServerEndpointConfig serverConfig) | 
| Modifier and Type | Method and Description | 
|---|---|
| java.util.concurrent.Future<Session> | ClientManager. asyncConnectToServer(java.lang.Class<?> annotatedEndpointClass,
                    java.net.URI path)Non-blocking version of  WebSocketContainer.connectToServer(Class, java.net.URI). | 
| java.util.concurrent.Future<Session> | ClientManager. asyncConnectToServer(java.lang.Class<? extends Endpoint> endpointClass,
                    ClientEndpointConfig cec,
                    java.net.URI path)Non-blocking version of  WebSocketContainer.connectToServer(Class, jakarta.websocket.ClientEndpointConfig,
 java.net.URI). | 
| java.util.concurrent.Future<Session> | ClientManager. asyncConnectToServer(Endpoint endpointInstance,
                    ClientEndpointConfig cec,
                    java.net.URI path) | 
| java.util.concurrent.Future<Session> | ClientManager. asyncConnectToServer(java.lang.Object obj,
                    java.net.URI path)Non-blocking version of  WebSocketContainer.connectToServer(Object, java.net.URI). | 
| Session | ClientManager. connectToServer(java.lang.Class<? extends Endpoint> endpointClass,
               ClientEndpointConfig cec,
               java.net.URI path) | 
| Session | ClientManager. connectToServer(java.lang.Class annotatedEndpointClass,
               java.net.URI path) | 
| Session | ClientManager. connectToServer(Endpoint endpointInstance,
               ClientEndpointConfig cec,
               java.net.URI path) | 
| Session | ClientManager. connectToServer(java.lang.Object obj,
               java.net.URI path) | 
| Modifier and Type | Class and Description | 
|---|---|
| class  | DeploymentHandshakeExceptionThe  DeploymentExceptionwrapping theHandshakeExceptionand makes the HTTP status code accessible directly. | 
| Modifier and Type | Method and Description | 
|---|---|
| static DeploymentException | Exceptions. deploymentException(java.lang.String message,
                   java.lang.Throwable cause)Get the Deployment Exception, or return the exception if of the type. | 
| Modifier and Type | Method and Description | 
|---|---|
| void | GrizzlyClientSocket. connect()Performs connect to server endpoint. | 
| void | GrizzlyClientContainer. openClientSocket(ClientEndpointConfig cec,
                java.util.Map<java.lang.String,java.lang.Object> properties,
                ClientEngine clientEngine) | 
| Modifier and Type | Method and Description | 
|---|---|
| DeploymentException | ErrorCollector. composeComprehensiveException()Create  DeploymentExceptionwith message concatenated from collected exceptions. | 
| Modifier and Type | Method and Description | 
|---|---|
| void | TyrusWebSocketEngine. register(java.lang.Class<?> endpointClass,
        java.lang.String contextPath) | 
| void | TyrusWebSocketEngine. register(ServerEndpointConfig serverConfig,
        java.lang.String contextPath) | 
| Constructor and Description | 
|---|
| TyrusEndpointWrapper(java.lang.Class<? extends Endpoint> endpointClass,
                    EndpointConfig configuration,
                    ComponentProviderService componentProvider,
                    WebSocketContainer container,
                    java.lang.String contextPath,
                    ServerEndpointConfig.Configurator configurator,
                    TyrusEndpointWrapper.SessionListener sessionListener,
                    ClusterContext clusterContext,
                    EndpointEventListener endpointEventListener,
                    java.lang.Boolean parallelBroadcastEnabled)Create  TyrusEndpointWrapperfor class that extendsEndpoint. | 
| TyrusEndpointWrapper(Endpoint endpoint,
                    EndpointConfig configuration,
                    ComponentProviderService componentProvider,
                    WebSocketContainer container,
                    java.lang.String contextPath,
                    ServerEndpointConfig.Configurator configurator,
                    TyrusEndpointWrapper.SessionListener sessionListener,
                    ClusterContext clusterContext,
                    EndpointEventListener endpointEventListener,
                    java.lang.Boolean parallelBroadcastEnabled) | 
| Modifier and Type | Method and Description | 
|---|---|
| void | TyrusServerContainer. addEndpoint(java.lang.Class<?> endpointClass) | 
| void | TyrusServerContainer. addEndpoint(ServerEndpointConfig serverEndpointConfig) | 
| java.util.concurrent.Future<Session> | TyrusServerContainer. asyncConnectToServer(java.lang.Class<?> annotatedEndpointClass,
                    java.net.URI path)Non-blocking version of  WebSocketContainer.connectToServer(Class, java.net.URI). | 
| java.util.concurrent.Future<Session> | TyrusServerContainer. asyncConnectToServer(java.lang.Class<? extends Endpoint> endpointClass,
                    ClientEndpointConfig cec,
                    java.net.URI path)Non-blocking version of  WebSocketContainer.connectToServer(Class,
 jakarta.websocket.ClientEndpointConfig, java.net.URI). | 
| java.util.concurrent.Future<Session> | TyrusServerContainer. asyncConnectToServer(Endpoint endpointInstance,
                    ClientEndpointConfig cec,
                    java.net.URI path) | 
| java.util.concurrent.Future<Session> | TyrusServerContainer. asyncConnectToServer(java.lang.Object obj,
                    java.net.URI path)Non-blocking version of  WebSocketContainer.connectToServer(Object, java.net.URI). | 
| Session | TyrusServerContainer. connectToServer(java.lang.Class<? extends Endpoint> endpointClass,
               ClientEndpointConfig cec,
               java.net.URI path) | 
| Session | TyrusServerContainer. connectToServer(java.lang.Class annotatedEndpointClass,
               java.net.URI path) | 
| Session | TyrusServerContainer. connectToServer(Endpoint endpointInstance,
               ClientEndpointConfig cec,
               java.net.URI path) | 
| Session | TyrusServerContainer. connectToServer(java.lang.Object annotatedEndpointInstance,
               java.net.URI path) | 
| abstract void | TyrusServerContainer. register(java.lang.Class<?> endpointClass) | 
| abstract void | TyrusServerContainer. register(ServerEndpointConfig serverEndpointConfig) | 
| void | Server. start()Start the server. | 
| void | TyrusServerContainer. start(java.lang.String rootPath,
     int port)Start the container. | 
| void | TyrusServerContainer. upgradeHttpToWebSocket(java.lang.Object httpServletRequest,
                      java.lang.Object httpServletResponse,
                      ServerEndpointConfig sec,
                      java.util.Map<java.lang.String,java.lang.String> pathParameters) | 
| Modifier and Type | Method and Description | 
|---|---|
| void | ClientContainer. openClientSocket(ClientEndpointConfig cec,
                java.util.Map<java.lang.String,java.lang.Object> properties,
                ClientEngine clientEngine)Open client socket - connect to endpoint specified with  urlparameter. | 
| void | WebSocketEngine. register(java.lang.Class<?> endpointClass,
        java.lang.String contextPath)Register endpoint class. | 
| void | WebSocketEngine. register(ServerEndpointConfig serverConfig,
        java.lang.String contextPath)Register  ServerEndpointConfig. | 
| void | ServerContainer. start(java.lang.String rootPath,
     int port)Start the server. | 
Copyright © 2012–2020 Oracle Corporation. All rights reserved.