com.goldencode.p2j.web

Class PojoWebSocketHandler

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.ContainerLifeCycle

org.eclipse.jetty.server.handler.AbstractHandler

org.eclipse.jetty.server.handler.AbstractHandlerContainer

org.eclipse.jetty.server.handler.HandlerWrapper

org.eclipse.jetty.websocket.server.WebSocketHandler

com.goldencode.p2j.web.PojoWebSocketHandler

All Implemented Interfaces:

org.eclipse.jetty.server.Handler, org.eclipse.jetty.server.HandlerContainer, org.eclipse.jetty.util.component.Container, org.eclipse.jetty.util.component.Destroyable, org.eclipse.jetty.util.component.Dumpable, org.eclipse.jetty.util.component.Dumpable.DumpableContainer, org.eclipse.jetty.util.component.LifeCycle

public class PojoWebSocketHandler
extends org.eclipse.jetty.websocket.server.WebSocketHandler

This class is used to register and handle WebSockets POJO objects.

Methods to create WebSockets:

• POJO WebSocket using annotations.
• Implements WebSocketListener interface.
• Extends WebSocketAdapter class.

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.jetty.websocket.server.WebSocketHandler

org.eclipse.jetty.websocket.server.WebSocketHandler.Simple

Nested classes/interfaces inherited from class org.eclipse.jetty.server.handler.AbstractHandler

org.eclipse.jetty.server.handler.AbstractHandler.ErrorDispatchHandler

Nested classes/interfaces inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.AbstractLifeCycle.AbstractLifeCycleListener

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.LifeCycle

org.eclipse.jetty.util.component.LifeCycle.Listener

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Container

org.eclipse.jetty.util.component.Container.InheritedListener, org.eclipse.jetty.util.component.Container.Listener

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Dumpable

org.eclipse.jetty.util.component.Dumpable.DumpableContainer

Field Summary

Fields

Modifier and Type	Field and Description
private WebSocketConfig	config Websocket configuration
private org.eclipse.jetty.websocket.servlet.WebSocketCreator	creator WebSocketCreator used to create WebSockets by hand
private java.lang.Class<?>	webSocketPojo WebSocket class
private java.lang.String	webSocketTarget WebSocket target should be unique on the server context

Fields inherited from class org.eclipse.jetty.server.handler.HandlerWrapper

_handler

Fields inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

FAILED, RUNNING, STARTED, STARTING, STOPPED, STOPPING

Fields inherited from interface org.eclipse.jetty.util.component.Dumpable

KEY

Constructor Summary

Constructors

Constructor and Description
PojoWebSocketHandler(java.lang.String webSocketTarget, java.lang.Class<?> webSocketPojo, WebSocketConfig config) Constructor.
PojoWebSocketHandler(java.lang.String webSocketTarget, org.eclipse.jetty.websocket.servlet.WebSocketCreator creator, WebSocketConfig config) Constructor.

Method Summary

Modifier and Type	Method and Description
void	configure(org.eclipse.jetty.websocket.servlet.WebSocketServletFactory wsServletFactory) Register a WebSocket class POJO with the default WebSocketCreator or using a custom creator.
void	handle(java.lang.String target, org.eclipse.jetty.server.Request baseRequest, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Handle WebSocket's upgrade requests.

Methods inherited from class org.eclipse.jetty.websocket.server.WebSocketHandler

configurePolicy, doStart, getWebSocketFactory

Methods inherited from class org.eclipse.jetty.server.handler.HandlerWrapper

destroy, expandChildren, getHandler, getHandlers, insertHandler, setHandler

Methods inherited from class org.eclipse.jetty.server.handler.AbstractHandlerContainer

doShutdown, expandHandler, findContainerOf, getChildHandlerByClass, getChildHandlers, getChildHandlersByClass, setServer

Methods inherited from class org.eclipse.jetty.server.handler.AbstractHandler

doError, doStop, getServer

Methods inherited from class org.eclipse.jetty.util.component.ContainerLifeCycle

addBean, addBean, addEventListener, addManaged, contains, dump, dump, dump, dump, dump, dumpBeans, dumpObject, dumpObjects, dumpStdErr, dumpThis, getBean, getBeans, getBeans, getContainedBeans, getContainedBeans, isAuto, isManaged, isUnmanaged, manage, removeBean, removeBeans, removeEventListener, setBeans, setStopTimeout, start, stop, unmanage, updateBean, updateBean, updateBeans

Methods inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

addLifeCycleListener, getState, getState, getStopTimeout, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, start, stop, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.jetty.util.component.LifeCycle

addLifeCycleListener, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, start, start, stop, stop

Methods inherited from interface org.eclipse.jetty.util.component.Dumpable.DumpableContainer

isDumpable

Methods inherited from interface org.eclipse.jetty.util.component.Dumpable

dumpContainer, dumpIterable, dumpMapEntries, dumpObjects, dumpSelf, named

Field Detail

webSocketPojo

private java.lang.Class<?> webSocketPojo

WebSocket class

webSocketTarget

private java.lang.String webSocketTarget

WebSocket target should be unique on the server context

creator

private org.eclipse.jetty.websocket.servlet.WebSocketCreator creator

WebSocketCreator used to create WebSockets by hand

config

private WebSocketConfig config

Websocket configuration

Constructor Detail

PojoWebSocketHandler

public PojoWebSocketHandler(java.lang.String webSocketTarget,
                            org.eclipse.jetty.websocket.servlet.WebSocketCreator creator,
                            WebSocketConfig config)

Constructor.

Parameters:

webSocketTarget - The WebSocket target string. This value should be unique on the WebSocket collection of handlers for the same server context.

creator - The WebSocketCreator instance used tom create WebSockets by hand.

config - The websocket configuration parameters.

PojoWebSocketHandler

public PojoWebSocketHandler(java.lang.String webSocketTarget,
                            java.lang.Class<?> webSocketPojo,
                            WebSocketConfig config)

Constructor.

Parameters:

webSocketTarget - The WebSocket target string. This value should be unique on the WebSocket collection of handlers for the same server context.

webSocketPojo - The WebSocket POJO class.

config - The websocket configuration parameters.

Method Detail

configure

public void configure(org.eclipse.jetty.websocket.servlet.WebSocketServletFactory wsServletFactory)

Register a WebSocket class POJO with the default WebSocketCreator or using a custom creator.

Specified by:

configure in class org.eclipse.jetty.websocket.server.WebSocketHandler

Parameters:

wsServletFactory - Basic WebSocketServletFactory for working with Jetty-based WebSocketServlet

handle

public void handle(java.lang.String target,
                   org.eclipse.jetty.server.Request baseRequest,
                   javax.servlet.http.HttpServletRequest request,
                   javax.servlet.http.HttpServletResponse response)
            throws java.io.IOException,
                   javax.servlet.ServletException

Handle WebSocket's upgrade requests. If the request is not handled and the target is equal to this target handler, then set handled to true

Specified by:

handle in interface org.eclipse.jetty.server.Handler

Overrides:

handle in class org.eclipse.jetty.websocket.server.WebSocketHandler

Parameters:

target - The target of the request - either a URI or a name.

baseRequest - The original unwrapped request object.

request - The request either as the Request object or a wrapper of that request.

response - The response as the Response object or a wrapper of that request.

Throws:

java.io.IOException

javax.servlet.ServletException