javax.websocket.server

Interface ServerApplicationConfig

Contents

  • public interface ServerApplicationConfig
    Developers include implementations of ServerApplicationConfig in an archive containing websocket endpoints (WAR file, or JAR file within the WAR file) in order to specify the websocket endpoints within the archive the implementation must deploy. There is a separate method for programmatic endpoints and for annotated endpoints.
    Author:
    dannycoward

    • Method Detail

      • getEndpointConfigs

        Set<ServerEndpointConfig> getEndpointConfigs(Set<Class<? extends Endpoint>> endpointClasses)
        Return a set of ServerEndpointConfig instances that the server container will use to deploy the programmatic endpoints. The set of Endpoint classes passed in to this method is the set obtained by scanning the archive containing the implementation of this ServerApplicationConfig. This set passed in may be used the build the set of ServerEndpointConfig instances to return to the container for deployment.
        Parameters:
        endpointClasses - the set of all the Endpoint classes in the archive containing the implementation of this interface.
        Returns:
        the non-null set of ServerEndpointConfig s to deploy on the server, using the empty set to indicate none.

      • getAnnotatedEndpointClasses

        Set<Class<?>> getAnnotatedEndpointClasses(Set<Class<?>> scanned)
        Return a set of annotated endpoint classes that the server container must deploy. The set of classes passed in to this method is the set obtained by scanning the archive containing the implementation of this interface. Therefore, this set passed in contains all the annotated endpoint classes in the JAR or WAR file containing the implementation of this interface. This set passed in may be used the build the set to return to the container for deployment.
        Parameters:
        scanned - the set of all the annotated endpoint classes in the archive containing the implementation of this interface.
        Returns:
        the non-null set of annotated endpoint classes to deploy on the server, using the empty set to indicate none.

Document created the 11/06/2005, last modified the 18/08/2025
Source of the printed document:https://www.gaudry.be/en/java-api-javaee-rf-javax/websocket/server/serverapplicationconfig.html

The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.

References

  1. View the html document Language of the document:fr Manuel PHP : https://docs.oracle.com/en/java/, Interface ServerApplicationConfig

These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author of this site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.