Package org.apache.taglibs.standard.tag.common.core

Class ImportSupport

java.lang.Object
jakarta.servlet.jsp.tagext.TagSupport
jakarta.servlet.jsp.tagext.BodyTagSupport
org.apache.taglibs.standard.tag.common.core.ImportSupport
All Implemented Interfaces:
BodyTag, IterationTag, JspTag, Tag, TryCatchFinally, Serializable, ParamParent
Direct Known Subclasses:
ImportTag, ImportTag
public abstract class ImportSupport extends BodyTagSupport implements TryCatchFinally, ParamParent

Support for tag handlers for <import>, the general-purpose text-importing mechanism for JSTL 1.0. The rtexprvalue and expression- evaluating libraries each have handlers that extend this class.

Author:
Shawn Bayern
See Also:

  • Field Details

    • VALID_SCHEME_CHARS

      public static final String VALID_SCHEME_CHARS

      Valid characters in a scheme.

      RFC 1738 says the following:

      Scheme names consist of a sequence of characters. The lower case letters "a"--"z", digits, and the characters plus ("+"), period ("."), and hyphen ("-") are allowed. For resiliency, programs interpreting URLs should treat upper case letters as equivalent to lower case in scheme names (e.g., allow "HTTP" as well as "http").

      We treat as absolute any URL that begins with such a scheme name, followed by a colon.

      See Also:

    • DEFAULT_ENCODING

      public static final String DEFAULT_ENCODING
      Default character encoding for response.
      See Also:

    • url

      protected String url

    • context

      protected String context

    • charEncoding

      protected String charEncoding

  • Constructor Details

    • ImportSupport

      public ImportSupport()

  • Method Details

    • doStartTag

      public int doStartTag() throws JspException
      Description copied from class: BodyTagSupport
      Default processing of the start tag returning EVAL_BODY_BUFFERED.
      Specified by:
      doStartTag in interface Tag
      Overrides:
      doStartTag in class BodyTagSupport
      Returns:
      EVAL_BODY_BUFFERED
      Throws:
      JspException - if an error occurred while processing this tag
      See Also:

    • doEndTag

      public int doEndTag() throws JspException
      Description copied from class: BodyTagSupport
      Default processing of the end tag returning EVAL_PAGE.
      Specified by:
      doEndTag in interface Tag
      Overrides:
      doEndTag in class BodyTagSupport
      Returns:
      EVAL_PAGE
      Throws:
      JspException - if an error occurred while processing this tag
      See Also:

    • doCatch

      public void doCatch(Throwable t) throws Throwable
      Description copied from interface: TryCatchFinally
      Invoked if a Throwable occurs while evaluating the BODY inside a tag or in any of the following methods: Tag.doStartTag(), Tag.doEndTag(), IterationTag.doAfterBody() and BodyTag.doInitBody().

      This method is not invoked if the Throwable occurs during one of the setter methods.

      This method may throw an exception (the same or a new one) that will be propagated further up the nest chain. If an exception is thrown, doFinally() will be invoked.

      This method is intended to be used to respond to an exceptional condition.

      Specified by:
      doCatch in interface TryCatchFinally
      Parameters:
      t - The throwable exception navigating through this tag.
      Throws:
      Throwable - if the exception is to be rethrown further up the nest chain.

    • doFinally

      public void doFinally()
      Description copied from interface: TryCatchFinally
      Invoked in all cases after doEndTag() for any class implementing Tag, IterationTag or BodyTag. This method is invoked even if an exception has occurred in the BODY of the tag, or in any of the following methods: Tag.doStartTag(), Tag.doEndTag(), IterationTag.doAfterBody() and BodyTag.doInitBody().

      This method is not invoked if the Throwable occurs during one of the setter methods.

      This method should not throw an Exception.

      This method is intended to maintain per-invocation data integrity and resource management actions.

      Specified by:
      doFinally in interface TryCatchFinally

    • release

      public void release()
      Description copied from class: BodyTagSupport
      Release state.
      Specified by:
      release in interface Tag
      Overrides:
      release in class BodyTagSupport
      See Also:

    • setVar

      public void setVar(String var)

    • setVarReader

      public void setVarReader(String varReader)

    • setScope

      public void setScope(String scope)

    • addParameter

      public void addParameter(String name, String value)
      Description copied from interface: ParamParent
      Adds a parameter to this tag's URL. The intent is that the <param> subtag will call this to register URL parameters. Assumes that 'name' and 'value' are appropriately encoded and do not contain any meaningful metacharacters; in order words, escaping is the responsibility of the caller.
      Specified by:
      addParameter in interface ParamParent
      See Also:

    • isAbsoluteUrl

      public static boolean isAbsoluteUrl(String url)
      Returns true if our current URL is absolute, false otherwise.

    • stripSession

      public static String stripSession(String url)
      Strips a servlet session ID from url. The session ID is encoded as a URL "path parameter" beginning with "jsessionid=". We thus remove anything we find between ";jsessionid=" (inclusive) and either EOS or a subsequent ';' (exclusive).