Interface ActionContext


public interface ActionContext
Encapsulates a portion of DSP page in an object that can be invoked as many times as needed.
Author:
tomyeh
  • Field Details

  • Method Details

    • getAttribute

      Object getAttribute(String name, int scope)
      Returns the attribute of the specified scope.
      Parameters:
      scope - one of PAGE_SCOPE, REQUEST_SCOPE, SESSION_SCOPE and APPLICATION_SCOPE.
    • setAttribute

      void setAttribute(String name, Object value, int scope)
      Sets the attribute of the specified scope.
      Parameters:
      scope - one of PAGE_SCOPE, REQUEST_SCOPE, SESSION_SCOPE and APPLICATION_SCOPE.
    • removeAttribute

      void removeAttribute(String name, int scope)
      Removes the attribute of the specified scope.
      Parameters:
      scope - one of PAGE_SCOPE, REQUEST_SCOPE, SESSION_SCOPE and APPLICATION_SCOPE.
    • findAttribute

      Object findAttribute(String name)
      Finds the attribute from page, request, session to application scope
    • setContentType

      void setContentType(String ctype)
      Sets the content type.
    • getOut

      Writer getOut() throws IOException
      Returns the current output.
      Throws:
      IOException
    • getParent

      Action getParent()
      Returns the parent action, or null if no parent at all.
    • renderFragment

      void renderFragment(Writer out) throws DspException, IOException
      Renders the nested fragment.
      Parameters:
      out - the output. If null, getOut() is assumed.
      Throws:
      DspException
      IOException
    • include

      void include(String uri, Map<?,?> params) throws DspException, IOException
      Includes the specified URI and render the result to the specified output.
      Parameters:
      uri - the URI to include. It is OK to relevant (without leading '/'). If starts with "/", the context path of request is assumed. To reference to foreign context, use "~ctx/" where ctx is the context path of the foreign context (without leading '/').
      params - a map of parameters, or null to ignore. The map is passed thru the request attribute called arg.
      Throws:
      DspException
      IOException
    • isIncluded

      boolean isIncluded()
      Returns whether this page is included.
      Since:
      3.0.6
    • encodeURL

      String encodeURL(String uri) throws DspException, IOException
      Encodes the specified URI.

      In additions, if uri starts with "/", the context path, e.g., /we2, is prefixed. In other words, "/ab/cd" means it is relevant to the servlet context path (say, "/we2").

      If uri starts with "~abc/", it means it is relevant to a foreign context called /abc. And, it will be converted to "/abc/" first (without prefix request.getContextPath()).

      Finally, the uri is encoded by HttpServletResponse.encodeURL.

      Throws:
      DspException
      IOException
    • getLineNumber

      int getLineNumber()
      Returns the line number of this action. It is used for throwing exception and debug purpose.