Uploaded image for project: 'JBoss Enterprise Spec APIs'
  1. JBoss Enterprise Spec APIs
  2. JBEE-155

Javadoc for WebSocketContainer.connectToServer mentions ServerEndpoint instead of ClientEndpoint

    • Icon: Bug Bug
    • Resolution: Unresolved
    • Icon: Major Major
    • None
    • JavaEE 7 Spec APIs 1.0.0.Final
    • jboss-websocket-api
    • None

      In javax.websocket.WebSocketContainer, the javadoc for two connectToServer method signatures contains an incorrect statement:
      connectToServer(Object annotatedEndpointInstance, URI path)
      connectToServer(Class<?> annotatedEndpointClass, URI path)

      The supplied object must be a class decorated with the class level {@link javax.websocket.server.ServerEndpoint} annotation.

      which should point to javax.websocket.ClientEndpoint instead of the ServerEndpoint.

      Also, in case of connectToServer(Object annotatedEndpointInstance, URI path), that sentence should read ...supplied object must be an instance of a class...

            [JBEE-155] Javadoc for WebSocketContainer.connectToServer mentions ServerEndpoint instead of ClientEndpoint

            Filed upstream: https://java.net/jira/browse/WEBSOCKET_SDK-6, since the org.jboss.spec.javax.websocket API seems to be copied from there.

            Ron Šmeral (Inactive) added a comment - Filed upstream: https://java.net/jira/browse/WEBSOCKET_SDK-6 , since the org.jboss.spec.javax.websocket API seems to be copied from there.

              flaviarnn Flavia Rainone
              rsmeral Ron Šmeral (Inactive)
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated: