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