Package org.springframework.security.taglibs.authz

Class AuthenticationTag

java.lang.Object
jakarta.servlet.jsp.tagext.TagSupport
org.springframework.security.taglibs.authz.AuthenticationTag
All Implemented Interfaces:
jakarta.servlet.jsp.tagext.IterationTag, jakarta.servlet.jsp.tagext.JspTag, jakarta.servlet.jsp.tagext.Tag, Serializable
public class AuthenticationTag extends jakarta.servlet.jsp.tagext.TagSupport
An Tag implementation that allows convenient access to the current Authentication object.

Whilst JSPs can access the SecurityContext directly, this tag avoids handling null conditions.

See Also:

  • Field Summary

    Fields inherited from class jakarta.servlet.jsp.tagext.TagSupport

    id, pageContext

    Fields inherited from interface jakarta.servlet.jsp.tagext.IterationTag

    EVAL_BODY_AGAIN

    Fields inherited from interface jakarta.servlet.jsp.tagext.Tag

    EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

  • Constructor Summary

    Constructors
    Constructor
    Description
    AuthenticationTag()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    doEndTag()
     
    int
    doStartTag()
     
    protected boolean
    isHtmlEscape()
    Return the HTML escaping setting for this tag, or the default setting if not overridden.
    void
    setHtmlEscape(String htmlEscape)
    Set HTML escaping for this tag, as boolean value.
    void
    setPageContext(jakarta.servlet.jsp.PageContext pageContext)
     
    void
    setProperty(String operation)
     
    void
    setScope(String scope)
     
    void
    setVar(String var)
     
    protected void
    writeMessage(String msg)
     

    Methods inherited from class jakarta.servlet.jsp.tagext.TagSupport

    doAfterBody, findAncestorWithClass, getId, getParent, getValue, getValues, release, removeValue, setId, setParent, setValue

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • AuthenticationTag

      public AuthenticationTag()

  • Method Details

    • setVar

      public void setVar(String var)

    • setProperty

      public void setProperty(String operation)

    • setScope

      public void setScope(String scope)

    • setPageContext

      public void setPageContext(jakarta.servlet.jsp.PageContext pageContext)
      Specified by:
      setPageContext in interface jakarta.servlet.jsp.tagext.Tag
      Overrides:
      setPageContext in class jakarta.servlet.jsp.tagext.TagSupport

    • doStartTag

      public int doStartTag() throws jakarta.servlet.jsp.JspException
      Specified by:
      doStartTag in interface jakarta.servlet.jsp.tagext.Tag
      Overrides:
      doStartTag in class jakarta.servlet.jsp.tagext.TagSupport
      Throws:
      jakarta.servlet.jsp.JspException

    • doEndTag

      public int doEndTag() throws jakarta.servlet.jsp.JspException
      Specified by:
      doEndTag in interface jakarta.servlet.jsp.tagext.Tag
      Overrides:
      doEndTag in class jakarta.servlet.jsp.tagext.TagSupport
      Throws:
      jakarta.servlet.jsp.JspException

    • writeMessage

      protected void writeMessage(String msg) throws jakarta.servlet.jsp.JspException
      Throws:
      jakarta.servlet.jsp.JspException

    • setHtmlEscape

      public void setHtmlEscape(String htmlEscape)
      Set HTML escaping for this tag, as boolean value.

    • isHtmlEscape

      protected boolean isHtmlEscape()
      Return the HTML escaping setting for this tag, or the default setting if not overridden.