blob: ae00df778c24f4d59ef7766119c8d78b03d8a7d5 [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.authz.annotation;<a name="line.19"></a>
<FONT color="green">020</FONT> <a name="line.20"></a>
<FONT color="green">021</FONT> import java.lang.annotation.ElementType;<a name="line.21"></a>
<FONT color="green">022</FONT> import java.lang.annotation.Retention;<a name="line.22"></a>
<FONT color="green">023</FONT> import java.lang.annotation.RetentionPolicy;<a name="line.23"></a>
<FONT color="green">024</FONT> import java.lang.annotation.Target;<a name="line.24"></a>
<FONT color="green">025</FONT> <a name="line.25"></a>
<FONT color="green">026</FONT> /**<a name="line.26"></a>
<FONT color="green">027</FONT> * 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>
<FONT color="green">028</FONT> * accessed or invoked. This is &lt;em&gt;less&lt;/em&gt; restrictive than the {@link RequiresAuthentication RequiresAuthentication}<a name="line.28"></a>
<FONT color="green">029</FONT> * annotation.<a name="line.29"></a>
<FONT color="green">030</FONT> * &lt;p/&gt;<a name="line.30"></a>
<FONT color="green">031</FONT> * Shiro defines a &amp;quot;user&amp;quot; as a Subject that is either<a name="line.31"></a>
<FONT color="green">032</FONT> * &amp;quot;remembered&amp;quot; &lt;b&gt;&lt;em&gt;or&lt;/em&gt;&lt;/b&gt; authenticated:<a name="line.32"></a>
<FONT color="green">033</FONT> * &lt;ul&gt;<a name="line.33"></a>
<FONT color="green">034</FONT> * &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>
<FONT color="green">035</FONT> * &lt;em&gt;during their current session&lt;/em&gt;.&lt;/li&gt;<a name="line.35"></a>
<FONT color="green">036</FONT> * &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>
<FONT color="green">037</FONT> * during their current session, and asked the system to remember them.&lt;/li&gt;<a name="line.37"></a>
<FONT color="green">038</FONT> * &lt;/ul&gt;<a name="line.38"></a>
<FONT color="green">039</FONT> * &lt;p/&gt;<a name="line.39"></a>
<FONT color="green">040</FONT> * See the {@link org.apache.shiro.authc.RememberMeAuthenticationToken RememberMeAuthenticationToken} JavaDoc for an<a name="line.40"></a>
<FONT color="green">041</FONT> * explaination of why these two states are considered different.<a name="line.41"></a>
<FONT color="green">042</FONT> *<a name="line.42"></a>
<FONT color="green">043</FONT> * @see RequiresAuthentication<a name="line.43"></a>
<FONT color="green">044</FONT> * @see RequiresGuest<a name="line.44"></a>
<FONT color="green">045</FONT> *<a name="line.45"></a>
<FONT color="green">046</FONT> * @since 0.9.0<a name="line.46"></a>
<FONT color="green">047</FONT> */<a name="line.47"></a>
<FONT color="green">048</FONT> @Target({ElementType.TYPE, ElementType.METHOD})<a name="line.48"></a>
<FONT color="green">049</FONT> @Retention(RetentionPolicy.RUNTIME)<a name="line.49"></a>
<FONT color="green">050</FONT> public @interface RequiresUser {<a name="line.50"></a>
<FONT color="green">051</FONT> }<a name="line.51"></a>
</PRE>
</BODY>
</HTML>