Package com.inductiveautomation.ignition.gateway.servlets

Class LaunchServlet

java.lang.Object
jakarta.servlet.GenericServlet
jakarta.servlet.http.HttpServlet
com.inductiveautomation.ignition.gateway.servlets.LaunchServlet
All Implemented Interfaces:
jakarta.servlet.Servlet, jakarta.servlet.ServletConfig, Serializable
public abstract class LaunchServlet extends jakarta.servlet.http.HttpServlet
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    protected static final class 
    LaunchServlet.MissingGatewayAddressException
     

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected GatewayContext
    context
     
    protected static final com.inductiveautomation.ignition.common.gson.Gson
    GSON
     

    Fields inherited from class jakarta.servlet.http.HttpServlet

    LEGACY_DO_HEAD

  • Constructor Summary

    Constructors
    Constructor
    Description
    LaunchServlet()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    doGet(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
     
    protected String
    getAddress(boolean insecureRequest)
     
    protected abstract LoggerEx
    getLogger()
     
    void
    init()
     
    protected void
    sendErrorSafely(LoggerEx logger, jakarta.servlet.http.HttpServletResponse response, int responseCode, String message)
     
    protected abstract void
    sendLatestResponse(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
    Method is called after checks for correct launcherAPIVersions are performed and should write the JSON response for the request.
    protected void
    sendLegacyResponses(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
    Deprecated.
    Used to send "legacy" responses for requests that are older than v4.
    protected void
    sendVersion4Response(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
    Deprecated.
    Used to send responses for requests that still need to be served for launcherAPIVersion 4 requests

    Methods inherited from class jakarta.servlet.http.HttpServlet

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

    Methods inherited from class jakarta.servlet.GenericServlet

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

    Methods inherited from class java.lang.Object

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

  • Field Details

    • GSON

      protected static final com.inductiveautomation.ignition.common.gson.Gson GSON

    • context

      protected GatewayContext context

  • Constructor Details

    • LaunchServlet

      public LaunchServlet()

  • Method Details

    • init

      public void init()
      Overrides:
      init in class jakarta.servlet.GenericServlet

    • doGet

      protected void doGet(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
      Overrides:
      doGet in class jakarta.servlet.http.HttpServlet

    • sendErrorSafely

      protected void sendErrorSafely(LoggerEx logger, jakarta.servlet.http.HttpServletResponse response, int responseCode, String message)

    • sendLatestResponse

      protected abstract void sendLatestResponse(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
      Method is called after checks for correct launcherAPIVersions are performed and should write the JSON response for the request. Implementor is responsible for closing after writing.

    • sendVersion4Response

      @Deprecated(since="8.3.0") protected void sendVersion4Response(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
      Deprecated.
      Used to send responses for requests that still need to be served for launcherAPIVersion 4 requests

    • sendLegacyResponses

      @Deprecated(since="8.3.0") protected void sendLegacyResponses(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
      Deprecated.
      Used to send "legacy" responses for requests that are older than v4.

    • getAddress

      protected String getAddress(boolean insecureRequest) throws LaunchServlet.MissingGatewayAddressException
      Throws:
      LaunchServlet.MissingGatewayAddressException

    • getLogger

      protected abstract LoggerEx getLogger()