| <!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">package org.apache.archiva.redback.authorization;</a> |
| <span class="sourceLineNo">002</span><a id="line.2"></a> |
| <span class="sourceLineNo">003</span><a id="line.3">/*</a> |
| <span class="sourceLineNo">004</span><a id="line.4"> * Licensed to the Apache Software Foundation (ASF) under one</a> |
| <span class="sourceLineNo">005</span><a id="line.5"> * or more contributor license agreements. See the NOTICE file</a> |
| <span class="sourceLineNo">006</span><a id="line.6"> * distributed with this work for additional information</a> |
| <span class="sourceLineNo">007</span><a id="line.7"> * regarding copyright ownership. The ASF licenses this file</a> |
| <span class="sourceLineNo">008</span><a id="line.8"> * to you under the Apache License, Version 2.0 (the</a> |
| <span class="sourceLineNo">009</span><a id="line.9"> * "License"); you may not use this file except in compliance</a> |
| <span class="sourceLineNo">010</span><a id="line.10"> * with the License. You may obtain a copy of the License at</a> |
| <span class="sourceLineNo">011</span><a id="line.11"> *</a> |
| <span class="sourceLineNo">012</span><a id="line.12"> * http://www.apache.org/licenses/LICENSE-2.0</a> |
| <span class="sourceLineNo">013</span><a id="line.13"> *</a> |
| <span class="sourceLineNo">014</span><a id="line.14"> * Unless required by applicable law or agreed to in writing,</a> |
| <span class="sourceLineNo">015</span><a id="line.15"> * software distributed under the License is distributed on an</a> |
| <span class="sourceLineNo">016</span><a id="line.16"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</a> |
| <span class="sourceLineNo">017</span><a id="line.17"> * KIND, either express or implied. See the License for the</a> |
| <span class="sourceLineNo">018</span><a id="line.18"> * specific language governing permissions and limitations</a> |
| <span class="sourceLineNo">019</span><a id="line.19"> * under the License.</a> |
| <span class="sourceLineNo">020</span><a id="line.20"> */</a> |
| <span class="sourceLineNo">021</span><a id="line.21"></a> |
| <span class="sourceLineNo">022</span><a id="line.22">import java.lang.annotation.ElementType;</a> |
| <span class="sourceLineNo">023</span><a id="line.23">import java.lang.annotation.Retention;</a> |
| <span class="sourceLineNo">024</span><a id="line.24">import java.lang.annotation.RetentionPolicy;</a> |
| <span class="sourceLineNo">025</span><a id="line.25">import java.lang.annotation.Target;</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"> * Authorization annotation. The annotation can be defined for methods and describes</a> |
| <span class="sourceLineNo">029</span><a id="line.29"> * the permissions necessary to execute the method.</a> |
| <span class="sourceLineNo">030</span><a id="line.30"> *</a> |
| <span class="sourceLineNo">031</span><a id="line.31"> * @author Olivier Lamy</a> |
| <span class="sourceLineNo">032</span><a id="line.32"> * @since 1.3</a> |
| <span class="sourceLineNo">033</span><a id="line.33"> */</a> |
| <span class="sourceLineNo">034</span><a id="line.34">@Target( ElementType.METHOD )</a> |
| <span class="sourceLineNo">035</span><a id="line.35">@Retention( RetentionPolicy.RUNTIME )</a> |
| <span class="sourceLineNo">036</span><a id="line.36">public @interface RedbackAuthorization</a> |
| <span class="sourceLineNo">037</span><a id="line.37">{</a> |
| <span class="sourceLineNo">038</span><a id="line.38"></a> |
| <span class="sourceLineNo">039</span><a id="line.39"> /**</a> |
| <span class="sourceLineNo">040</span><a id="line.40"> * The list of permissions that are needed for executing the method.</a> |
| <span class="sourceLineNo">041</span><a id="line.41"> * The strings refer to defined permission ids.</a> |
| <span class="sourceLineNo">042</span><a id="line.42"> * The accessing user must have at least one of the given permissions to execute</a> |
| <span class="sourceLineNo">043</span><a id="line.43"> * the method.</a> |
| <span class="sourceLineNo">044</span><a id="line.44"> * @return the array of permission ids.</a> |
| <span class="sourceLineNo">045</span><a id="line.45"> */</a> |
| <span class="sourceLineNo">046</span><a id="line.46"> String[] permissions() default ( "" );</a> |
| <span class="sourceLineNo">047</span><a id="line.47"></a> |
| <span class="sourceLineNo">048</span><a id="line.48"> /**</a> |
| <span class="sourceLineNo">049</span><a id="line.49"> * The resource is used to restrict access by using information from</a> |
| <span class="sourceLineNo">050</span><a id="line.50"> * the method parameters or call environment.</a> |
| <span class="sourceLineNo">051</span><a id="line.51"> * Resource annotations have to be in line with the defined permissions.</a> |
| <span class="sourceLineNo">052</span><a id="line.52"> * Parameters have to be given in the form <code>{parameterName}</code> and are extracted from the URIInfo (path- and</a> |
| <span class="sourceLineNo">053</span><a id="line.53"> * query-parameters)</a> |
| <span class="sourceLineNo">054</span><a id="line.54"> * @return the redback resource karma needed</a> |
| <span class="sourceLineNo">055</span><a id="line.55"> */</a> |
| <span class="sourceLineNo">056</span><a id="line.56"> String resource() default ( "" );</a> |
| <span class="sourceLineNo">057</span><a id="line.57"></a> |
| <span class="sourceLineNo">058</span><a id="line.58"> /**</a> |
| <span class="sourceLineNo">059</span><a id="line.59"> * A description of the authorization definition.</a> |
| <span class="sourceLineNo">060</span><a id="line.60"> * @return the description string</a> |
| <span class="sourceLineNo">061</span><a id="line.61"> */</a> |
| <span class="sourceLineNo">062</span><a id="line.62"> String description() default ( "" );</a> |
| <span class="sourceLineNo">063</span><a id="line.63"></a> |
| <span class="sourceLineNo">064</span><a id="line.64"> /**</a> |
| <span class="sourceLineNo">065</span><a id="line.65"> * @return <code>true</code> if doesn't need any special permission</a> |
| <span class="sourceLineNo">066</span><a id="line.66"> */</a> |
| <span class="sourceLineNo">067</span><a id="line.67"> boolean noRestriction() default false;</a> |
| <span class="sourceLineNo">068</span><a id="line.68"></a> |
| <span class="sourceLineNo">069</span><a id="line.69"> /**</a> |
| <span class="sourceLineNo">070</span><a id="line.70"> * @return True, if this service need only authentication and not special karma</a> |
| <span class="sourceLineNo">071</span><a id="line.71"> */</a> |
| <span class="sourceLineNo">072</span><a id="line.72"> boolean noPermission() default false;</a> |
| <span class="sourceLineNo">073</span><a id="line.73">}</a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
