Module org.apache.jena.fuseki.core
Package org.apache.jena.fuseki.servlets

Class HttpAction

java.lang.Object
org.apache.jena.fuseki.servlets.HttpAction
public class HttpAction extends Object
HTTP action that represents the user request lifecycle. It is is handled in the ActionBase.executeLifecycle(HttpAction) method.

  • Field Details

    • id

      public final long id

    • verbose

      public final boolean verbose

    • category

      public final ActionCategory category

    • log

      public final org.slf4j.Logger log

    • endpoint

      public Endpoint endpoint

    • statusCode

      public int statusCode

    • message

      public String message

    • responseContentLength

      public int responseContentLength

    • responseContentType

      public String responseContentType

  • Constructor Details

    • HttpAction

      public HttpAction(long id, org.slf4j.Logger log, ActionCategory category, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
      Creates a new HTTP Action, using the HTTP request and response, and a given ID.
      Parameters:
      id - given ID
      log - Logger for this action
      request - HTTP request
      response - HTTP response

  • Method Details

    • setRequest

      public void setRequest(DataAccessPoint dataAccessPoint, DataService dService)
      Initialization after action creation, during lifecycle setup. This is "set once" (in other words, constructor-like but delayed because the information is not yet available at the point we want to create the HttpAction).

      This method sets the action dataset for service requests. Does not apply to "admin" and "ctl" servlets. Setting will replace any existing DataAccessPoint and DataService, as the DatasetGraph of the current HTTP Action.

      Once it has updated its members, the HTTP Action will change its transactional state and Transactional instance according to its base dataset graph.

      Parameters:
      dataAccessPoint - DataAccessPoint
      dService - DataService
      See Also:
      • Transactional

    • getDataset

      public org.apache.jena.sparql.core.DatasetGraph getDataset()
      Return the dataset, if any (may be null)

    • getContext

      public org.apache.jena.sparql.util.Context getContext()
      Return the Context for this HttpAction.

    • getUser

      public String getUser()
      Return the authenticated user for this HttpAction. Return null for no authenticated user.

    • getTransactional

      public org.apache.jena.sparql.core.Transactional getTransactional()
      Return the "Transactional" for this HttpAction.

    • getActionURI

      public String getActionURI()
      This is the requestURI with the context path removed. It should be used internally for dispatch.

    • getContextPath

      public String getContextPath()
      Get the context path.

    • getOperationRegistry

      public OperationRegistry getOperationRegistry()
      Get the OperationRegistry for this action.

    • getDataAccessPointRegistry

      public DataAccessPointRegistry getDataAccessPointRegistry()
      Get the DataAccessPointRegistry for this action.

    • getServletContext

      public jakarta.servlet.ServletContext getServletContext()
      Get ServletContext (may be null).

    • getMetricsProvider

      public MetricsProvider getMetricsProvider()
      Get the MetricsProvider for this action.

    • setEndpoint

      public void setEndpoint(Endpoint endpoint)
      Set the endpoint and endpoint name that this is an action for.
      Parameters:
      endpoint - Endpoint

    • getEndpoint

      public Endpoint getEndpoint()
      Get the endpoint for the action (may be null) .

    • isTransactional

      public boolean isTransactional()
      Returns whether or not the underlying DatasetGraph is fully transactional (supports rollback)

    • startRequest

      public final void startRequest()

    • finishRequest

      public final void finishRequest()

    • begin

      public void begin(org.apache.jena.query.TxnType txnType)
      Begin a transaction of any TxnType - this should be paired with an end() 
         httpAction.begin();
   try {
      work
      possible promote to write
      commit or abort (if write)
      response
   } finally { httpAction.end(); }
      Prefer one of beginRead() or beginWrite() if the action is known to be a a read or write at the start or call begin() if the transaction may promote.

    • begin

      public void begin()
      Begin a transaction - this should be paired with an end() 
         httpAction.begin();
   try {
      work
      possible promote to write
      commit or abort (if write)
      response
   } finally { httpAction.end(); }

    • beginWrite

      public void beginWrite()
      Begin a write operation - this should be paired with an endWrite() 
         httpAction.beginWrite();
   try {
      work
      commit or abort
      response
   } finally { httpAction.endWrite(); }

    • beginRead

      public void beginRead()
      Begin a read operation - this should be paired with an endRead() 
         httpAction.beginRead();
   try {
      work
      response
   } finally { httpAction.endRead(); }

    • endRead

      public void endRead()
      End a read transaction - paired with beginRead().

    • endWrite

      public void endWrite()
      End a write transaction - paired with beginWrite().

    • end

      public void end()
      End a write transaction - paired with begin() or begin(TxnType).

    • commit

      public void commit()

    • abortSilent

      public void abortSilent()
      Abort: ignore exceptions (for clearup code)

    • abort

      public void abort()

    • getActiveDSG

      public final org.apache.jena.sparql.core.DatasetGraph getActiveDSG()
      If inside the transaction for the action, return the active DatasetGraph, otherwise return null.
      Returns:
      Current active DatasetGraph

    • getDataAccessPoint

      public final DataAccessPoint getDataAccessPoint()

    • getDataService

      public final DataService getDataService()

    • getDatasetName

      public final String getDatasetName()

    • minimize

      public void minimize()
      Reduce to a size that can be kept around for sometime.

    • setStartTime

      public void setStartTime()

    • getStartTime

      public long getStartTime()
      Start time, in system nanos

    • getFinishTime

      public long getFinishTime()
      Start time, in system nanos

    • setFinishTime

      public void setFinishTime()

    • getTime

      public long getTime()
      Return the recorded time taken in milliseconds. setStartTime() and setFinishTime() must have been called.

    • sync

      public void sync()

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • getMethod

      @Deprecated(since="5.1.0", forRemoval=true) public String getMethod()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use getRequestMethod().

    • getRequest

      public jakarta.servlet.http.HttpServletRequest getRequest()

    • getResponse

      public jakarta.servlet.http.HttpServletResponse getResponse()

    • getRequestParameter

      public String getRequestParameter(String string)

    • getRequestParameterNames

      public Enumeration<String> getRequestParameterNames()

    • getRequestParameterValues

      public String[] getRequestParameterValues(String name)

    • getRequestParameterMap

      public Map<String,String[]> getRequestParameterMap()

    • getRequestMethod

      public String getRequestMethod()

    • getRequestHeaderNames

      public Enumeration<String> getRequestHeaderNames()

    • getRequestHeader

      public String getRequestHeader(String name)

    • getRequestHeaders

      public Enumeration<String> getRequestHeaders(String name)

    • getRequestContentType

      public String getRequestContentType()

    • getRequestCharacterEncoding

      public String getRequestCharacterEncoding()

    • getRequestContentLength

      public int getRequestContentLength()

    • getRequestContentLengthLong

      public long getRequestContentLengthLong()

    • getRequestInputStream

      public InputStream getRequestInputStream() throws IOException
      Throws:
      IOException

    • getRequestInputStreamRaw

      public InputStream getRequestInputStreamRaw() throws IOException
      Get the request input stream, bypassing any compression. The state of the input stream is unknown. Only useful for skipping a body on a connection.
      Throws:
      IOException

    • getRequestQueryString

      public String getRequestQueryString()

    • getRequestRequestURI

      public String getRequestRequestURI()

    • getRequestRequestURL

      public String getRequestRequestURL()

    • getRequestPathInfo

      public String getRequestPathInfo()

    • getRequestServletPath

      public String getRequestServletPath()

    • getRequestLocalPort

      public int getRequestLocalPort()

    • setResponseCharacterEncoding

      public void setResponseCharacterEncoding(String charset)

    • setResponseContentType

      public void setResponseContentType(String ct)

    • setResponseContentLength

      public void setResponseContentLength(int length)

    • setResponseContentLengthLong

      public void setResponseContentLengthLong(long length)

    • setResponseHeader

      public void setResponseHeader(String name, String value)

    • setResponseStatus

      public void setResponseStatus(int statusCode)

    • getResponseOutputStream

      public jakarta.servlet.ServletOutputStream getResponseOutputStream() throws IOException
      Throws:
      IOException

    • getResponseWriter

      public PrintWriter getResponseWriter() throws IOException
      Throws:
      IOException