Class IfConnectionValueTag

  • All Implemented Interfaces:, javax.servlet.jsp.tagext.BodyTag, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag

    public class IfConnectionValueTag
    extends AbstractIfTag
    MicroStrategy Web 7.3.1 or earlier
    See Also:
    Serialized Form
    • Field Summary

      • Fields inherited from class javax.servlet.jsp.tagext.BodyTagSupport

      • Fields inherited from class javax.servlet.jsp.tagext.TagSupport

        id, pageContext
      • Fields inherited from interface javax.servlet.jsp.tagext.BodyTag

      • Fields inherited from interface javax.servlet.jsp.tagext.IterationTag

      • Fields inherited from interface javax.servlet.jsp.tagext.Tag

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      AbstractIfTagHelper getHelper()
      Method for retrieving the helper associated with the tag.
      void release()
      Utility method for cleaning up the properties on the custom tag instance.
      void setProperty​(java.lang.String value)
      Indicates the property value that shall be retrieved from the current connection information.
      void setValue​(java.lang.String value)
      Indicates the value to use for comparing it against the information returned by the indicated property.
      • Methods inherited from class javax.servlet.jsp.tagext.BodyTagSupport

        doAfterBody, doInitBody, getBodyContent, getPreviousOut, setBodyContent
      • Methods inherited from class javax.servlet.jsp.tagext.TagSupport

        findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValue
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • Methods inherited from interface javax.servlet.jsp.tagext.Tag

        getParent, setPageContext, setParent
    • Constructor Detail

      • IfConnectionValueTag

        public IfConnectionValueTag()
    • Method Detail

      • release

        public void release()
        Utility method for cleaning up the properties on the custom tag instance.
        Specified by:
        release in interface javax.servlet.jsp.tagext.Tag
        release in class javax.servlet.jsp.tagext.BodyTagSupport
      • setProperty

        public void setProperty​(java.lang.String value)
        Indicates the property value that shall be retrieved from the current connection information.
        There's a predefined set of possible properties that can be asked for using this custom tag, which currently include serverVersion, authenticationMode, xmlAPIVersion, JVMVendor, JVMVersion, serverName, projectID, projectName, serverPort, userName, clientID, locale, loginFirst, userID . If no property is specifed, the task of the custom tag will be to verify if there's a current session opened for the user or not. If a property is specified, the task of the custom tag is verify the value of current connection information agains the value given. If the value is not specified, or it is empty, task of the custom tag is to verify the existance of the property. The following properties can be used:
      • serverVersion
      • xmlAPIVersion
      • JVMVendor
      • JVMVersion
      • serverName
      • projectID
      • projectName
      • projectAlias
      • serverPort
      • userName
      • clientID
      • locale
      • loginFirst Note: value attribute will be ignored for this property.
      • authenticationMode
      • userID
value - String with the name of the property to evaluate.