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