|
Apache Tomcat 7.0.54 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.tomcat.websocket.WsWebSocketContainer
org.apache.tomcat.websocket.server.WsServerContainer
public class WsServerContainer
Provides a per class loader (i.e. per web application) instance of a ServerContainer. Web application wide defaults may be configured by setting the following servlet context initialisation parameters to the desired values.
Constants.BINARY_BUFFER_SIZE_SERVLET_CONTEXT_INIT_PARAM
Constants.TEXT_BUFFER_SIZE_SERVLET_CONTEXT_INIT_PARAM
Field Summary |
---|
Fields inherited from class org.apache.tomcat.websocket.WsWebSocketContainer |
---|
IO_TIMEOUT_MS_DEFAULT, IO_TIMEOUT_MS_PROPERTY, SSL_CONTEXT_PROPERTY, SSL_PROTOCOLS_PROPERTY, SSL_TRUSTSTORE_PROPERTY, SSL_TRUSTSTORE_PWD_DEFAULT, SSL_TRUSTSTORE_PWD_PROPERTY |
Method Summary | |
---|---|
void |
addEndpoint(Class<?> pojo)
Provides the equivalent of addEndpoint(ServerEndpointConfig)
for publishing plain old java objects (POJOs) that have been annotated as
WebSocket endpoints. |
void |
addEndpoint(ServerEndpointConfig sec)
Published the provided endpoint implementation at the specified path with the specified configuration. |
void |
closeAuthenticatedSession(String httpSessionId)
|
void |
destroy()
Cleans up the resources still in use by WebSocket sessions created from this container. |
void |
doUpgrade(HttpServletRequest request,
HttpServletResponse response,
ServerEndpointConfig sec,
Map<String,String> pathParams)
|
org.apache.tomcat.websocket.server.WsMappingResult |
findMapping(String path)
|
protected WsWriteTimeout |
getTimeout()
|
boolean |
isEnforceNoAddAfterHandshake()
|
protected void |
registerSession(Endpoint endpoint,
WsSession wsSession)
Overridden to make it visible to other classes in this package. |
void |
setEnforceNoAddAfterHandshake(boolean enforceNoAddAfterHandshake)
|
protected void |
unregisterSession(Endpoint endpoint,
WsSession wsSession)
Overridden to make it visible to other classes in this package. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public void addEndpoint(ServerEndpointConfig sec) throws DeploymentException
WsServerContainer(ServletContext)
must be called before calling this method.
addEndpoint
in interface ServerContainer
sec
- The configuration to use when creating endpoint instances
DeploymentException
public void addEndpoint(Class<?> pojo) throws DeploymentException
addEndpoint(ServerEndpointConfig)
for publishing plain old java objects (POJOs) that have been annotated as
WebSocket endpoints.
addEndpoint
in interface ServerContainer
pojo
- The annotated POJO
DeploymentException
public void destroy()
WsWebSocketContainer
Future
s associated with blocking read/writes.
destroy
in class WsWebSocketContainer
public void doUpgrade(HttpServletRequest request, HttpServletResponse response, ServerEndpointConfig sec, Map<String,String> pathParams) throws ServletException, IOException
ServletException
IOException
public org.apache.tomcat.websocket.server.WsMappingResult findMapping(String path)
public boolean isEnforceNoAddAfterHandshake()
public void setEnforceNoAddAfterHandshake(boolean enforceNoAddAfterHandshake)
protected WsWriteTimeout getTimeout()
protected void registerSession(Endpoint endpoint, WsSession wsSession)
registerSession
in class WsWebSocketContainer
protected void unregisterSession(Endpoint endpoint, WsSession wsSession)
unregisterSession
in class WsWebSocketContainer
public void closeAuthenticatedSession(String httpSessionId)
|
Apache Tomcat 7.0.54 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |