Google Git
Sign in
apache / shiro-site / 01016f43374d9b054f3ea1e568b015d5d69428f9 / . / src / site / assets / static / 1.6.0 / apidocs / src-html / org / apache / shiro / web / tags / PrincipalTag.html
blob: 3c4271e7b4d0695b9e2c34f97d60815aabb85deb [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
<main role="main">
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span><a id="line.1">/*</a>
<span class="sourceLineNo">002</span><a id="line.2"> * Licensed to the Apache Software Foundation (ASF) under one</a>
<span class="sourceLineNo">003</span><a id="line.3"> * or more contributor license agreements. See the NOTICE file</a>
<span class="sourceLineNo">004</span><a id="line.4"> * distributed with this work for additional information</a>
<span class="sourceLineNo">005</span><a id="line.5"> * regarding copyright ownership. The ASF licenses this file</a>
<span class="sourceLineNo">006</span><a id="line.6"> * to you under the Apache License, Version 2.0 (the</a>
<span class="sourceLineNo">007</span><a id="line.7"> * "License"); you may not use this file except in compliance</a>
<span class="sourceLineNo">008</span><a id="line.8"> * with the License. You may obtain a copy of the License at</a>
<span class="sourceLineNo">009</span><a id="line.9"> *</a>
<span class="sourceLineNo">010</span><a id="line.10"> * http://www.apache.org/licenses/LICENSE-2.0</a>
<span class="sourceLineNo">011</span><a id="line.11"> *</a>
<span class="sourceLineNo">012</span><a id="line.12"> * Unless required by applicable law or agreed to in writing,</a>
<span class="sourceLineNo">013</span><a id="line.13"> * software distributed under the License is distributed on an</a>
<span class="sourceLineNo">014</span><a id="line.14"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</a>
<span class="sourceLineNo">015</span><a id="line.15"> * KIND, either express or implied. See the License for the</a>
<span class="sourceLineNo">016</span><a id="line.16"> * specific language governing permissions and limitations</a>
<span class="sourceLineNo">017</span><a id="line.17"> * under the License.</a>
<span class="sourceLineNo">018</span><a id="line.18"> */</a>
<span class="sourceLineNo">019</span><a id="line.19">package org.apache.shiro.web.tags;</a>
<span class="sourceLineNo">020</span><a id="line.20"></a>
<span class="sourceLineNo">021</span><a id="line.21">import java.beans.BeanInfo;</a>
<span class="sourceLineNo">022</span><a id="line.22">import java.beans.Introspector;</a>
<span class="sourceLineNo">023</span><a id="line.23">import java.beans.PropertyDescriptor;</a>
<span class="sourceLineNo">024</span><a id="line.24">import java.io.IOException;</a>
<span class="sourceLineNo">025</span><a id="line.25">import javax.servlet.jsp.JspException;</a>
<span class="sourceLineNo">026</span><a id="line.26">import javax.servlet.jsp.JspTagException;</a>
<span class="sourceLineNo">027</span><a id="line.27"></a>
<span class="sourceLineNo">028</span><a id="line.28">import org.slf4j.Logger;</a>
<span class="sourceLineNo">029</span><a id="line.29">import org.slf4j.LoggerFactory;</a>
<span class="sourceLineNo">030</span><a id="line.30"></a>
<span class="sourceLineNo">031</span><a id="line.31">/**</a>
<span class="sourceLineNo">032</span><a id="line.32"> * &lt;p&gt;Tag used to print out the String value of a user's default principal,</a>
<span class="sourceLineNo">033</span><a id="line.33"> * or a specific principal as specified by the tag's attributes.&lt;/p&gt;</a>
<span class="sourceLineNo">034</span><a id="line.34"> *</a>
<span class="sourceLineNo">035</span><a id="line.35"> * &lt;p&gt; If no attributes are specified, the tag prints out the &lt;tt&gt;toString()&lt;/tt&gt;</a>
<span class="sourceLineNo">036</span><a id="line.36"> * value of the user's default principal. If the &lt;tt&gt;type&lt;/tt&gt; attribute</a>
<span class="sourceLineNo">037</span><a id="line.37"> * is specified, the tag looks for a principal with the given type. If the</a>
<span class="sourceLineNo">038</span><a id="line.38"> * &lt;tt&gt;property&lt;/tt&gt; attribute is specified, the tag prints the string value of</a>
<span class="sourceLineNo">039</span><a id="line.39"> * the specified property of the principal. If no principal is found or the user</a>
<span class="sourceLineNo">040</span><a id="line.40"> * is not authenticated, the tag displays nothing unless a &lt;tt&gt;defaultValue&lt;/tt&gt;</a>
<span class="sourceLineNo">041</span><a id="line.41"> * is specified.&lt;/p&gt;</a>
<span class="sourceLineNo">042</span><a id="line.42"> *</a>
<span class="sourceLineNo">043</span><a id="line.43"> * @since 0.2</a>
<span class="sourceLineNo">044</span><a id="line.44"> */</a>
<span class="sourceLineNo">045</span><a id="line.45">public class PrincipalTag extends SecureTag {</a>
<span class="sourceLineNo">046</span><a id="line.46"></a>
<span class="sourceLineNo">047</span><a id="line.47"> //TODO - complete JavaDoc</a>
<span class="sourceLineNo">048</span><a id="line.48"></a>
<span class="sourceLineNo">049</span><a id="line.49"> /*--------------------------------------------</a>
<span class="sourceLineNo">050</span><a id="line.50"> | C O N S T A N T S |</a>
<span class="sourceLineNo">051</span><a id="line.51"> ============================================*/</a>
<span class="sourceLineNo">052</span><a id="line.52"></a>
<span class="sourceLineNo">053</span><a id="line.53"> /*--------------------------------------------</a>
<span class="sourceLineNo">054</span><a id="line.54"> | I N S T A N C E V A R I A B L E S |</a>
<span class="sourceLineNo">055</span><a id="line.55"> ============================================*/</a>
<span class="sourceLineNo">056</span><a id="line.56"> private static final Logger log = LoggerFactory.getLogger(PrincipalTag.class);</a>
<span class="sourceLineNo">057</span><a id="line.57"></a>
<span class="sourceLineNo">058</span><a id="line.58"> /**</a>
<span class="sourceLineNo">059</span><a id="line.59"> * The type of principal to be retrieved, or null if the default principal should be used.</a>
<span class="sourceLineNo">060</span><a id="line.60"> */</a>
<span class="sourceLineNo">061</span><a id="line.61"> private String type;</a>
<span class="sourceLineNo">062</span><a id="line.62"></a>
<span class="sourceLineNo">063</span><a id="line.63"> /**</a>
<span class="sourceLineNo">064</span><a id="line.64"> * The property name to retrieve of the principal, or null if the &lt;tt&gt;toString()&lt;/tt&gt; value should be used.</a>
<span class="sourceLineNo">065</span><a id="line.65"> */</a>
<span class="sourceLineNo">066</span><a id="line.66"> private String property;</a>
<span class="sourceLineNo">067</span><a id="line.67"></a>
<span class="sourceLineNo">068</span><a id="line.68"> /**</a>
<span class="sourceLineNo">069</span><a id="line.69"> * The default value that should be displayed if the user is not authenticated, or no principal is found.</a>
<span class="sourceLineNo">070</span><a id="line.70"> */</a>
<span class="sourceLineNo">071</span><a id="line.71"> private String defaultValue;</a>
<span class="sourceLineNo">072</span><a id="line.72"></a>
<span class="sourceLineNo">073</span><a id="line.73"> /*--------------------------------------------</a>
<span class="sourceLineNo">074</span><a id="line.74"> | C O N S T R U C T O R S |</a>
<span class="sourceLineNo">075</span><a id="line.75"> ============================================*/</a>
<span class="sourceLineNo">076</span><a id="line.76"></a>
<span class="sourceLineNo">077</span><a id="line.77"> /*--------------------------------------------</a>
<span class="sourceLineNo">078</span><a id="line.78"> | A C C E S S O R S / M O D I F I E R S |</a>
<span class="sourceLineNo">079</span><a id="line.79"> ============================================*/</a>
<span class="sourceLineNo">080</span><a id="line.80"></a>
<span class="sourceLineNo">081</span><a id="line.81"></a>
<span class="sourceLineNo">082</span><a id="line.82"> public String getType() {</a>
<span class="sourceLineNo">083</span><a id="line.83"> return type;</a>
<span class="sourceLineNo">084</span><a id="line.84"> }</a>
<span class="sourceLineNo">085</span><a id="line.85"></a>
<span class="sourceLineNo">086</span><a id="line.86"></a>
<span class="sourceLineNo">087</span><a id="line.87"> public void setType(String type) {</a>
<span class="sourceLineNo">088</span><a id="line.88"> this.type = type;</a>
<span class="sourceLineNo">089</span><a id="line.89"> }</a>
<span class="sourceLineNo">090</span><a id="line.90"></a>
<span class="sourceLineNo">091</span><a id="line.91"></a>
<span class="sourceLineNo">092</span><a id="line.92"> public String getProperty() {</a>
<span class="sourceLineNo">093</span><a id="line.93"> return property;</a>
<span class="sourceLineNo">094</span><a id="line.94"> }</a>
<span class="sourceLineNo">095</span><a id="line.95"></a>
<span class="sourceLineNo">096</span><a id="line.96"></a>
<span class="sourceLineNo">097</span><a id="line.97"> public void setProperty(String property) {</a>
<span class="sourceLineNo">098</span><a id="line.98"> this.property = property;</a>
<span class="sourceLineNo">099</span><a id="line.99"> }</a>
<span class="sourceLineNo">100</span><a id="line.100"></a>
<span class="sourceLineNo">101</span><a id="line.101"></a>
<span class="sourceLineNo">102</span><a id="line.102"> public String getDefaultValue() {</a>
<span class="sourceLineNo">103</span><a id="line.103"> return defaultValue;</a>
<span class="sourceLineNo">104</span><a id="line.104"> }</a>
<span class="sourceLineNo">105</span><a id="line.105"></a>
<span class="sourceLineNo">106</span><a id="line.106"></a>
<span class="sourceLineNo">107</span><a id="line.107"> public void setDefaultValue(String defaultValue) {</a>
<span class="sourceLineNo">108</span><a id="line.108"> this.defaultValue = defaultValue;</a>
<span class="sourceLineNo">109</span><a id="line.109"> }</a>
<span class="sourceLineNo">110</span><a id="line.110"></a>
<span class="sourceLineNo">111</span><a id="line.111"> /*--------------------------------------------</a>
<span class="sourceLineNo">112</span><a id="line.112"> | M E T H O D S |</a>
<span class="sourceLineNo">113</span><a id="line.113"> ============================================*/</a>
<span class="sourceLineNo">114</span><a id="line.114"></a>
<span class="sourceLineNo">115</span><a id="line.115"></a>
<span class="sourceLineNo">116</span><a id="line.116"> @SuppressWarnings({"unchecked"})</a>
<span class="sourceLineNo">117</span><a id="line.117"> public int onDoStartTag() throws JspException {</a>
<span class="sourceLineNo">118</span><a id="line.118"> String strValue = null;</a>
<span class="sourceLineNo">119</span><a id="line.119"></a>
<span class="sourceLineNo">120</span><a id="line.120"> if (getSubject() != null) {</a>
<span class="sourceLineNo">121</span><a id="line.121"></a>
<span class="sourceLineNo">122</span><a id="line.122"> // Get the principal to print out</a>
<span class="sourceLineNo">123</span><a id="line.123"> Object principal;</a>
<span class="sourceLineNo">124</span><a id="line.124"></a>
<span class="sourceLineNo">125</span><a id="line.125"> if (type == null) {</a>
<span class="sourceLineNo">126</span><a id="line.126"> principal = getSubject().getPrincipal();</a>
<span class="sourceLineNo">127</span><a id="line.127"> } else {</a>
<span class="sourceLineNo">128</span><a id="line.128"> principal = getPrincipalFromClassName();</a>
<span class="sourceLineNo">129</span><a id="line.129"> }</a>
<span class="sourceLineNo">130</span><a id="line.130"></a>
<span class="sourceLineNo">131</span><a id="line.131"> // Get the string value of the principal</a>
<span class="sourceLineNo">132</span><a id="line.132"> if (principal != null) {</a>
<span class="sourceLineNo">133</span><a id="line.133"> if (property == null) {</a>
<span class="sourceLineNo">134</span><a id="line.134"> strValue = principal.toString();</a>
<span class="sourceLineNo">135</span><a id="line.135"> } else {</a>
<span class="sourceLineNo">136</span><a id="line.136"> strValue = getPrincipalProperty(principal, property);</a>
<span class="sourceLineNo">137</span><a id="line.137"> }</a>
<span class="sourceLineNo">138</span><a id="line.138"> }</a>
<span class="sourceLineNo">139</span><a id="line.139"></a>
<span class="sourceLineNo">140</span><a id="line.140"> }</a>
<span class="sourceLineNo">141</span><a id="line.141"></a>
<span class="sourceLineNo">142</span><a id="line.142"> // Print out the principal value if not null</a>
<span class="sourceLineNo">143</span><a id="line.143"> if (strValue != null) {</a>
<span class="sourceLineNo">144</span><a id="line.144"> try {</a>
<span class="sourceLineNo">145</span><a id="line.145"> pageContext.getOut().write(strValue);</a>
<span class="sourceLineNo">146</span><a id="line.146"> } catch (IOException e) {</a>
<span class="sourceLineNo">147</span><a id="line.147"> throw new JspTagException("Error writing [" + strValue + "] to JSP.", e);</a>
<span class="sourceLineNo">148</span><a id="line.148"> }</a>
<span class="sourceLineNo">149</span><a id="line.149"> }</a>
<span class="sourceLineNo">150</span><a id="line.150"></a>
<span class="sourceLineNo">151</span><a id="line.151"> return SKIP_BODY;</a>
<span class="sourceLineNo">152</span><a id="line.152"> }</a>
<span class="sourceLineNo">153</span><a id="line.153"></a>
<span class="sourceLineNo">154</span><a id="line.154"> @SuppressWarnings({"unchecked"})</a>
<span class="sourceLineNo">155</span><a id="line.155"> private Object getPrincipalFromClassName() {</a>
<span class="sourceLineNo">156</span><a id="line.156"> Object principal = null;</a>
<span class="sourceLineNo">157</span><a id="line.157"></a>
<span class="sourceLineNo">158</span><a id="line.158"> try {</a>
<span class="sourceLineNo">159</span><a id="line.159"> Class cls = Class.forName(type);</a>
<span class="sourceLineNo">160</span><a id="line.160"> principal = getSubject().getPrincipals().oneByType(cls);</a>
<span class="sourceLineNo">161</span><a id="line.161"> } catch (ClassNotFoundException e) {</a>
<span class="sourceLineNo">162</span><a id="line.162"> if (log.isErrorEnabled()) {</a>
<span class="sourceLineNo">163</span><a id="line.163"> log.error("Unable to find class for name [" + type + "]");</a>
<span class="sourceLineNo">164</span><a id="line.164"> }</a>
<span class="sourceLineNo">165</span><a id="line.165"> }</a>
<span class="sourceLineNo">166</span><a id="line.166"> return principal;</a>
<span class="sourceLineNo">167</span><a id="line.167"> }</a>
<span class="sourceLineNo">168</span><a id="line.168"></a>
<span class="sourceLineNo">169</span><a id="line.169"></a>
<span class="sourceLineNo">170</span><a id="line.170"> private String getPrincipalProperty(Object principal, String property) throws JspTagException {</a>
<span class="sourceLineNo">171</span><a id="line.171"> String strValue = null;</a>
<span class="sourceLineNo">172</span><a id="line.172"></a>
<span class="sourceLineNo">173</span><a id="line.173"> try {</a>
<span class="sourceLineNo">174</span><a id="line.174"> BeanInfo bi = Introspector.getBeanInfo(principal.getClass());</a>
<span class="sourceLineNo">175</span><a id="line.175"></a>
<span class="sourceLineNo">176</span><a id="line.176"> // Loop through the properties to get the string value of the specified property</a>
<span class="sourceLineNo">177</span><a id="line.177"> boolean foundProperty = false;</a>
<span class="sourceLineNo">178</span><a id="line.178"> for (PropertyDescriptor pd : bi.getPropertyDescriptors()) {</a>
<span class="sourceLineNo">179</span><a id="line.179"> if (pd.getName().equals(property)) {</a>
<span class="sourceLineNo">180</span><a id="line.180"> Object value = pd.getReadMethod().invoke(principal, (Object[]) null);</a>
<span class="sourceLineNo">181</span><a id="line.181"> strValue = String.valueOf(value);</a>
<span class="sourceLineNo">182</span><a id="line.182"> foundProperty = true;</a>
<span class="sourceLineNo">183</span><a id="line.183"> break;</a>
<span class="sourceLineNo">184</span><a id="line.184"> }</a>
<span class="sourceLineNo">185</span><a id="line.185"> }</a>
<span class="sourceLineNo">186</span><a id="line.186"></a>
<span class="sourceLineNo">187</span><a id="line.187"> if (!foundProperty) {</a>
<span class="sourceLineNo">188</span><a id="line.188"> final String message = "Property [" + property + "] not found in principal of type [" + principal.getClass().getName() + "]";</a>
<span class="sourceLineNo">189</span><a id="line.189"> if (log.isErrorEnabled()) {</a>
<span class="sourceLineNo">190</span><a id="line.190"> log.error(message);</a>
<span class="sourceLineNo">191</span><a id="line.191"> }</a>
<span class="sourceLineNo">192</span><a id="line.192"> throw new JspTagException(message);</a>
<span class="sourceLineNo">193</span><a id="line.193"> }</a>
<span class="sourceLineNo">194</span><a id="line.194"></a>
<span class="sourceLineNo">195</span><a id="line.195"> } catch (Exception e) {</a>
<span class="sourceLineNo">196</span><a id="line.196"> final String message = "Error reading property [" + property + "] from principal of type [" + principal.getClass().getName() + "]";</a>
<span class="sourceLineNo">197</span><a id="line.197"> if (log.isErrorEnabled()) {</a>
<span class="sourceLineNo">198</span><a id="line.198"> log.error(message, e);</a>
<span class="sourceLineNo">199</span><a id="line.199"> }</a>
<span class="sourceLineNo">200</span><a id="line.200"> throw new JspTagException(message, e);</a>
<span class="sourceLineNo">201</span><a id="line.201"> }</a>
<span class="sourceLineNo">202</span><a id="line.202"></a>
<span class="sourceLineNo">203</span><a id="line.203"> return strValue;</a>
<span class="sourceLineNo">204</span><a id="line.204"> }</a>
<span class="sourceLineNo">205</span><a id="line.205">}</a>
</pre>
</div>
</main>
</body>
</html>