Package org.apache.wicket.protocol.ws.api

Class WebSocketRequestHandler

  • All Implemented Interfaces:
    org.apache.wicket.core.request.handler.IPageClassRequestHandler, org.apache.wicket.core.request.handler.IPageRequestHandler, org.apache.wicket.core.request.handler.IPartialPageRequestHandler, IWebSocketRequestHandler, org.apache.wicket.request.ILoggableRequestHandler, org.apache.wicket.request.IRequestHandler
    public class WebSocketRequestHandler
extends java.lang.Object
implements IWebSocketRequestHandler
    A handler of WebSocket requests.
    Since:
    6.0

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void add​(org.apache.wicket.Component... components)  
      void add​(org.apache.wicket.Component component, java.lang.String markupId)  
      void addChildren​(org.apache.wicket.MarkupContainer parent, java.lang.Class<?> childCriteria)  
      void appendJavaScript​(java.lang.CharSequence javascript)  
      void detach​(org.apache.wicket.request.IRequestCycle requestCycle)  
      void focusComponent​(org.apache.wicket.Component component)  
      java.util.Collection<? extends org.apache.wicket.Component> getComponents()  
      org.apache.wicket.markup.head.IHeaderResponse getHeaderResponse()  
      org.apache.wicket.request.ILogData getLogData()  
      org.apache.wicket.Page getPage()  
      java.lang.Class<? extends org.apache.wicket.request.component.IRequestablePage> getPageClass()  
      java.lang.Integer getPageId()  
      org.apache.wicket.request.mapper.parameter.PageParameters getPageParameters()  
      java.lang.Integer getRenderCount()  
      boolean isPageInstanceCreated()  
      void prependJavaScript​(java.lang.CharSequence javascript)  
      void push​(byte[] message, int offset, int length)
      Pushes a binary message to the client.
      void push​(java.lang.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​(org.apache.wicket.Component component,
                               IWebSocketConnection connection)

    • Method Detail

      • push

        public void push​(java.lang.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​(org.apache.wicket.Component component,
                java.lang.String markupId)
        Specified by:
        add in interface org.apache.wicket.core.request.handler.IPartialPageRequestHandler

      • add

        public void add​(org.apache.wicket.Component... components)
        Specified by:
        add in interface org.apache.wicket.core.request.handler.IPartialPageRequestHandler

      • addChildren

        public final void addChildren​(org.apache.wicket.MarkupContainer parent,
                              java.lang.Class<?> childCriteria)
        Specified by:
        addChildren in interface org.apache.wicket.core.request.handler.IPartialPageRequestHandler

      • appendJavaScript

        public void appendJavaScript​(java.lang.CharSequence javascript)
        Specified by:
        appendJavaScript in interface org.apache.wicket.core.request.handler.IPartialPageRequestHandler

      • prependJavaScript

        public void prependJavaScript​(java.lang.CharSequence javascript)
        Specified by:
        prependJavaScript in interface org.apache.wicket.core.request.handler.IPartialPageRequestHandler

      • getComponents

        public java.util.Collection<? extends org.apache.wicket.Component> getComponents()
        Specified by:
        getComponents in interface org.apache.wicket.core.request.handler.IPartialPageRequestHandler

      • focusComponent

        public final void focusComponent​(org.apache.wicket.Component component)
        Specified by:
        focusComponent in interface org.apache.wicket.core.request.handler.IPartialPageRequestHandler

      • getHeaderResponse

        public org.apache.wicket.markup.head.IHeaderResponse getHeaderResponse()
        Specified by:
        getHeaderResponse in interface org.apache.wicket.core.request.handler.IPartialPageRequestHandler

      • getPage

        public org.apache.wicket.Page getPage()
        Specified by:
        getPage in interface org.apache.wicket.core.request.handler.IPageRequestHandler

      • getPageId

        public java.lang.Integer getPageId()
        Specified by:
        getPageId in interface org.apache.wicket.core.request.handler.IPageRequestHandler

      • isPageInstanceCreated

        public boolean isPageInstanceCreated()
        Specified by:
        isPageInstanceCreated in interface org.apache.wicket.core.request.handler.IPageRequestHandler

      • getRenderCount

        public java.lang.Integer getRenderCount()
        Specified by:
        getRenderCount in interface org.apache.wicket.core.request.handler.IPageRequestHandler

      • getLogData

        public org.apache.wicket.request.ILogData getLogData()
        Specified by:
        getLogData in interface org.apache.wicket.request.ILoggableRequestHandler

      • getPageClass

        public java.lang.Class<? extends org.apache.wicket.request.component.IRequestablePage> getPageClass()
        Specified by:
        getPageClass in interface org.apache.wicket.core.request.handler.IPageClassRequestHandler

      • getPageParameters

        public org.apache.wicket.request.mapper.parameter.PageParameters getPageParameters()
        Specified by:
        getPageParameters in interface org.apache.wicket.core.request.handler.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