blob: 5e9082e55011ee08438728b9efc18e56b873a617 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>package org.apache.archiva.redback.rbac;<a name="line.1"></a>
<span class="sourceLineNo">002</span><a name="line.2"></a>
<span class="sourceLineNo">003</span>/*<a name="line.3"></a>
<span class="sourceLineNo">004</span> * Copyright 2001-2006 The Apache Software Foundation.<a name="line.4"></a>
<span class="sourceLineNo">005</span> *<a name="line.5"></a>
<span class="sourceLineNo">006</span> * Licensed under the Apache License, Version 2.0 (the "License");<a name="line.6"></a>
<span class="sourceLineNo">007</span> * you may not use this file except in compliance with the License.<a name="line.7"></a>
<span class="sourceLineNo">008</span> * You may obtain a copy of the License at<a name="line.8"></a>
<span class="sourceLineNo">009</span> *<a name="line.9"></a>
<span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<span class="sourceLineNo">011</span> *<a name="line.11"></a>
<span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing, software<a name="line.12"></a>
<span class="sourceLineNo">013</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.13"></a>
<span class="sourceLineNo">014</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.14"></a>
<span class="sourceLineNo">015</span> * See the License for the specific language governing permissions and<a name="line.15"></a>
<span class="sourceLineNo">016</span> * limitations under the License.<a name="line.16"></a>
<span class="sourceLineNo">017</span> */<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>/**<a name="line.19"></a>
<span class="sourceLineNo">020</span> * Resource<a name="line.20"></a>
<span class="sourceLineNo">021</span> *<a name="line.21"></a>
<span class="sourceLineNo">022</span> * Resources are things that can be paired up with operations inside of a<a name="line.22"></a>
<span class="sourceLineNo">023</span> * permission.<a name="line.23"></a>
<span class="sourceLineNo">024</span> *<a name="line.24"></a>
<span class="sourceLineNo">025</span> * Rbac doesn't strictly specify what a resource (or Object) is, so there are a<a name="line.25"></a>
<span class="sourceLineNo">026</span> * couple of variations planned for resources.<a name="line.26"></a>
<span class="sourceLineNo">027</span> *<a name="line.27"></a>
<span class="sourceLineNo">028</span> * Initially the resource is simply a string representaton of whatever you desire<a name="line.28"></a>
<span class="sourceLineNo">029</span> * to match up to an operation. Eventually we want to support different types of<a name="line.29"></a>
<span class="sourceLineNo">030</span> * expression evaluation for these resources, like a tuple resource. *-* where<a name="line.30"></a>
<span class="sourceLineNo">031</span> * wildcards can be used on the resource definition to streamline the assigning of<a name="line.31"></a>
<span class="sourceLineNo">032</span> * permissions for _large_ sets of things.<a name="line.32"></a>
<span class="sourceLineNo">033</span> *<a name="line.33"></a>
<span class="sourceLineNo">034</span> * @author Jesse McConnell<a name="line.34"></a>
<span class="sourceLineNo">035</span> * @author &lt;a href="mailto:joakim@erdfelt.com"&gt;Joakim Erdfelt&lt;/a&gt;<a name="line.35"></a>
<span class="sourceLineNo">036</span> *<a name="line.36"></a>
<span class="sourceLineNo">037</span> */<a name="line.37"></a>
<span class="sourceLineNo">038</span>public interface Resource<a name="line.38"></a>
<span class="sourceLineNo">039</span>{<a name="line.39"></a>
<span class="sourceLineNo">040</span> /**<a name="line.40"></a>
<span class="sourceLineNo">041</span> * Resource identifier refering to all objects.<a name="line.41"></a>
<span class="sourceLineNo">042</span> */<a name="line.42"></a>
<span class="sourceLineNo">043</span> public static final String GLOBAL = "*";<a name="line.43"></a>
<span class="sourceLineNo">044</span><a name="line.44"></a>
<span class="sourceLineNo">045</span> /**<a name="line.45"></a>
<span class="sourceLineNo">046</span> * Resource identifier refering to no objects.<a name="line.46"></a>
<span class="sourceLineNo">047</span> */<a name="line.47"></a>
<span class="sourceLineNo">048</span> public static final String NULL = "-";<a name="line.48"></a>
<span class="sourceLineNo">049</span><a name="line.49"></a>
<span class="sourceLineNo">050</span> /**<a name="line.50"></a>
<span class="sourceLineNo">051</span> * Get The string identifier for an operation.<a name="line.51"></a>
<span class="sourceLineNo">052</span> *<a name="line.52"></a>
<span class="sourceLineNo">053</span> * NOTE: This field is considered the Primary Key for this object.<a name="line.53"></a>
<span class="sourceLineNo">054</span> */<a name="line.54"></a>
<span class="sourceLineNo">055</span> public String getIdentifier();<a name="line.55"></a>
<span class="sourceLineNo">056</span><a name="line.56"></a>
<span class="sourceLineNo">057</span> /**<a name="line.57"></a>
<span class="sourceLineNo">058</span> * true if the identifer is a pattern that is to be evaluated, for<a name="line.58"></a>
<span class="sourceLineNo">059</span> * example x.* could match x.a or x.b and x.** could match x.foo<a name="line.59"></a>
<span class="sourceLineNo">060</span> *<a name="line.60"></a>
<span class="sourceLineNo">061</span> * Jesse: See {@link #setPattern(boolean)}<a name="line.61"></a>
<span class="sourceLineNo">062</span> *<a name="line.62"></a>
<span class="sourceLineNo">063</span> */<a name="line.63"></a>
<span class="sourceLineNo">064</span> public boolean isPattern();<a name="line.64"></a>
<span class="sourceLineNo">065</span><a name="line.65"></a>
<span class="sourceLineNo">066</span> /**<a name="line.66"></a>
<span class="sourceLineNo">067</span> * Set The string identifier for an operation.<a name="line.67"></a>
<span class="sourceLineNo">068</span> *<a name="line.68"></a>
<span class="sourceLineNo">069</span> * NOTE: This field is considered the Primary Key for this object.<a name="line.69"></a>
<span class="sourceLineNo">070</span> * <a name="line.70"></a>
<span class="sourceLineNo">071</span> * @param identifier<a name="line.71"></a>
<span class="sourceLineNo">072</span> */<a name="line.72"></a>
<span class="sourceLineNo">073</span> public void setIdentifier( String identifier );<a name="line.73"></a>
<span class="sourceLineNo">074</span><a name="line.74"></a>
<span class="sourceLineNo">075</span> /**<a name="line.75"></a>
<span class="sourceLineNo">076</span> * true if the identifer is a pattern that is to be evaluated, for<a name="line.76"></a>
<span class="sourceLineNo">077</span> * example x.* could match x.a or x.b and x.** could match x.foo<a name="line.77"></a>
<span class="sourceLineNo">078</span> *<a name="line.78"></a>
<span class="sourceLineNo">079</span> * TODO is this even a good idea?<a name="line.79"></a>
<span class="sourceLineNo">080</span> * TODO we could look for a character like '*' or a string starting with "%/" to indicate if this is a pattern or not.<a name="line.80"></a>
<span class="sourceLineNo">081</span> * <a name="line.81"></a>
<span class="sourceLineNo">082</span> * @param pattern<a name="line.82"></a>
<span class="sourceLineNo">083</span> */<a name="line.83"></a>
<span class="sourceLineNo">084</span> public void setPattern( boolean pattern );<a name="line.84"></a>
<span class="sourceLineNo">085</span><a name="line.85"></a>
<span class="sourceLineNo">086</span> /**<a name="line.86"></a>
<span class="sourceLineNo">087</span> * Test to see if the object is a permanent object or not.<a name="line.87"></a>
<span class="sourceLineNo">088</span> * <a name="line.88"></a>
<span class="sourceLineNo">089</span> * @return true if the object is permanent.<a name="line.89"></a>
<span class="sourceLineNo">090</span> */<a name="line.90"></a>
<span class="sourceLineNo">091</span> public boolean isPermanent();<a name="line.91"></a>
<span class="sourceLineNo">092</span><a name="line.92"></a>
<span class="sourceLineNo">093</span> /**<a name="line.93"></a>
<span class="sourceLineNo">094</span> * Set flag indicating if the object is a permanent object or not.<a name="line.94"></a>
<span class="sourceLineNo">095</span> * <a name="line.95"></a>
<span class="sourceLineNo">096</span> * @param permanent true if the object is permanent.<a name="line.96"></a>
<span class="sourceLineNo">097</span> */<a name="line.97"></a>
<span class="sourceLineNo">098</span> public void setPermanent( boolean permanent );<a name="line.98"></a>
<span class="sourceLineNo">099</span>}<a name="line.99"></a>
</pre>
</div>
</body>
</html>