-
- All Superinterfaces:
- WebSocketContainer
public interface ServerContainer extends WebSocketContainer
The ServerContainer is the specialized view of the WebSocketContainer available in server-side deployments. There is one ServerContainer instance per websocket application. The ServerContainer holds the methods to be able to register server endpoints during the initialization phase of the application.For websocket enabled web containers, developers may obtain a reference to the ServerContainer instance by retrieving it as an attribute named
javax.websocket.server.ServerContainer
on the ServletContext. This way, the registration methods held on this interface may be called to register server endpoints from a ServletContextListener during the deployment of the WAR file containing the endpoint.WebSocket implementations that run outside the web container may have other means by which to provide a ServerContainer instance to the developer at application deployment time.
Once the application deployment phase is complete, and the websocket application has begun accepting incoming connections, the registration methods may no longer be called.
- Author:
- dannycoward
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method and Description void
addEndpoint(Class<?> endpointClass)
Deploys the given annotated endpoint into this ServerContainer during the initialization phase of deploying the application.void
addEndpoint(ServerEndpointConfig serverConfig)
-
Methods inherited from interface javax.websocket.WebSocketContainer
connectToServer, connectToServer, connectToServer, connectToServer, getDefaultAsyncSendTimeout, getDefaultMaxBinaryMessageBufferSize, getDefaultMaxSessionIdleTimeout, getDefaultMaxTextMessageBufferSize, getInstalledExtensions, setAsyncSendTimeout, setDefaultMaxBinaryMessageBufferSize, setDefaultMaxSessionIdleTimeout, setDefaultMaxTextMessageBufferSize
-
-
-
-
Method Detail
-
addEndpoint
void addEndpoint(Class<?> endpointClass) throws DeploymentException
Deploys the given annotated endpoint into this ServerContainer during the initialization phase of deploying the application.- Parameters:
endpointClass
- the class of the annotated endpoint- Throws:
DeploymentException
- if the annotated endpoint was badly formed.IllegalStateException
- if the containing websocket application has already been deployed.
-
addEndpoint
void addEndpoint(ServerEndpointConfig serverConfig) throws DeploymentException
- Parameters:
serverConfig
- the configuration instance representing the logical endpoint that will be registered.- Throws:
DeploymentException
- if the endpoint was badly formed.IllegalStateException
- if the containing websocket application has already been deployed.
-
-
Nederlandse vertaling
U hebt gevraagd om deze site in het Nederlands te bezoeken. Voor nu wordt alleen de interface vertaald, maar nog niet alle inhoud.Als je me wilt helpen met vertalingen, is je bijdrage welkom. Het enige dat u hoeft te doen, is u op de site registreren en mij een bericht sturen waarin u wordt gevraagd om u toe te voegen aan de groep vertalers, zodat u de gewenste pagina's kunt vertalen. Een link onderaan elke vertaalde pagina geeft aan dat u de vertaler bent en heeft een link naar uw profiel.
Bij voorbaat dank.
Document heeft de 11/06/2005 gemaakt, de laatste keer de 18/08/2025 gewijzigd
Bron van het afgedrukte document:https://www.gaudry.be/nl/java-api-javaee-rf-javax/websocket/server/servercontainer.html
De infobrol is een persoonlijke site waarvan de inhoud uitsluitend mijn verantwoordelijkheid is. De tekst is beschikbaar onder CreativeCommons-licentie (BY-NC-SA). Meer info op de gebruiksvoorwaarden en de auteur.
Referenties
Deze verwijzingen en links verwijzen naar documenten die geraadpleegd zijn tijdens het schrijven van deze pagina, of die aanvullende informatie kunnen geven, maar de auteurs van deze bronnen kunnen niet verantwoordelijk worden gehouden voor de inhoud van deze pagina.
De auteur van deze site is als enige verantwoordelijk voor de manier waarop de verschillende concepten, en de vrijheden die met de referentiewerken worden genomen, hier worden gepresenteerd. Vergeet niet dat u meerdere broninformatie moet doorgeven om het risico op fouten te verkleinen.