blob: 1d113f31b975e7f95189342f0fa5214e0be7b559 [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">package org.apache.archiva.redback.rbac;</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"> * Copyright 2001-2006 The Apache Software Foundation.</a>
<span class="sourceLineNo">005</span><a id="line.5"> *</a>
<span class="sourceLineNo">006</span><a id="line.6"> * Licensed under the Apache License, Version 2.0 (the "License");</a>
<span class="sourceLineNo">007</span><a id="line.7"> * you may not use this file except in compliance with the License.</a>
<span class="sourceLineNo">008</span><a id="line.8"> * 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, software</a>
<span class="sourceLineNo">013</span><a id="line.13"> * distributed under the License is distributed on an "AS IS" BASIS,</a>
<span class="sourceLineNo">014</span><a id="line.14"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</a>
<span class="sourceLineNo">015</span><a id="line.15"> * See the License for the specific language governing permissions and</a>
<span class="sourceLineNo">016</span><a id="line.16"> * limitations under the License.</a>
<span class="sourceLineNo">017</span><a id="line.17"> */</a>
<span class="sourceLineNo">018</span><a id="line.18"></a>
<span class="sourceLineNo">019</span><a id="line.19">import java.io.Serializable;</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"> * Permission</a>
<span class="sourceLineNo">023</span><a id="line.23"> *</a>
<span class="sourceLineNo">024</span><a id="line.24"> * A permission is the wrapper for an operation and a resource effectively saying</a>
<span class="sourceLineNo">025</span><a id="line.25"> * that the operation is authorized for that resource.</a>
<span class="sourceLineNo">026</span><a id="line.26"> *</a>
<span class="sourceLineNo">027</span><a id="line.27"> * P(Operation, Resource)</a>
<span class="sourceLineNo">028</span><a id="line.28"> *</a>
<span class="sourceLineNo">029</span><a id="line.29"> * @author Jesse McConnell</a>
<span class="sourceLineNo">030</span><a id="line.30"> * @author &lt;a href="mailto:joakim@erdfelt.com"&gt;Joakim Erdfelt&lt;/a&gt;</a>
<span class="sourceLineNo">031</span><a id="line.31"> *</a>
<span class="sourceLineNo">032</span><a id="line.32"> */</a>
<span class="sourceLineNo">033</span><a id="line.33">public interface Permission extends Serializable</a>
<span class="sourceLineNo">034</span><a id="line.34">{</a>
<span class="sourceLineNo">035</span><a id="line.35"></a>
<span class="sourceLineNo">036</span><a id="line.36"> /**</a>
<span class="sourceLineNo">037</span><a id="line.37"> * Long description of the Permission</a>
<span class="sourceLineNo">038</span><a id="line.38"> */</a>
<span class="sourceLineNo">039</span><a id="line.39"> String getDescription();</a>
<span class="sourceLineNo">040</span><a id="line.40"></a>
<span class="sourceLineNo">041</span><a id="line.41"> /**</a>
<span class="sourceLineNo">042</span><a id="line.42"> * Get the short name of the permission.</a>
<span class="sourceLineNo">043</span><a id="line.43"> *</a>
<span class="sourceLineNo">044</span><a id="line.44"> * NOTE: This field is considered the Primary Key for this object.</a>
<span class="sourceLineNo">045</span><a id="line.45"> *</a>
<span class="sourceLineNo">046</span><a id="line.46"> * @return the short name for this permission.</a>
<span class="sourceLineNo">047</span><a id="line.47"> */</a>
<span class="sourceLineNo">048</span><a id="line.48"> String getName();</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"> * Operation that this permission is authorizing</a>
<span class="sourceLineNo">052</span><a id="line.52"> */</a>
<span class="sourceLineNo">053</span><a id="line.53"> Operation getOperation();</a>
<span class="sourceLineNo">054</span><a id="line.54"></a>
<span class="sourceLineNo">055</span><a id="line.55"> /**</a>
<span class="sourceLineNo">056</span><a id="line.56"> * This is the resource associated with this permission.</a>
<span class="sourceLineNo">057</span><a id="line.57"> *</a>
<span class="sourceLineNo">058</span><a id="line.58"> * Implementors must always supply a Resource.</a>
<span class="sourceLineNo">059</span><a id="line.59"> *</a>
<span class="sourceLineNo">060</span><a id="line.60"> * @return the Resource.</a>
<span class="sourceLineNo">061</span><a id="line.61"> */</a>
<span class="sourceLineNo">062</span><a id="line.62"> Resource getResource();</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"> * Set null</a>
<span class="sourceLineNo">066</span><a id="line.66"> *</a>
<span class="sourceLineNo">067</span><a id="line.67"> * @param description</a>
<span class="sourceLineNo">068</span><a id="line.68"> */</a>
<span class="sourceLineNo">069</span><a id="line.69"> void setDescription( String description );</a>
<span class="sourceLineNo">070</span><a id="line.70"></a>
<span class="sourceLineNo">071</span><a id="line.71"> /**</a>
<span class="sourceLineNo">072</span><a id="line.72"> * Set the short name for this permission.</a>
<span class="sourceLineNo">073</span><a id="line.73"> *</a>
<span class="sourceLineNo">074</span><a id="line.74"> * @param name</a>
<span class="sourceLineNo">075</span><a id="line.75"> */</a>
<span class="sourceLineNo">076</span><a id="line.76"> void setName( String name );</a>
<span class="sourceLineNo">077</span><a id="line.77"></a>
<span class="sourceLineNo">078</span><a id="line.78"> /**</a>
<span class="sourceLineNo">079</span><a id="line.79"> * Set null</a>
<span class="sourceLineNo">080</span><a id="line.80"> *</a>
<span class="sourceLineNo">081</span><a id="line.81"> * @param operation</a>
<span class="sourceLineNo">082</span><a id="line.82"> */</a>
<span class="sourceLineNo">083</span><a id="line.83"> void setOperation( Operation operation );</a>
<span class="sourceLineNo">084</span><a id="line.84"></a>
<span class="sourceLineNo">085</span><a id="line.85"> /**</a>
<span class="sourceLineNo">086</span><a id="line.86"> * @param resource</a>
<span class="sourceLineNo">087</span><a id="line.87"> */</a>
<span class="sourceLineNo">088</span><a id="line.88"> void setResource( Resource resource );</a>
<span class="sourceLineNo">089</span><a id="line.89"></a>
<span class="sourceLineNo">090</span><a id="line.90"> /**</a>
<span class="sourceLineNo">091</span><a id="line.91"> * Test to see if the object is a permanent object or not.</a>
<span class="sourceLineNo">092</span><a id="line.92"> *</a>
<span class="sourceLineNo">093</span><a id="line.93"> * @return true if the object is permanent.</a>
<span class="sourceLineNo">094</span><a id="line.94"> */</a>
<span class="sourceLineNo">095</span><a id="line.95"> boolean isPermanent();</a>
<span class="sourceLineNo">096</span><a id="line.96"></a>
<span class="sourceLineNo">097</span><a id="line.97"> /**</a>
<span class="sourceLineNo">098</span><a id="line.98"> * Set flag indicating if the object is a permanent object or not.</a>
<span class="sourceLineNo">099</span><a id="line.99"> *</a>
<span class="sourceLineNo">100</span><a id="line.100"> * @param permanent true if the object is permanent.</a>
<span class="sourceLineNo">101</span><a id="line.101"> */</a>
<span class="sourceLineNo">102</span><a id="line.102"> void setPermanent( boolean permanent );</a>
<span class="sourceLineNo">103</span><a id="line.103">}</a>
</pre>
</div>
</main>
</body>
</html>