[jboss-jira] [JBoss JIRA] (JBEE-155) Javadoc for WebSocketContainer.connectToServer mentions ServerEndpoint instead of ClientEndpoint
Flavia Rainone (Jira)
issues at jboss.org
Mon Apr 15 15:03:00 EDT 2019
[ https://issues.jboss.org/browse/JBEE-155?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Flavia Rainone reassigned JBEE-155:
-----------------------------------
Assignee: Flavia Rainone (was: Shelly McGowan)
> Javadoc for WebSocketContainer.connectToServer mentions ServerEndpoint instead of ClientEndpoint
> ------------------------------------------------------------------------------------------------
>
> Key: JBEE-155
> URL: https://issues.jboss.org/browse/JBEE-155
> Project: JBoss JavaEE Spec APIs
> Issue Type: Bug
> Components: jboss-websocket-api
> Affects Versions: JavaEE 7 Spec APIs 1.0.0.Final
> Reporter: Ron Šmeral
> Assignee: Flavia Rainone
> Priority: Major
>
> 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)}}
> {quote}
> The supplied object must be a class decorated with the class level \{@link javax.websocket.server.*ServerEndpoint*\} annotation.
> {quote}
> 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..._
--
This message was sent by Atlassian Jira
(v7.12.1#712002)
More information about the jboss-jira
mailing list