| <!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">import java.io.Serializable;</a> |
| <span class="sourceLineNo">004</span><a id="line.4">import java.util.List;</a> |
| <span class="sourceLineNo">005</span><a id="line.5"></a> |
| <span class="sourceLineNo">006</span><a id="line.6">/*</a> |
| <span class="sourceLineNo">007</span><a id="line.7"> * Copyright 2001-2006 The Apache Software Foundation.</a> |
| <span class="sourceLineNo">008</span><a id="line.8"> *</a> |
| <span class="sourceLineNo">009</span><a id="line.9"> * Licensed under the Apache License, Version 2.0 (the "License");</a> |
| <span class="sourceLineNo">010</span><a id="line.10"> * you may not use this file except in compliance with the License.</a> |
| <span class="sourceLineNo">011</span><a id="line.11"> * You may obtain a copy of the License at</a> |
| <span class="sourceLineNo">012</span><a id="line.12"> *</a> |
| <span class="sourceLineNo">013</span><a id="line.13"> * http://www.apache.org/licenses/LICENSE-2.0</a> |
| <span class="sourceLineNo">014</span><a id="line.14"> *</a> |
| <span class="sourceLineNo">015</span><a id="line.15"> * Unless required by applicable law or agreed to in writing, software</a> |
| <span class="sourceLineNo">016</span><a id="line.16"> * distributed under the License is distributed on an "AS IS" BASIS,</a> |
| <span class="sourceLineNo">017</span><a id="line.17"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</a> |
| <span class="sourceLineNo">018</span><a id="line.18"> * See the License for the specific language governing permissions and</a> |
| <span class="sourceLineNo">019</span><a id="line.19"> * limitations 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">/**</a> |
| <span class="sourceLineNo">023</span><a id="line.23"> * UserAssignment - This the mapping object that takes the principal for a user and associates it with a</a> |
| <span class="sourceLineNo">024</span><a id="line.24"> * set of Roles.</a> |
| <span class="sourceLineNo">025</span><a id="line.25"> * </a> |
| <span class="sourceLineNo">026</span><a id="line.26"> * This is the many to many mapping object needed by persistence stores.</a> |
| <span class="sourceLineNo">027</span><a id="line.27"> *</a> |
| <span class="sourceLineNo">028</span><a id="line.28"> * @author Jesse McConnell</a> |
| <span class="sourceLineNo">029</span><a id="line.29"> * @author <a href="mailto:joakim@erdfelt.com">Joakim Erdfelt</a></a> |
| <span class="sourceLineNo">030</span><a id="line.30"> *</a> |
| <span class="sourceLineNo">031</span><a id="line.31"> * TODO expand on javadoc</a> |
| <span class="sourceLineNo">032</span><a id="line.32"> */</a> |
| <span class="sourceLineNo">033</span><a id="line.33">public interface UserAssignment 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"> /**</a> |
| <span class="sourceLineNo">038</span><a id="line.38"> * The principal for the User that the set of roles is associated with.</a> |
| <span class="sourceLineNo">039</span><a id="line.39"> * </a> |
| <span class="sourceLineNo">040</span><a id="line.40"> * NOTE: This field is considered the Primary Key for this object.</a> |
| <span class="sourceLineNo">041</span><a id="line.41"> * </a> |
| <span class="sourceLineNo">042</span><a id="line.42"> * @return the principal for the User.</a> |
| <span class="sourceLineNo">043</span><a id="line.43"> */</a> |
| <span class="sourceLineNo">044</span><a id="line.44"> String getPrincipal();</a> |
| <span class="sourceLineNo">045</span><a id="line.45"></a> |
| <span class="sourceLineNo">046</span><a id="line.46"> /**</a> |
| <span class="sourceLineNo">047</span><a id="line.47"> * Get the roles for this user.</a> |
| <span class="sourceLineNo">048</span><a id="line.48"> * </a> |
| <span class="sourceLineNo">049</span><a id="line.49"> * @return List of &lt;{@link String}&gt; objects representing the Role Names.</a> |
| <span class="sourceLineNo">050</span><a id="line.50"> */</a> |
| <span class="sourceLineNo">051</span><a id="line.51"> List<String> getRoleNames();</a> |
| <span class="sourceLineNo">052</span><a id="line.52"></a> |
| <span class="sourceLineNo">053</span><a id="line.53"> List<String> getRoleIds();</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"> * Add a rolename to this assignment.</a> |
| <span class="sourceLineNo">057</span><a id="line.57"> * </a> |
| <span class="sourceLineNo">058</span><a id="line.58"> * @param role the role.</a> |
| <span class="sourceLineNo">059</span><a id="line.59"> */</a> |
| <span class="sourceLineNo">060</span><a id="line.60"> void addRoleName( Role role );</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"> * Add a rolename to this assignment.</a> |
| <span class="sourceLineNo">064</span><a id="line.64"> * </a> |
| <span class="sourceLineNo">065</span><a id="line.65"> * @param roleName the role name.</a> |
| <span class="sourceLineNo">066</span><a id="line.66"> */</a> |
| <span class="sourceLineNo">067</span><a id="line.67"> void addRoleName( String roleName );</a> |
| <span class="sourceLineNo">068</span><a id="line.68"></a> |
| <span class="sourceLineNo">069</span><a id="line.69"> void addRoleId( Role role );</a> |
| <span class="sourceLineNo">070</span><a id="line.70"> /**</a> |
| <span class="sourceLineNo">071</span><a id="line.71"> * Adds a role id to this assignment</a> |
| <span class="sourceLineNo">072</span><a id="line.72"> * @param roleId</a> |
| <span class="sourceLineNo">073</span><a id="line.73"> */</a> |
| <span class="sourceLineNo">074</span><a id="line.74"> void addRoleId( String roleId );</a> |
| <span class="sourceLineNo">075</span><a id="line.75"> </a> |
| <span class="sourceLineNo">076</span><a id="line.76"> /**</a> |
| <span class="sourceLineNo">077</span><a id="line.77"> * Remove a rolename from this assignment.</a> |
| <span class="sourceLineNo">078</span><a id="line.78"> * </a> |
| <span class="sourceLineNo">079</span><a id="line.79"> * @param role the role who's name is to be removed.</a> |
| <span class="sourceLineNo">080</span><a id="line.80"> */</a> |
| <span class="sourceLineNo">081</span><a id="line.81"> void removeRoleName( Role role );</a> |
| <span class="sourceLineNo">082</span><a id="line.82"> </a> |
| <span class="sourceLineNo">083</span><a id="line.83"> /**</a> |
| <span class="sourceLineNo">084</span><a id="line.84"> * Remove a role name from this assignment.</a> |
| <span class="sourceLineNo">085</span><a id="line.85"> * </a> |
| <span class="sourceLineNo">086</span><a id="line.86"> * @param roleName the role name to be removed.</a> |
| <span class="sourceLineNo">087</span><a id="line.87"> */</a> |
| <span class="sourceLineNo">088</span><a id="line.88"> void removeRoleName( String roleName );</a> |
| <span class="sourceLineNo">089</span><a id="line.89"></a> |
| <span class="sourceLineNo">090</span><a id="line.90"> void removeRoleId( Role role );</a> |
| <span class="sourceLineNo">091</span><a id="line.91"></a> |
| <span class="sourceLineNo">092</span><a id="line.92"> void removeRoleId( String roleId );</a> |
| <span class="sourceLineNo">093</span><a id="line.93"></a> |
| <span class="sourceLineNo">094</span><a id="line.94"> /**</a> |
| <span class="sourceLineNo">095</span><a id="line.95"> * Set the user principal object for this association.</a> |
| <span class="sourceLineNo">096</span><a id="line.96"> * </a> |
| <span class="sourceLineNo">097</span><a id="line.97"> * NOTE: This field is considered the Primary Key for this object.</a> |
| <span class="sourceLineNo">098</span><a id="line.98"> * </a> |
| <span class="sourceLineNo">099</span><a id="line.99"> * @param principal</a> |
| <span class="sourceLineNo">100</span><a id="line.100"> */</a> |
| <span class="sourceLineNo">101</span><a id="line.101"> void setPrincipal( String principal );</a> |
| <span class="sourceLineNo">102</span><a id="line.102"></a> |
| <span class="sourceLineNo">103</span><a id="line.103"> /**</a> |
| <span class="sourceLineNo">104</span><a id="line.104"> * Set the roles names for this user.</a> |
| <span class="sourceLineNo">105</span><a id="line.105"> * </a> |
| <span class="sourceLineNo">106</span><a id="line.106"> * @param roles the List of &lt;{@link String}&gt; objects representing the Role Names.</a> |
| <span class="sourceLineNo">107</span><a id="line.107"> */</a> |
| <span class="sourceLineNo">108</span><a id="line.108"> void setRoleNames( List<String> roles );</a> |
| <span class="sourceLineNo">109</span><a id="line.109"></a> |
| <span class="sourceLineNo">110</span><a id="line.110"> void setRoleIds( List<String> roles );</a> |
| <span class="sourceLineNo">111</span><a id="line.111"> </a> |
| <span class="sourceLineNo">112</span><a id="line.112"> /**</a> |
| <span class="sourceLineNo">113</span><a id="line.113"> * Test to see if the object is a permanent object or not.</a> |
| <span class="sourceLineNo">114</span><a id="line.114"> * </a> |
| <span class="sourceLineNo">115</span><a id="line.115"> * @return true if the object is permanent.</a> |
| <span class="sourceLineNo">116</span><a id="line.116"> */</a> |
| <span class="sourceLineNo">117</span><a id="line.117"> boolean isPermanent();</a> |
| <span class="sourceLineNo">118</span><a id="line.118"></a> |
| <span class="sourceLineNo">119</span><a id="line.119"> /**</a> |
| <span class="sourceLineNo">120</span><a id="line.120"> * Set flag indicating if the object is a permanent object or not.</a> |
| <span class="sourceLineNo">121</span><a id="line.121"> * </a> |
| <span class="sourceLineNo">122</span><a id="line.122"> * @param permanent true if the object is permanent.</a> |
| <span class="sourceLineNo">123</span><a id="line.123"> */</a> |
| <span class="sourceLineNo">124</span><a id="line.124"> void setPermanent( boolean permanent );</a> |
| <span class="sourceLineNo">125</span><a id="line.125">}</a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
