Class IfConnectionValueTag
- java.lang.Object
-
- javax.servlet.jsp.tagext.TagSupport
-
- javax.servlet.jsp.tagext.BodyTagSupport
-
- com.microstrategy.web.app.taglibs.AbstractIfTag
-
- com.microstrategy.web.app.taglibs.IfConnectionValueTag
-
- All Implemented Interfaces:
java.io.Serializable
,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
- Since:
- MicroStrategy Web 7.3.1 or earlier
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description IfConnectionValueTag()
-
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 com.microstrategy.web.app.taglibs.AbstractIfTag
doEndTag, doStartTag, getCondition
-
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
-
-
-
-
Method Detail
-
release
public void release()
Utility method for cleaning up the properties on the custom tag instance.- Specified by:
release
in interfacejavax.servlet.jsp.tagext.Tag
- Overrides:
release
in classjavax.servlet.jsp.tagext.BodyTagSupport
-
getHelper
public AbstractIfTagHelper getHelper()
Method for retrieving the helper associated with the tag.- Specified by:
getHelper
in classAbstractIfTag
- Returns:
- an instance from
AbstractIfTagHelper
which will take care of processing and rendering the HTML contents associated with this tag.
-
setProperty
public void setProperty(java.lang.String value)
Indicates the property value that shall be retrieved from the current connection information.
Usage:
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
- Parameters:
value
-String
with the name of the property to evaluate.
-
setValue
public void setValue(java.lang.String value)
Indicates the value to use for comparing it against the information returned by the indicated property.
Usage:
The value indicated here will be compared against the one retrieved from the requested property. If this attribute is not specified, then the task of the custom tag will be limited to just determining if there's a value (different fromnull
or an empty string) assigned to the requested property.- Parameters:
value
-String
with the value to use for comparing it against the property information retrieved.
-
-