org.apache.wicket.protocol.ws.api

Class WebSocketRequestHandler

java.lang.Object

org.apache.wicket.protocol.ws.api.WebSocketRequestHandler

All Implemented Interfaces:

IPageClassRequestHandler, IPageRequestHandler, IPartialPageRequestHandler, IWebSocketRequestHandler, org.apache.wicket.request.ILoggableRequestHandler, org.apache.wicket.request.IRequestHandler

public class WebSocketRequestHandler
extends Object
implements IWebSocketRequestHandler

A handler of WebSocket requests.

Since:

6.0

Constructor Summary

Constructors

Constructor and Description
WebSocketRequestHandler(Component component, IWebSocketConnection connection)

Method Summary

Methods

Modifier and Type	Method and Description
void	add(Component... components)
void	add(Component component, String markupId)
void	addChildren(MarkupContainer parent, Class<?> childCriteria)
void	appendJavaScript(CharSequence javascript)
void	detach(org.apache.wicket.request.IRequestCycle requestCycle)
void	focusComponent(Component component)
Collection<? extends Component>	getComponents()
IHeaderResponse	getHeaderResponse()
org.apache.wicket.request.ILogData	getLogData()
Page	getPage()
Class<? extends IRequestablePage>	getPageClass()
Integer	getPageId()
org.apache.wicket.request.mapper.parameter.PageParameters	getPageParameters()
Integer	getRenderCount()
boolean	isPageInstanceCreated()
void	prependJavaScript(CharSequence javascript)
void	push(byte[] message, int offset, int length) Pushes a binary message to the client.
void	push(CharSequence message) Pushes a text message to the client.
void	respond(org.apache.wicket.request.IRequestCycle requestCycle)

Methods inherited from class java.lang.Object

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

Constructor Detail

WebSocketRequestHandler

public WebSocketRequestHandler(Component component,
                       IWebSocketConnection connection)

Method Detail

push

public void push(CharSequence message)

Description copied from interface: IWebSocketRequestHandler

Pushes a text message to the client.

Specified by:

push in interface IWebSocketRequestHandler

Parameters:

message - the text message to push to the client if the web socket connection is open

push

public void push(byte[] message,
        int offset,
        int length)

Description copied from interface: IWebSocketRequestHandler

Pushes a binary message to the client.

Specified by:

push in interface IWebSocketRequestHandler

Parameters:

message - the binary message to push to the client if the web socket connection is open

offset - the offset to start to read from the message

length - how many bytes to read from the message

add

public void add(Component component,
       String markupId)

Specified by:

add in interface IPartialPageRequestHandler

add

public void add(Component... components)

Specified by:

add in interface IPartialPageRequestHandler

addChildren

public final void addChildren(MarkupContainer parent,
               Class<?> childCriteria)

Specified by:

addChildren in interface IPartialPageRequestHandler

appendJavaScript

public void appendJavaScript(CharSequence javascript)

Specified by:

appendJavaScript in interface IPartialPageRequestHandler

prependJavaScript

public void prependJavaScript(CharSequence javascript)

Specified by:

prependJavaScript in interface IPartialPageRequestHandler

getComponents

public Collection<? extends Component> getComponents()

Specified by:

getComponents in interface IPartialPageRequestHandler

focusComponent

public final void focusComponent(Component component)

Specified by:

focusComponent in interface IPartialPageRequestHandler

getHeaderResponse

public IHeaderResponse getHeaderResponse()

Specified by:

getHeaderResponse in interface IPartialPageRequestHandler

getPage

public Page getPage()

Specified by:

getPage in interface IPageRequestHandler

getPageId

public Integer getPageId()

Specified by:

getPageId in interface IPageRequestHandler

isPageInstanceCreated

public boolean isPageInstanceCreated()

Specified by:

isPageInstanceCreated in interface IPageRequestHandler

getRenderCount

public Integer getRenderCount()

Specified by:

getRenderCount in interface IPageRequestHandler

getLogData

public org.apache.wicket.request.ILogData getLogData()

Specified by:

getLogData in interface org.apache.wicket.request.ILoggableRequestHandler

getPageClass

public Class<? extends IRequestablePage> getPageClass()

Specified by:

getPageClass in interface IPageClassRequestHandler

getPageParameters

public org.apache.wicket.request.mapper.parameter.PageParameters getPageParameters()

Specified by:

getPageParameters in interface IPageClassRequestHandler

respond

public void respond(org.apache.wicket.request.IRequestCycle requestCycle)

Specified by:

respond in interface org.apache.wicket.request.IRequestHandler

detach

public void detach(org.apache.wicket.request.IRequestCycle requestCycle)

Specified by:

detach in interface org.apache.wicket.request.IRequestHandler