| <!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 org.apache.commons.lang3.StringUtils;</a> |
| <span class="sourceLineNo">020</span><a id="line.20"></a> |
| <span class="sourceLineNo">021</span><a id="line.21">import java.io.Serializable;</a> |
| <span class="sourceLineNo">022</span><a id="line.22">import java.util.List;</a> |
| <span class="sourceLineNo">023</span><a id="line.23"></a> |
| <span class="sourceLineNo">024</span><a id="line.24">/**</a> |
| <span class="sourceLineNo">025</span><a id="line.25"> * Role</a> |
| <span class="sourceLineNo">026</span><a id="line.26"> *</a> |
| <span class="sourceLineNo">027</span><a id="line.27"> * A role is assignable to a user and effectively grants that user all of the</a> |
| <span class="sourceLineNo">028</span><a id="line.28"> * permissions that are present in that role. A role can also contain other roles</a> |
| <span class="sourceLineNo">029</span><a id="line.29"> * which add the permissions in those roles to the available permissions for authorization.</a> |
| <span class="sourceLineNo">030</span><a id="line.30"> *</a> |
| <span class="sourceLineNo">031</span><a id="line.31"> * A role can contain any number of permissions</a> |
| <span class="sourceLineNo">032</span><a id="line.32"> * A role can contain any number of other roles</a> |
| <span class="sourceLineNo">033</span><a id="line.33"> * A role can be assigned to any number of users</a> |
| <span class="sourceLineNo">034</span><a id="line.34"> *</a> |
| <span class="sourceLineNo">035</span><a id="line.35"> * @author Jesse McConnell</a> |
| <span class="sourceLineNo">036</span><a id="line.36"> * @author <a href="mailto:joakim@erdfelt.com">Joakim Erdfelt</a></a> |
| <span class="sourceLineNo">037</span><a id="line.37"> * @author Martin Stockhammer <martin_s@apache.org></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">public interface Role extends Serializable</a> |
| <span class="sourceLineNo">041</span><a id="line.41">{</a> |
| <span class="sourceLineNo">042</span><a id="line.42"></a> |
| <span class="sourceLineNo">043</span><a id="line.43"> /**</a> |
| <span class="sourceLineNo">044</span><a id="line.44"> * Adds a permission to the list</a> |
| <span class="sourceLineNo">045</span><a id="line.45"> *</a> |
| <span class="sourceLineNo">046</span><a id="line.46"> * @param permission the permission to add to the list</a> |
| <span class="sourceLineNo">047</span><a id="line.47"> */</a> |
| <span class="sourceLineNo">048</span><a id="line.48"> void addPermission( Permission permission );</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"> * Adds a role to the list of child roles</a> |
| <span class="sourceLineNo">052</span><a id="line.52"> *</a> |
| <span class="sourceLineNo">053</span><a id="line.53"> * @param name the name of the child role.</a> |
| <span class="sourceLineNo">054</span><a id="line.54"> */</a> |
| <span class="sourceLineNo">055</span><a id="line.55"> void addChildRoleName( String name );</a> |
| <span class="sourceLineNo">056</span><a id="line.56"></a> |
| <span class="sourceLineNo">057</span><a id="line.57"> /**</a> |
| <span class="sourceLineNo">058</span><a id="line.58"> * Returns the list of child roles</a> |
| <span class="sourceLineNo">059</span><a id="line.59"> */</a> |
| <span class="sourceLineNo">060</span><a id="line.60"> List<String> getChildRoleNames();</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"> * Adds a child role and sets the list of child names and child ids.</a> |
| <span class="sourceLineNo">064</span><a id="line.64"> * @param child the child role</a> |
| <span class="sourceLineNo">065</span><a id="line.65"> */</a> |
| <span class="sourceLineNo">066</span><a id="line.66"> void addChildRole( Role child );</a> |
| <span class="sourceLineNo">067</span><a id="line.67"></a> |
| <span class="sourceLineNo">068</span><a id="line.68"> /**</a> |
| <span class="sourceLineNo">069</span><a id="line.69"> * Adds a child role id</a> |
| <span class="sourceLineNo">070</span><a id="line.70"> * @param id the id</a> |
| <span class="sourceLineNo">071</span><a id="line.71"> */</a> |
| <span class="sourceLineNo">072</span><a id="line.72"> void addChildRoleId( String id );</a> |
| <span class="sourceLineNo">073</span><a id="line.73"></a> |
| <span class="sourceLineNo">074</span><a id="line.74"> /**</a> |
| <span class="sourceLineNo">075</span><a id="line.75"> * Returns the child role ids</a> |
| <span class="sourceLineNo">076</span><a id="line.76"> * @return the list of child role ids</a> |
| <span class="sourceLineNo">077</span><a id="line.77"> */</a> |
| <span class="sourceLineNo">078</span><a id="line.78"> List<String> getChildRoleIds();</a> |
| <span class="sourceLineNo">079</span><a id="line.79"></a> |
| <span class="sourceLineNo">080</span><a id="line.80"> /**</a> |
| <span class="sourceLineNo">081</span><a id="line.81"> * Convenience method to see if Role has Child Roles.</a> |
| <span class="sourceLineNo">082</span><a id="line.82"> *</a> |
| <span class="sourceLineNo">083</span><a id="line.83"> * @return true if child roles exists and has any roles being tracked.</a> |
| <span class="sourceLineNo">084</span><a id="line.84"> */</a> |
| <span class="sourceLineNo">085</span><a id="line.85"> boolean hasChildRoles();</a> |
| <span class="sourceLineNo">086</span><a id="line.86"></a> |
| <span class="sourceLineNo">087</span><a id="line.87"> /**</a> |
| <span class="sourceLineNo">088</span><a id="line.88"> * Long description of the role.</a> |
| <span class="sourceLineNo">089</span><a id="line.89"> * @return the role description</a> |
| <span class="sourceLineNo">090</span><a id="line.90"> */</a> |
| <span class="sourceLineNo">091</span><a id="line.91"> String getDescription();</a> |
| <span class="sourceLineNo">092</span><a id="line.92"></a> |
| <span class="sourceLineNo">093</span><a id="line.93"> /**</a> |
| <span class="sourceLineNo">094</span><a id="line.94"> * Get the name. Must be unique.</a> |
| <span class="sourceLineNo">095</span><a id="line.95"> *</a> |
| <span class="sourceLineNo">096</span><a id="line.96"> * NOTE: This field is considered the Primary Key for this object.</a> |
| <span class="sourceLineNo">097</span><a id="line.97"> * @return the name of the role</a> |
| <span class="sourceLineNo">098</span><a id="line.98"> */</a> |
| <span class="sourceLineNo">099</span><a id="line.99"> String getName();</a> |
| <span class="sourceLineNo">100</span><a id="line.100"></a> |
| <span class="sourceLineNo">101</span><a id="line.101"> /**</a> |
| <span class="sourceLineNo">102</span><a id="line.102"> * Returns the list of permissions assigned to this role.</a> |
| <span class="sourceLineNo">103</span><a id="line.103"> * @return the list of permissions assigned to this role</a> |
| <span class="sourceLineNo">104</span><a id="line.104"> */</a> |
| <span class="sourceLineNo">105</span><a id="line.105"> List<? extends Permission> getPermissions();</a> |
| <span class="sourceLineNo">106</span><a id="line.106"></a> |
| <span class="sourceLineNo">107</span><a id="line.107"> /**</a> |
| <span class="sourceLineNo">108</span><a id="line.108"> * <code>True</code>, if this role is available to be assigned to a user, otherwise <code>false</code>.</a> |
| <span class="sourceLineNo">109</span><a id="line.109"> *</a> |
| <span class="sourceLineNo">110</span><a id="line.110"> * @return <code>true</code>, if this role can be assigned to users, otherwise <code>false</code></a> |
| <span class="sourceLineNo">111</span><a id="line.111"> */</a> |
| <span class="sourceLineNo">112</span><a id="line.112"> boolean isAssignable();</a> |
| <span class="sourceLineNo">113</span><a id="line.113"></a> |
| <span class="sourceLineNo">114</span><a id="line.114"> /**</a> |
| <span class="sourceLineNo">115</span><a id="line.115"> * Removes the given permission from the list. If the permission does not exist in the list of assigned</a> |
| <span class="sourceLineNo">116</span><a id="line.116"> * permissions, nothing happens.</a> |
| <span class="sourceLineNo">117</span><a id="line.117"> *</a> |
| <span class="sourceLineNo">118</span><a id="line.118"> * @param permission the permission to remove.</a> |
| <span class="sourceLineNo">119</span><a id="line.119"> */</a> |
| <span class="sourceLineNo">120</span><a id="line.120"> void removePermission( Permission permission );</a> |
| <span class="sourceLineNo">121</span><a id="line.121"></a> |
| <span class="sourceLineNo">122</span><a id="line.122"> /**</a> |
| <span class="sourceLineNo">123</span><a id="line.123"> * Set to <code>true</code>, if this role should available to be assigned to a user</a> |
| <span class="sourceLineNo">124</span><a id="line.124"> *</a> |
| <span class="sourceLineNo">125</span><a id="line.125"> * @param assignable the assignable flag</a> |
| <span class="sourceLineNo">126</span><a id="line.126"> */</a> |
| <span class="sourceLineNo">127</span><a id="line.127"> void setAssignable( boolean assignable );</a> |
| <span class="sourceLineNo">128</span><a id="line.128"></a> |
| <span class="sourceLineNo">129</span><a id="line.129"> /**</a> |
| <span class="sourceLineNo">130</span><a id="line.130"> * Sets the names of children roles. Children roles inherit the permissions of the parent role.</a> |
| <span class="sourceLineNo">131</span><a id="line.131"> *</a> |
| <span class="sourceLineNo">132</span><a id="line.132"> * @param names the list of names of child roles.</a> |
| <span class="sourceLineNo">133</span><a id="line.133"> */</a> |
| <span class="sourceLineNo">134</span><a id="line.134"> void setChildRoleNames( List<String> names );</a> |
| <span class="sourceLineNo">135</span><a id="line.135"></a> |
| <span class="sourceLineNo">136</span><a id="line.136"> /**</a> |
| <span class="sourceLineNo">137</span><a id="line.137"> * Sets the list of child role ids</a> |
| <span class="sourceLineNo">138</span><a id="line.138"> * @param ids</a> |
| <span class="sourceLineNo">139</span><a id="line.139"> */</a> |
| <span class="sourceLineNo">140</span><a id="line.140"> void setChildRoleIds( List<String> ids );</a> |
| <span class="sourceLineNo">141</span><a id="line.141"></a> |
| <span class="sourceLineNo">142</span><a id="line.142"> /**</a> |
| <span class="sourceLineNo">143</span><a id="line.143"> * Set the Description</a> |
| <span class="sourceLineNo">144</span><a id="line.144"> *</a> |
| <span class="sourceLineNo">145</span><a id="line.145"> * @param description the role description</a> |
| <span class="sourceLineNo">146</span><a id="line.146"> */</a> |
| <span class="sourceLineNo">147</span><a id="line.147"> void setDescription( String description );</a> |
| <span class="sourceLineNo">148</span><a id="line.148"></a> |
| <span class="sourceLineNo">149</span><a id="line.149"> /**</a> |
| <span class="sourceLineNo">150</span><a id="line.150"> * Set the role name</a> |
| <span class="sourceLineNo">151</span><a id="line.151"> *</a> |
| <span class="sourceLineNo">152</span><a id="line.152"> * NOTE: This field is considered the Primary Key for this object.</a> |
| <span class="sourceLineNo">153</span><a id="line.153"> *</a> |
| <span class="sourceLineNo">154</span><a id="line.154"> * @param name the role name</a> |
| <span class="sourceLineNo">155</span><a id="line.155"> */</a> |
| <span class="sourceLineNo">156</span><a id="line.156"> void setName( String name );</a> |
| <span class="sourceLineNo">157</span><a id="line.157"></a> |
| <span class="sourceLineNo">158</span><a id="line.158"> /**</a> |
| <span class="sourceLineNo">159</span><a id="line.159"> * Set role permissions. The list of assigned permissions is replaced by this list.</a> |
| <span class="sourceLineNo">160</span><a id="line.160"> *</a> |
| <span class="sourceLineNo">161</span><a id="line.161"> * @param permissions the permissions to set</a> |
| <span class="sourceLineNo">162</span><a id="line.162"> */</a> |
| <span class="sourceLineNo">163</span><a id="line.163"> void setPermissions( List<Permission> permissions );</a> |
| <span class="sourceLineNo">164</span><a id="line.164"></a> |
| <span class="sourceLineNo">165</span><a id="line.165"> /**</a> |
| <span class="sourceLineNo">166</span><a id="line.166"> * Test to see if the object is a permanent object or not.</a> |
| <span class="sourceLineNo">167</span><a id="line.167"> *</a> |
| <span class="sourceLineNo">168</span><a id="line.168"> * @return <code>true</code>, if the object is permanent.</a> |
| <span class="sourceLineNo">169</span><a id="line.169"> */</a> |
| <span class="sourceLineNo">170</span><a id="line.170"> boolean isPermanent();</a> |
| <span class="sourceLineNo">171</span><a id="line.171"></a> |
| <span class="sourceLineNo">172</span><a id="line.172"> /**</a> |
| <span class="sourceLineNo">173</span><a id="line.173"> * Set flag indicating if the object is a permanent object or not.</a> |
| <span class="sourceLineNo">174</span><a id="line.174"> *</a> |
| <span class="sourceLineNo">175</span><a id="line.175"> * @param permanent true if the object is permanent.</a> |
| <span class="sourceLineNo">176</span><a id="line.176"> */</a> |
| <span class="sourceLineNo">177</span><a id="line.177"> void setPermanent( boolean permanent );</a> |
| <span class="sourceLineNo">178</span><a id="line.178"></a> |
| <span class="sourceLineNo">179</span><a id="line.179"> /**</a> |
| <span class="sourceLineNo">180</span><a id="line.180"> * The role identifier. Should be built from the modelId and the resource. And must be unique.</a> |
| <span class="sourceLineNo">181</span><a id="line.181"> *</a> |
| <span class="sourceLineNo">182</span><a id="line.182"> * @since 3.0</a> |
| <span class="sourceLineNo">183</span><a id="line.183"> * @return the role identifier</a> |
| <span class="sourceLineNo">184</span><a id="line.184"> */</a> |
| <span class="sourceLineNo">185</span><a id="line.185"> String getId();</a> |
| <span class="sourceLineNo">186</span><a id="line.186"></a> |
| <span class="sourceLineNo">187</span><a id="line.187"> /**</a> |
| <span class="sourceLineNo">188</span><a id="line.188"> * Sets the role id</a> |
| <span class="sourceLineNo">189</span><a id="line.189"> *</a> |
| <span class="sourceLineNo">190</span><a id="line.190"> * @since 3.0</a> |
| <span class="sourceLineNo">191</span><a id="line.191"> * @param id the identifier of the role, should not be null or empty.</a> |
| <span class="sourceLineNo">192</span><a id="line.192"> */</a> |
| <span class="sourceLineNo">193</span><a id="line.193"> void setId(String id);</a> |
| <span class="sourceLineNo">194</span><a id="line.194"></a> |
| <span class="sourceLineNo">195</span><a id="line.195"> /**</a> |
| <span class="sourceLineNo">196</span><a id="line.196"> * Returns the model the role is derived from.</a> |
| <span class="sourceLineNo">197</span><a id="line.197"> *</a> |
| <span class="sourceLineNo">198</span><a id="line.198"> * @since 3.0</a> |
| <span class="sourceLineNo">199</span><a id="line.199"> * @return The model id or empty string, if this role was not created from a model</a> |
| <span class="sourceLineNo">200</span><a id="line.200"> */</a> |
| <span class="sourceLineNo">201</span><a id="line.201"> default String getModelId( ) {</a> |
| <span class="sourceLineNo">202</span><a id="line.202"> return "";</a> |
| <span class="sourceLineNo">203</span><a id="line.203"> }</a> |
| <span class="sourceLineNo">204</span><a id="line.204"></a> |
| <span class="sourceLineNo">205</span><a id="line.205"> /**</a> |
| <span class="sourceLineNo">206</span><a id="line.206"> * Sets the model id.</a> |
| <span class="sourceLineNo">207</span><a id="line.207"> *</a> |
| <span class="sourceLineNo">208</span><a id="line.208"> * @param modelId the identifier of the model, or empty string. Should not be null.</a> |
| <span class="sourceLineNo">209</span><a id="line.209"> */</a> |
| <span class="sourceLineNo">210</span><a id="line.210"> void setModelId(String modelId);</a> |
| <span class="sourceLineNo">211</span><a id="line.211"></a> |
| <span class="sourceLineNo">212</span><a id="line.212"> /**</a> |
| <span class="sourceLineNo">213</span><a id="line.213"> * Returns <code>true</code>, if this role is a instance of a template role, otherwise <code>false</code>.</a> |
| <span class="sourceLineNo">214</span><a id="line.214"> * Templated roles are built from a template together with a resource identifier.</a> |
| <span class="sourceLineNo">215</span><a id="line.215"> *</a> |
| <span class="sourceLineNo">216</span><a id="line.216"> * @since 3.0</a> |
| <span class="sourceLineNo">217</span><a id="line.217"> * @return <code>true</code>, if this role is a templated role, otherwise <code>false</code></a> |
| <span class="sourceLineNo">218</span><a id="line.218"> */</a> |
| <span class="sourceLineNo">219</span><a id="line.219"> default boolean isTemplateInstance( ) {</a> |
| <span class="sourceLineNo">220</span><a id="line.220"> return StringUtils.isEmpty( getResource() );</a> |
| <span class="sourceLineNo">221</span><a id="line.221"> }</a> |
| <span class="sourceLineNo">222</span><a id="line.222"></a> |
| <span class="sourceLineNo">223</span><a id="line.223"> /**</a> |
| <span class="sourceLineNo">224</span><a id="line.224"> * Sets the template instance flag.</a> |
| <span class="sourceLineNo">225</span><a id="line.225"> *</a> |
| <span class="sourceLineNo">226</span><a id="line.226"> * @since 3.0</a> |
| <span class="sourceLineNo">227</span><a id="line.227"> * @param templateInstanceFlag Set to <code>true</code>, if this is a template instance, otherwise <code>false</code></a> |
| <span class="sourceLineNo">228</span><a id="line.228"> */</a> |
| <span class="sourceLineNo">229</span><a id="line.229"> void setTemplateInstance(boolean templateInstanceFlag);</a> |
| <span class="sourceLineNo">230</span><a id="line.230"></a> |
| <span class="sourceLineNo">231</span><a id="line.231"> /**</a> |
| <span class="sourceLineNo">232</span><a id="line.232"> * Returns the resource that is used to build this role from a template. If this is not a templated</a> |
| <span class="sourceLineNo">233</span><a id="line.233"> * role, a empty string should be returned.</a> |
| <span class="sourceLineNo">234</span><a id="line.234"> *</a> |
| <span class="sourceLineNo">235</span><a id="line.235"> * @since 3.0</a> |
| <span class="sourceLineNo">236</span><a id="line.236"> * @return the resource identifier, used to build this role or a empty string, if this role is not templated</a> |
| <span class="sourceLineNo">237</span><a id="line.237"> */</a> |
| <span class="sourceLineNo">238</span><a id="line.238"> default String getResource() {</a> |
| <span class="sourceLineNo">239</span><a id="line.239"> return "";</a> |
| <span class="sourceLineNo">240</span><a id="line.240"> }</a> |
| <span class="sourceLineNo">241</span><a id="line.241"></a> |
| <span class="sourceLineNo">242</span><a id="line.242"> /**</a> |
| <span class="sourceLineNo">243</span><a id="line.243"> * Sets the resource, this template instance is attached to.</a> |
| <span class="sourceLineNo">244</span><a id="line.244"> *</a> |
| <span class="sourceLineNo">245</span><a id="line.245"> * @param resource the resource identifier. Must not be null.</a> |
| <span class="sourceLineNo">246</span><a id="line.246"> */</a> |
| <span class="sourceLineNo">247</span><a id="line.247"> void setResource( String resource );</a> |
| <span class="sourceLineNo">248</span><a id="line.248"></a> |
| <span class="sourceLineNo">249</span><a id="line.249"></a> |
| <span class="sourceLineNo">250</span><a id="line.250">}</a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
