Package org.serviceconnector.web

Class SCBaseSessionServlet

java.lang.Object
jakarta.servlet.GenericServlet
jakarta.servlet.http.HttpServlet
org.serviceconnector.web.SCBaseServlet
org.serviceconnector.web.SCBaseSessionServlet
All Implemented Interfaces:
jakarta.servlet.Servlet, jakarta.servlet.ServletConfig, Serializable, org.serviceconnector.api.srv.ISCSessionServerCallback
public abstract class SCBaseSessionServlet extends SCBaseServlet implements org.serviceconnector.api.srv.ISCSessionServerCallback
The Class SCBaseSessionServlet. Base servlet for session service implementations.

User needs to extend this servlet to implement a session service. This base servlet implements ISCSessionServerCallback which gets called if client actions are processed. More information available in super class.

The urlPath passed in constructor is used by the SC to call the servlet(URL). So it must match the mapping in web.xml.
See Also:

  • Nested Class Summary

    Nested classes/interfaces inherited from class org.serviceconnector.web.SCBaseServlet

    SCBaseServlet.SCServerCallback

  • Field Summary

    Fields inherited from class org.serviceconnector.web.SCBaseServlet

    compositeRegistry, registered, requester, serviceName

    Fields inherited from class jakarta.servlet.http.HttpServlet

    LEGACY_DO_HEAD

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    SCBaseSessionServlet(String urlPath)
    Instantiates a new sC base session servlet.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    abortSession(org.serviceconnector.api.SCMessage message, int operationTimeoutMillis)
     
    protected final org.serviceconnector.scmp.SCMPMessage
    baseAbortSession(org.serviceconnector.scmp.SCMPMessage reqMessage, int operationTimeoutMillis)
    Base abort session.
    protected final org.serviceconnector.scmp.SCMPMessage
    baseCreateSession(org.serviceconnector.scmp.SCMPMessage reqMessage, int operationTimeoutMillis)
    Base create session.
    protected final org.serviceconnector.scmp.SCMPMessage
    baseDeleteSession(org.serviceconnector.scmp.SCMPMessage reqMessage, int operationTimeoutMillis)
    Base delete session.
    protected final org.serviceconnector.scmp.SCMPMessage
    baseExecute(org.serviceconnector.scmp.SCMPMessage reqMessage, int operationTimeoutMillis)
    Base execute.
    org.serviceconnector.api.SCMessage
    createSession(org.serviceconnector.api.SCMessage message, int operationTimeoutMillis)
     
    void
    deleteSession(org.serviceconnector.api.SCMessage message, int operationTimeoutMillis)
     
    void
    exceptionCaught(org.serviceconnector.api.SCServiceException ex)
     
    org.serviceconnector.api.SCMessage
    execute(org.serviceconnector.api.SCMessage message, int operationTimeoutMillis)
     

    Methods inherited from class org.serviceconnector.web.SCBaseServlet

    checkRegistration, checkRegistration, destroy, doGet, doPost, init

    Methods inherited from class jakarta.servlet.http.HttpServlet

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

    Methods inherited from class jakarta.servlet.GenericServlet

    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

  • Constructor Details

    • SCBaseSessionServlet

      protected SCBaseSessionServlet(String urlPath)
      Instantiates a new sC base session servlet.
      Parameters:
      urlPath - the URL path

  • Method Details

    • createSession

      public org.serviceconnector.api.SCMessage createSession(org.serviceconnector.api.SCMessage message, int operationTimeoutMillis)
      Specified by:
      createSession in interface org.serviceconnector.api.srv.ISCSessionServerCallback

    • deleteSession

      public void deleteSession(org.serviceconnector.api.SCMessage message, int operationTimeoutMillis)
      Specified by:
      deleteSession in interface org.serviceconnector.api.srv.ISCSessionServerCallback

    • abortSession

      public void abortSession(org.serviceconnector.api.SCMessage message, int operationTimeoutMillis)
      Specified by:
      abortSession in interface org.serviceconnector.api.srv.ISCSessionServerCallback

    • execute

      public org.serviceconnector.api.SCMessage execute(org.serviceconnector.api.SCMessage message, int operationTimeoutMillis)
      Specified by:
      execute in interface org.serviceconnector.api.srv.ISCSessionServerCallback

    • exceptionCaught

      public void exceptionCaught(org.serviceconnector.api.SCServiceException ex)
      Specified by:
      exceptionCaught in interface org.serviceconnector.api.srv.ISCSessionServerCallback

    • baseCreateSession

      protected final org.serviceconnector.scmp.SCMPMessage baseCreateSession(org.serviceconnector.scmp.SCMPMessage reqMessage, int operationTimeoutMillis)
      Base create session.
      Parameters:
      reqMessage - the req message
      operationTimeoutMillis - the operation timeout millis
      Returns:
      the sCMP message

    • baseDeleteSession

      protected final org.serviceconnector.scmp.SCMPMessage baseDeleteSession(org.serviceconnector.scmp.SCMPMessage reqMessage, int operationTimeoutMillis)
      Base delete session.
      Parameters:
      reqMessage - the req message
      operationTimeoutMillis - the operation timeout millis
      Returns:
      the sCMP message

    • baseAbortSession

      protected final org.serviceconnector.scmp.SCMPMessage baseAbortSession(org.serviceconnector.scmp.SCMPMessage reqMessage, int operationTimeoutMillis)
      Base abort session.
      Parameters:
      reqMessage - the req message
      operationTimeoutMillis - the operation timeout millis
      Returns:
      the sCMP message

    • baseExecute

      protected final org.serviceconnector.scmp.SCMPMessage baseExecute(org.serviceconnector.scmp.SCMPMessage reqMessage, int operationTimeoutMillis)
      Base execute.
      Parameters:
      reqMessage - the req message
      operationTimeoutMillis - the operation timeout millis
      Returns:
      the sCMP message