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