blob: bcabbd04e610838303d5380b887b48fca7809e57 [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 javax.servlet.jsp.JspException;<a name="line.21"></a>
<span class="sourceLineNo">022</span><a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.slf4j.Logger;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.slf4j.LoggerFactory;<a name="line.24"></a>
<span class="sourceLineNo">025</span><a name="line.25"></a>
<span class="sourceLineNo">026</span><a name="line.26"></a>
<span class="sourceLineNo">027</span>/**<a name="line.27"></a>
<span class="sourceLineNo">028</span> * JSP tag that renders the tag body if the current user known to the system, either from a successful login attempt<a name="line.28"></a>
<span class="sourceLineNo">029</span> * (not necessarily during the current session) or from 'RememberMe' services.<a name="line.29"></a>
<span class="sourceLineNo">030</span> *<a name="line.30"></a>
<span class="sourceLineNo">031</span> * &lt;p&gt;&lt;b&gt;Note:&lt;/b&gt; This is &lt;em&gt;less&lt;/em&gt; restrictive than the &lt;code&gt;AuthenticatedTag&lt;/code&gt; since it only assumes<a name="line.31"></a>
<span class="sourceLineNo">032</span> * the user is who they say they are, either via a current session login &lt;em&gt;or&lt;/em&gt; via Remember Me services, which<a name="line.32"></a>
<span class="sourceLineNo">033</span> * makes no guarantee the user is who they say they are. The &lt;code&gt;AuthenticatedTag&lt;/code&gt; however<a name="line.33"></a>
<span class="sourceLineNo">034</span> * guarantees that the current user has logged in &lt;em&gt;during their current session&lt;/em&gt;, proving they really are<a name="line.34"></a>
<span class="sourceLineNo">035</span> * who they say they are.<a name="line.35"></a>
<span class="sourceLineNo">036</span> *<a name="line.36"></a>
<span class="sourceLineNo">037</span> * &lt;p&gt;The logically opposite tag of this one is the {@link org.apache.shiro.web.tags.GuestTag}.<a name="line.37"></a>
<span class="sourceLineNo">038</span> *<a name="line.38"></a>
<span class="sourceLineNo">039</span> * @since 0.9<a name="line.39"></a>
<span class="sourceLineNo">040</span> */<a name="line.40"></a>
<span class="sourceLineNo">041</span>public class UserTag extends SecureTag {<a name="line.41"></a>
<span class="sourceLineNo">042</span><a name="line.42"></a>
<span class="sourceLineNo">043</span> //TODO - complete JavaDoc<a name="line.43"></a>
<span class="sourceLineNo">044</span><a name="line.44"></a>
<span class="sourceLineNo">045</span> private static final Logger log = LoggerFactory.getLogger(UserTag.class);<a name="line.45"></a>
<span class="sourceLineNo">046</span><a name="line.46"></a>
<span class="sourceLineNo">047</span> public int onDoStartTag() throws JspException {<a name="line.47"></a>
<span class="sourceLineNo">048</span> if (getSubject() != null &amp;&amp; getSubject().getPrincipal() != null) {<a name="line.48"></a>
<span class="sourceLineNo">049</span> if (log.isTraceEnabled()) {<a name="line.49"></a>
<span class="sourceLineNo">050</span> log.trace("Subject has known identity (aka 'principal'). " +<a name="line.50"></a>
<span class="sourceLineNo">051</span> "Tag body will be evaluated.");<a name="line.51"></a>
<span class="sourceLineNo">052</span> }<a name="line.52"></a>
<span class="sourceLineNo">053</span> return EVAL_BODY_INCLUDE;<a name="line.53"></a>
<span class="sourceLineNo">054</span> } else {<a name="line.54"></a>
<span class="sourceLineNo">055</span> if (log.isTraceEnabled()) {<a name="line.55"></a>
<span class="sourceLineNo">056</span> log.trace("Subject does not exist or have a known identity (aka 'principal'). " +<a name="line.56"></a>
<span class="sourceLineNo">057</span> "Tag body will not be evaluated.");<a name="line.57"></a>
<span class="sourceLineNo">058</span> }<a name="line.58"></a>
<span class="sourceLineNo">059</span> return SKIP_BODY;<a name="line.59"></a>
<span class="sourceLineNo">060</span> }<a name="line.60"></a>
<span class="sourceLineNo">061</span> }<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>
</pre>
</div>
</body>
</html>