Package com.inductiveautomation.perspective.gateway.comm

Class PerspectiveWebSocketServlet

java.lang.Object
javax.servlet.GenericServlet
javax.servlet.http.HttpServlet
org.eclipse.jetty.websocket.server.JettyWebSocketServlet
com.inductiveautomation.perspective.gateway.comm.PerspectiveWebSocketServlet
All Implemented Interfaces:
Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig
public class PerspectiveWebSocketServlet extends org.eclipse.jetty.websocket.server.JettyWebSocketServlet
Mounts a websocket servlet for use by the Perspective module. It is mounted during the module startup via the GatewayHook. The websocket is mounted at /main/system/pws, and the URL it expects to receive is: for a client: /pws/C/project_name/project_version/tab_id for a designer: /pws/D
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    PERMESSAGE_DEFLATE_DISABLE
    System property key which may be used to disable the websocket's support of the 'permessage-deflate' extension, a value generally provided by modern browsers as part of the HttpHeader.SEC_WEBSOCKET_EXTENSIONS header.

  • Constructor Summary

    Constructors
    Constructor
    Description
    PerspectiveWebSocketServlet()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    configure(org.eclipse.jetty.websocket.server.JettyWebSocketServletFactory factory)
     

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

    init, service

    Methods inherited from class javax.servlet.http.HttpServlet

    doDelete, doGet, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service

    Methods inherited from class javax.servlet.GenericServlet

    destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

    Methods inherited from class java.lang.Object

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

  • Field Details

    • PERMESSAGE_DEFLATE_DISABLE

      public static final String PERMESSAGE_DEFLATE_DISABLE
      System property key which may be used to disable the websocket's support of the 'permessage-deflate' extension, a value generally provided by modern browsers as part of the HttpHeader.SEC_WEBSOCKET_EXTENSIONS header. Setting a system property value of 'true' will remove support and may enable proxy/firewall support in systems lacking support compressed-frame forwarding, such as some versions of Microsoft IIS ARR based rewriting proxy servers.
      See Also:

  • Constructor Details

    • PerspectiveWebSocketServlet

      public PerspectiveWebSocketServlet()

  • Method Details

    • configure

      public void configure(org.eclipse.jetty.websocket.server.JettyWebSocketServletFactory factory)
      Specified by:
      configure in class org.eclipse.jetty.websocket.server.JettyWebSocketServlet