| <!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"> * <p></a> |
| <span class="sourceLineNo">028</span><a id="line.28"> * Requires the current executor's Subject to imply a particular permission in</a> |
| <span class="sourceLineNo">029</span><a id="line.29"> * order to execute the annotated method. If the executor's associated</a> |
| <span class="sourceLineNo">030</span><a id="line.30"> * {@link org.apache.shiro.subject.Subject Subject} determines that the</a> |
| <span class="sourceLineNo">031</span><a id="line.31"> * executor does not imply the specified permission, the method will not be executed.</a> |
| <span class="sourceLineNo">032</span><a id="line.32"> * </p></a> |
| <span class="sourceLineNo">033</span><a id="line.33"> *</a> |
| <span class="sourceLineNo">034</span><a id="line.34"> * <p>For example, this declaration:</a> |
| <span class="sourceLineNo">035</span><a id="line.35"> * <p/></a> |
| <span class="sourceLineNo">036</span><a id="line.36"> * <code>&#64;RequiresPermissions( {"file:read", "write:aFile.txt"} )<br/></a> |
| <span class="sourceLineNo">037</span><a id="line.37"> * void someMethod();</code></a> |
| <span class="sourceLineNo">038</span><a id="line.38"> * <p/></a> |
| <span class="sourceLineNo">039</span><a id="line.39"> * indicates the current user must be able to both <tt>read</tt> and <tt>write</tt></a> |
| <span class="sourceLineNo">040</span><a id="line.40"> * to the file <tt>aFile.txt</tt> in order for the <tt>someMethod()</tt> to execute, otherwise</a> |
| <span class="sourceLineNo">041</span><a id="line.41"> * an {@link org.apache.shiro.authz.AuthorizationException AuthorizationException} will be thrown.</a> |
| <span class="sourceLineNo">042</span><a id="line.42"> *</a> |
| <span class="sourceLineNo">043</span><a id="line.43"> * @see org.apache.shiro.subject.Subject#checkPermission</a> |
| <span class="sourceLineNo">044</span><a id="line.44"> * @since 0.1</a> |
| <span class="sourceLineNo">045</span><a id="line.45"> */</a> |
| <span class="sourceLineNo">046</span><a id="line.46">@Target({ElementType.TYPE, ElementType.METHOD})</a> |
| <span class="sourceLineNo">047</span><a id="line.47">@Retention(RetentionPolicy.RUNTIME)</a> |
| <span class="sourceLineNo">048</span><a id="line.48">public @interface RequiresPermissions {</a> |
| <span class="sourceLineNo">049</span><a id="line.49"></a> |
| <span class="sourceLineNo">050</span><a id="line.50"> /**</a> |
| <span class="sourceLineNo">051</span><a id="line.51"> * The permission string which will be passed to {@link org.apache.shiro.subject.Subject#isPermitted(String)}</a> |
| <span class="sourceLineNo">052</span><a id="line.52"> * to determine if the user is allowed to invoke the code protected by this annotation.</a> |
| <span class="sourceLineNo">053</span><a id="line.53"> */</a> |
| <span class="sourceLineNo">054</span><a id="line.54"> String[] value();</a> |
| <span class="sourceLineNo">055</span><a id="line.55"> </a> |
| <span class="sourceLineNo">056</span><a id="line.56"> /**</a> |
| <span class="sourceLineNo">057</span><a id="line.57"> * The logical operation for the permission checks in case multiple roles are specified. AND is the default</a> |
| <span class="sourceLineNo">058</span><a id="line.58"> * @since 1.1.0</a> |
| <span class="sourceLineNo">059</span><a id="line.59"> */</a> |
| <span class="sourceLineNo">060</span><a id="line.60"> Logical logical() default Logical.AND; </a> |
| <span class="sourceLineNo">061</span><a id="line.61"></a> |
| <span class="sourceLineNo">062</span><a id="line.62">}</a> |
| <span class="sourceLineNo">063</span><a id="line.63"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
