blob: 95c831eaa38fef35b9f80d6e52edbaffe1711ba7 [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.authz.annotation;<a name="line.19"></a>
<span class="sourceLineNo">020</span><a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.lang.annotation.ElementType;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.lang.annotation.Retention;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.lang.annotation.RetentionPolicy;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.lang.annotation.Target;<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> * Requires the current Subject to be an application &lt;em&gt;user&lt;/em&gt; for the annotated class/instance/method to be<a name="line.27"></a>
<span class="sourceLineNo">028</span> * accessed or invoked. This is &lt;em&gt;less&lt;/em&gt; restrictive than the {@link RequiresAuthentication RequiresAuthentication}<a name="line.28"></a>
<span class="sourceLineNo">029</span> * annotation.<a name="line.29"></a>
<span class="sourceLineNo">030</span> * &lt;p/&gt;<a name="line.30"></a>
<span class="sourceLineNo">031</span> * Shiro defines a &amp;quot;user&amp;quot; as a Subject that is either<a name="line.31"></a>
<span class="sourceLineNo">032</span> * &amp;quot;remembered&amp;quot; &lt;b&gt;&lt;em&gt;or&lt;/em&gt;&lt;/b&gt; authenticated:<a name="line.32"></a>
<span class="sourceLineNo">033</span> * &lt;ul&gt;<a name="line.33"></a>
<span class="sourceLineNo">034</span> * &lt;li&gt;An &lt;b&gt;authenticated&lt;/b&gt; user is a Subject that has successfully logged in (proven their identity)<a name="line.34"></a>
<span class="sourceLineNo">035</span> * &lt;em&gt;during their current session&lt;/em&gt;.&lt;/li&gt;<a name="line.35"></a>
<span class="sourceLineNo">036</span> * &lt;li&gt;A &lt;b&gt;remembered&lt;/b&gt; user is any Subject that has proven their identity at least once, although not necessarily<a name="line.36"></a>
<span class="sourceLineNo">037</span> * during their current session, and asked the system to remember them.&lt;/li&gt;<a name="line.37"></a>
<span class="sourceLineNo">038</span> * &lt;/ul&gt;<a name="line.38"></a>
<span class="sourceLineNo">039</span> * &lt;p/&gt;<a name="line.39"></a>
<span class="sourceLineNo">040</span> * See the {@link org.apache.shiro.authc.RememberMeAuthenticationToken RememberMeAuthenticationToken} JavaDoc for an<a name="line.40"></a>
<span class="sourceLineNo">041</span> * explanation of why these two states are considered different.<a name="line.41"></a>
<span class="sourceLineNo">042</span> *<a name="line.42"></a>
<span class="sourceLineNo">043</span> * @see RequiresAuthentication<a name="line.43"></a>
<span class="sourceLineNo">044</span> * @see RequiresGuest<a name="line.44"></a>
<span class="sourceLineNo">045</span> *<a name="line.45"></a>
<span class="sourceLineNo">046</span> * @since 0.9.0<a name="line.46"></a>
<span class="sourceLineNo">047</span> */<a name="line.47"></a>
<span class="sourceLineNo">048</span>@Target({ElementType.TYPE, ElementType.METHOD})<a name="line.48"></a>
<span class="sourceLineNo">049</span>@Retention(RetentionPolicy.RUNTIME)<a name="line.49"></a>
<span class="sourceLineNo">050</span>public @interface RequiresUser {<a name="line.50"></a>
<span class="sourceLineNo">051</span>}<a name="line.51"></a>
</pre>
</div>
</body>
</html>