PrincipalTag (Apache Shiro :: Web 1.9.1 API)

java.lang.Object
- javax.servlet.jsp.tagext.TagSupport
- - org.apache.shiro.web.tags.SecureTag
  - - org.apache.shiro.web.tags.PrincipalTag

All Implemented Interfaces:

Serializable, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag
```
public class PrincipalTag
extends SecureTag
```
Tag used to print out the String value of a user's default principal, or a specific principal as specified by the tag's attributes.

If no attributes are specified, the tag prints out the toString() value of the user's default principal. If the type attribute is specified, the tag looks for a principal with the given type. If the property attribute is specified, the tag prints the string value of the specified property of the principal. If no principal is found or the user is not authenticated, the tag displays nothing unless a defaultValue is specified.

Since:

0.2

See Also:

Serialized Form

Field Summary
- Fields inherited from class javax.servlet.jsp.tagext.TagSupport
  id, pageContext
- Fields inherited from interface javax.servlet.jsp.tagext.IterationTag
  EVAL_BODY_AGAIN
- Fields inherited from interface javax.servlet.jsp.tagext.Tag
  EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

Constructor Summary

Constructors
Constructor Description

PrincipalTag()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getDefaultValue()`
`String`	`getProperty()`
`String`	`getType()`
`int`	`onDoStartTag()`
`void`	`setDefaultValue(String defaultValue)`
`void`	`setProperty(String property)`
`void`	`setType(String type)`

Methods inherited from class org.apache.shiro.web.tags.SecureTag
doStartTag, getSubject, verifyAttributes

Methods inherited from class javax.servlet.jsp.tagext.TagSupport
doAfterBody, doEndTag, findAncestorWithClass, getId, getParent, getValue, getValues, release, removeValue, setId, setPageContext, setParent, setValue

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- PrincipalTag
```
public PrincipalTag()
```

Method Detail

getType
```
public String getType()
```

setType
```
public void setType(String type)
```

getProperty
```
public String getProperty()
```

setProperty

public void setProperty(String property)

getDefaultValue
```
public String getDefaultValue()
```

setDefaultValue

public void setDefaultValue(String defaultValue)

onDoStartTag
```
public int onDoStartTag()
                 throws javax.servlet.jsp.JspException
```
Specified by:

onDoStartTag in class SecureTag

Throws:

javax.servlet.jsp.JspException