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