| <!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"> * Resource</a> |
| <span class="sourceLineNo">023</span><a id="line.23"> *</a> |
| <span class="sourceLineNo">024</span><a id="line.24"> * Resources are things that can be paired up with operations inside of a</a> |
| <span class="sourceLineNo">025</span><a id="line.25"> * permission.</a> |
| <span class="sourceLineNo">026</span><a id="line.26"> *</a> |
| <span class="sourceLineNo">027</span><a id="line.27"> * Rbac doesn't strictly specify what a resource (or Object) is, so there are a</a> |
| <span class="sourceLineNo">028</span><a id="line.28"> * couple of variations planned for resources.</a> |
| <span class="sourceLineNo">029</span><a id="line.29"> *</a> |
| <span class="sourceLineNo">030</span><a id="line.30"> * Initially the resource is simply a string representaton of whatever you desire</a> |
| <span class="sourceLineNo">031</span><a id="line.31"> * to match up to an operation. Eventually we want to support different types of</a> |
| <span class="sourceLineNo">032</span><a id="line.32"> * expression evaluation for these resources, like a tuple resource. *-* where</a> |
| <span class="sourceLineNo">033</span><a id="line.33"> * wildcards can be used on the resource definition to streamline the assigning of</a> |
| <span class="sourceLineNo">034</span><a id="line.34"> * permissions for _large_ sets of things.</a> |
| <span class="sourceLineNo">035</span><a id="line.35"> *</a> |
| <span class="sourceLineNo">036</span><a id="line.36"> * The <code>GLOBAL</code> resource is a catch-all for all resource strings.</a> |
| <span class="sourceLineNo">037</span><a id="line.37"> *</a> |
| <span class="sourceLineNo">038</span><a id="line.38"> * @author Jesse McConnell</a> |
| <span class="sourceLineNo">039</span><a id="line.39"> * @author <a href="mailto:joakim@erdfelt.com">Joakim Erdfelt</a></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">public interface Resource extends Serializable</a> |
| <span class="sourceLineNo">043</span><a id="line.43">{</a> |
| <span class="sourceLineNo">044</span><a id="line.44"> /**</a> |
| <span class="sourceLineNo">045</span><a id="line.45"> * Resource identifier refering to all objects.</a> |
| <span class="sourceLineNo">046</span><a id="line.46"> */</a> |
| <span class="sourceLineNo">047</span><a id="line.47"> public static final String GLOBAL = "*";</a> |
| <span class="sourceLineNo">048</span><a id="line.48"></a> |
| <span class="sourceLineNo">049</span><a id="line.49"> /**</a> |
| <span class="sourceLineNo">050</span><a id="line.50"> * Resource identifier refering to no objects.</a> |
| <span class="sourceLineNo">051</span><a id="line.51"> */</a> |
| <span class="sourceLineNo">052</span><a id="line.52"> public static final String NULL = "-";</a> |
| <span class="sourceLineNo">053</span><a id="line.53"></a> |
| <span class="sourceLineNo">054</span><a id="line.54"> /**</a> |
| <span class="sourceLineNo">055</span><a id="line.55"> * Get The string identifier for an operation.</a> |
| <span class="sourceLineNo">056</span><a id="line.56"> *</a> |
| <span class="sourceLineNo">057</span><a id="line.57"> * NOTE: This field is considered the Primary Key for this object.</a> |
| <span class="sourceLineNo">058</span><a id="line.58"> */</a> |
| <span class="sourceLineNo">059</span><a id="line.59"> public String getIdentifier();</a> |
| <span class="sourceLineNo">060</span><a id="line.60"></a> |
| <span class="sourceLineNo">061</span><a id="line.61"> /**</a> |
| <span class="sourceLineNo">062</span><a id="line.62"> * true if the identifer is a pattern that is to be evaluated, for</a> |
| <span class="sourceLineNo">063</span><a id="line.63"> * example x.* could match x.a or x.b and x.** could match x.foo</a> |
| <span class="sourceLineNo">064</span><a id="line.64"> *</a> |
| <span class="sourceLineNo">065</span><a id="line.65"> * Jesse: See {@link #setPattern(boolean)}</a> |
| <span class="sourceLineNo">066</span><a id="line.66"> *</a> |
| <span class="sourceLineNo">067</span><a id="line.67"> */</a> |
| <span class="sourceLineNo">068</span><a id="line.68"> public boolean isPattern();</a> |
| <span class="sourceLineNo">069</span><a id="line.69"></a> |
| <span class="sourceLineNo">070</span><a id="line.70"> /**</a> |
| <span class="sourceLineNo">071</span><a id="line.71"> * Set The string identifier for an operation.</a> |
| <span class="sourceLineNo">072</span><a id="line.72"> *</a> |
| <span class="sourceLineNo">073</span><a id="line.73"> * NOTE: This field is considered the Primary Key for this object.</a> |
| <span class="sourceLineNo">074</span><a id="line.74"> * </a> |
| <span class="sourceLineNo">075</span><a id="line.75"> * @param identifier</a> |
| <span class="sourceLineNo">076</span><a id="line.76"> */</a> |
| <span class="sourceLineNo">077</span><a id="line.77"> public void setIdentifier( String identifier );</a> |
| <span class="sourceLineNo">078</span><a id="line.78"></a> |
| <span class="sourceLineNo">079</span><a id="line.79"> /**</a> |
| <span class="sourceLineNo">080</span><a id="line.80"> * true if the identifer is a pattern that is to be evaluated, for</a> |
| <span class="sourceLineNo">081</span><a id="line.81"> * example x.* could match x.a or x.b and x.** could match x.foo</a> |
| <span class="sourceLineNo">082</span><a id="line.82"> *</a> |
| <span class="sourceLineNo">083</span><a id="line.83"> * TODO is this even a good idea?</a> |
| <span class="sourceLineNo">084</span><a id="line.84"> * TODO we could look for a character like '*' or a string starting with "%/" to indicate if this is a pattern or not.</a> |
| <span class="sourceLineNo">085</span><a id="line.85"> * </a> |
| <span class="sourceLineNo">086</span><a id="line.86"> * @param pattern</a> |
| <span class="sourceLineNo">087</span><a id="line.87"> */</a> |
| <span class="sourceLineNo">088</span><a id="line.88"> public void setPattern( boolean pattern );</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"> public 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"> public void setPermanent( boolean permanent );</a> |
| <span class="sourceLineNo">103</span><a id="line.103">}</a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
