| <!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"> * Licensed to the Apache Software Foundation (ASF) under one</a> |
| <span class="sourceLineNo">005</span><a id="line.5"> * or more contributor license agreements. See the NOTICE file</a> |
| <span class="sourceLineNo">006</span><a id="line.6"> * distributed with this work for additional information</a> |
| <span class="sourceLineNo">007</span><a id="line.7"> * regarding copyright ownership. The ASF licenses this file</a> |
| <span class="sourceLineNo">008</span><a id="line.8"> * to you under the Apache License, Version 2.0 (the</a> |
| <span class="sourceLineNo">009</span><a id="line.9"> * "License"); you may not use this file except in compliance</a> |
| <span class="sourceLineNo">010</span><a id="line.10"> * with the License. You may obtain a copy of the License at</a> |
| <span class="sourceLineNo">011</span><a id="line.11"> *</a> |
| <span class="sourceLineNo">012</span><a id="line.12"> * http://www.apache.org/licenses/LICENSE-2.0</a> |
| <span class="sourceLineNo">013</span><a id="line.13"> *</a> |
| <span class="sourceLineNo">014</span><a id="line.14"> * Unless required by applicable law or agreed to in writing,</a> |
| <span class="sourceLineNo">015</span><a id="line.15"> * software distributed under the License is distributed on an</a> |
| <span class="sourceLineNo">016</span><a id="line.16"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</a> |
| <span class="sourceLineNo">017</span><a id="line.17"> * KIND, either express or implied. See the License for the</a> |
| <span class="sourceLineNo">018</span><a id="line.18"> * specific language governing permissions and limitations</a> |
| <span class="sourceLineNo">019</span><a id="line.19"> * 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">import java.util.Collection;</a> |
| <span class="sourceLineNo">023</span><a id="line.23">import java.util.List;</a> |
| <span class="sourceLineNo">024</span><a id="line.24">import java.util.Map;</a> |
| <span class="sourceLineNo">025</span><a id="line.25">import java.util.Set;</a> |
| <span class="sourceLineNo">026</span><a id="line.26"></a> |
| <span class="sourceLineNo">027</span><a id="line.27">/**</a> |
| <span class="sourceLineNo">028</span><a id="line.28"> * Manages the roles, permissions and operations of the RBAC system.</a> |
| <span class="sourceLineNo">029</span><a id="line.29"> *</a> |
| <span class="sourceLineNo">030</span><a id="line.30"> * @author Jesse McConnell</a> |
| <span class="sourceLineNo">031</span><a id="line.31"> * @author <a href="mailto:joakim@erdfelt.com">Joakim Erdfelt</a></a> |
| <span class="sourceLineNo">032</span><a id="line.32"> * @author Martin Stockhammer <martin_s@apache.org></a> |
| <span class="sourceLineNo">033</span><a id="line.33"> *</a> |
| <span class="sourceLineNo">034</span><a id="line.34"> */</a> |
| <span class="sourceLineNo">035</span><a id="line.35">public interface RBACManager</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"> void addListener( RBACManagerListener listener );</a> |
| <span class="sourceLineNo">039</span><a id="line.39"></a> |
| <span class="sourceLineNo">040</span><a id="line.40"> void removeListener( RBACManagerListener listener );</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"> // Role Methods</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"> /**</a> |
| <span class="sourceLineNo">048</span><a id="line.48"> * Creates an implementation specific {@link Role}, or return an existing {@link Role}, depending</a> |
| <span class="sourceLineNo">049</span><a id="line.49"> * on the provided <code>name</code> parameter.</a> |
| <span class="sourceLineNo">050</span><a id="line.50"> *</a> |
| <span class="sourceLineNo">051</span><a id="line.51"> * Note: Be sure to use {@link #saveRole(Role)} in order to persist any changes to the Role.</a> |
| <span class="sourceLineNo">052</span><a id="line.52"> *</a> |
| <span class="sourceLineNo">053</span><a id="line.53"> * @param name the name.</a> |
| <span class="sourceLineNo">054</span><a id="line.54"> * @return the new {@link Role} object.</a> |
| <span class="sourceLineNo">055</span><a id="line.55"> */</a> |
| <span class="sourceLineNo">056</span><a id="line.56"> Role createRole( String name );</a> |
| <span class="sourceLineNo">057</span><a id="line.57"></a> |
| <span class="sourceLineNo">058</span><a id="line.58"> /**</a> |
| <span class="sourceLineNo">059</span><a id="line.59"> * Creates a new role with the given id and role name.</a> |
| <span class="sourceLineNo">060</span><a id="line.60"> * @param id the role identifier, which must be unique</a> |
| <span class="sourceLineNo">061</span><a id="line.61"> * @param name the role name, which must be unique</a> |
| <span class="sourceLineNo">062</span><a id="line.62"> * @return the new role instance</a> |
| <span class="sourceLineNo">063</span><a id="line.63"> */</a> |
| <span class="sourceLineNo">064</span><a id="line.64"> Role createRole(String id, String name);</a> |
| <span class="sourceLineNo">065</span><a id="line.65"></a> |
| <span class="sourceLineNo">066</span><a id="line.66"> /**</a> |
| <span class="sourceLineNo">067</span><a id="line.67"> * Tests for the existence of a Role.</a> |
| <span class="sourceLineNo">068</span><a id="line.68"> *</a> |
| <span class="sourceLineNo">069</span><a id="line.69"> * @return true if role exists in store.</a> |
| <span class="sourceLineNo">070</span><a id="line.70"> * @throws RbacManagerException if the access to the backend datastore failed</a> |
| <span class="sourceLineNo">071</span><a id="line.71"> */</a> |
| <span class="sourceLineNo">072</span><a id="line.72"> boolean roleExists( String name )</a> |
| <span class="sourceLineNo">073</span><a id="line.73"> throws RbacManagerException;</a> |
| <span class="sourceLineNo">074</span><a id="line.74"></a> |
| <span class="sourceLineNo">075</span><a id="line.75"> /**</a> |
| <span class="sourceLineNo">076</span><a id="line.76"> * Returns <code>true</code>, if a role with the given id exists.</a> |
| <span class="sourceLineNo">077</span><a id="line.77"> * @param id the role id</a> |
| <span class="sourceLineNo">078</span><a id="line.78"> * @return <code>true</code>, if the role with the given id exists, otherwise <code>false</code></a> |
| <span class="sourceLineNo">079</span><a id="line.79"> * @throws RbacManagerException if the access to the backend datastore failed</a> |
| <span class="sourceLineNo">080</span><a id="line.80"> */</a> |
| <span class="sourceLineNo">081</span><a id="line.81"> boolean roleExistsById( String id ) throws RbacManagerException;</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"> * Returns true, if the given role exists.</a> |
| <span class="sourceLineNo">085</span><a id="line.85"> *</a> |
| <span class="sourceLineNo">086</span><a id="line.86"> * @param role the role to check</a> |
| <span class="sourceLineNo">087</span><a id="line.87"> * @return <code>true</code>, if the role exists, otherwise <code>false</code></a> |
| <span class="sourceLineNo">088</span><a id="line.88"> * @throws RbacManagerException if the access to the backend datastore failed</a> |
| <span class="sourceLineNo">089</span><a id="line.89"> */</a> |
| <span class="sourceLineNo">090</span><a id="line.90"> boolean roleExists( Role role )</a> |
| <span class="sourceLineNo">091</span><a id="line.91"> throws RbacManagerException;</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"> * Persists the given role to the backend datastore.</a> |
| <span class="sourceLineNo">095</span><a id="line.95"> *</a> |
| <span class="sourceLineNo">096</span><a id="line.96"> * @param role the role to save</a> |
| <span class="sourceLineNo">097</span><a id="line.97"> * @return the persisted role, if the method was successful</a> |
| <span class="sourceLineNo">098</span><a id="line.98"> * @throws RbacObjectInvalidException if the given role object was not valid</a> |
| <span class="sourceLineNo">099</span><a id="line.99"> * @throws RbacManagerException if the access to the backend datastore failed</a> |
| <span class="sourceLineNo">100</span><a id="line.100"> */</a> |
| <span class="sourceLineNo">101</span><a id="line.101"> Role saveRole( Role role )</a> |
| <span class="sourceLineNo">102</span><a id="line.102"> throws RbacObjectInvalidException, RbacManagerException;</a> |
| <span class="sourceLineNo">103</span><a id="line.103"></a> |
| <span class="sourceLineNo">104</span><a id="line.104"> /**</a> |
| <span class="sourceLineNo">105</span><a id="line.105"> * Persists all of the given roles to the backend datastore.</a> |
| <span class="sourceLineNo">106</span><a id="line.106"> * Implementations should try to save all role instances and throw exceptions afterwards.</a> |
| <span class="sourceLineNo">107</span><a id="line.107"> *</a> |
| <span class="sourceLineNo">108</span><a id="line.108"> * @param roles the list of roles to save</a> |
| <span class="sourceLineNo">109</span><a id="line.109"> * @throws RbacObjectInvalidException if one of the given role objects was not valid</a> |
| <span class="sourceLineNo">110</span><a id="line.110"> * @throws RbacManagerException if the access to the backend datastore failed</a> |
| <span class="sourceLineNo">111</span><a id="line.111"> */</a> |
| <span class="sourceLineNo">112</span><a id="line.112"> void saveRoles( Collection<Role> roles )</a> |
| <span class="sourceLineNo">113</span><a id="line.113"> throws RbacObjectInvalidException, RbacManagerException;</a> |
| <span class="sourceLineNo">114</span><a id="line.114"></a> |
| <span class="sourceLineNo">115</span><a id="line.115"> /**</a> |
| <span class="sourceLineNo">116</span><a id="line.116"> * Returns the role identified by the given name</a> |
| <span class="sourceLineNo">117</span><a id="line.117"> *</a> |
| <span class="sourceLineNo">118</span><a id="line.118"> * @param roleName the role name</a> |
| <span class="sourceLineNo">119</span><a id="line.119"> * @return the role instance, if a role by this name was found</a> |
| <span class="sourceLineNo">120</span><a id="line.120"> * @throws RbacObjectNotFoundException if not role was found with the given name</a> |
| <span class="sourceLineNo">121</span><a id="line.121"> * @throws RbacManagerException if the access to the underlying datastore failed</a> |
| <span class="sourceLineNo">122</span><a id="line.122"> */</a> |
| <span class="sourceLineNo">123</span><a id="line.123"> Role getRole( String roleName )</a> |
| <span class="sourceLineNo">124</span><a id="line.124"> throws RbacObjectNotFoundException, RbacManagerException;</a> |
| <span class="sourceLineNo">125</span><a id="line.125"></a> |
| <span class="sourceLineNo">126</span><a id="line.126"> /**</a> |
| <span class="sourceLineNo">127</span><a id="line.127"> * Returns the role identified by the given ID</a> |
| <span class="sourceLineNo">128</span><a id="line.128"> * @param id the role id</a> |
| <span class="sourceLineNo">129</span><a id="line.129"> * @return the role object, if the role with the given id exists</a> |
| <span class="sourceLineNo">130</span><a id="line.130"> * @throws RbacObjectNotFoundException if no role was found with the given id</a> |
| <span class="sourceLineNo">131</span><a id="line.131"> * @throws RbacManagerException if the access to the underlying datastore failed</a> |
| <span class="sourceLineNo">132</span><a id="line.132"> */</a> |
| <span class="sourceLineNo">133</span><a id="line.133"> Role getRoleById( String id ) throws RbacObjectNotFoundException, RbacManagerException;</a> |
| <span class="sourceLineNo">134</span><a id="line.134"></a> |
| <span class="sourceLineNo">135</span><a id="line.135"> /**</a> |
| <span class="sourceLineNo">136</span><a id="line.136"> * Returns the role instances for the given role names.</a> |
| <span class="sourceLineNo">137</span><a id="line.137"> *</a> |
| <span class="sourceLineNo">138</span><a id="line.138"> * @param roleNames the list of role names.</a> |
| <span class="sourceLineNo">139</span><a id="line.139"> * @return a map of (name,role) pairs</a> |
| <span class="sourceLineNo">140</span><a id="line.140"> * @throws RbacObjectNotFoundException if one of the given roles was not found</a> |
| <span class="sourceLineNo">141</span><a id="line.141"> * @throws RbacManagerException if the access to the backend datastore failed</a> |
| <span class="sourceLineNo">142</span><a id="line.142"> */</a> |
| <span class="sourceLineNo">143</span><a id="line.143"> Map<String, ? extends Role> getRoles( Collection<String> roleNames )</a> |
| <span class="sourceLineNo">144</span><a id="line.144"> throws RbacObjectNotFoundException, RbacManagerException;</a> |
| <span class="sourceLineNo">145</span><a id="line.145"></a> |
| <span class="sourceLineNo">146</span><a id="line.146"> /**</a> |
| <span class="sourceLineNo">147</span><a id="line.147"> * Adds a child to a role.</a> |
| <span class="sourceLineNo">148</span><a id="line.148"> *</a> |
| <span class="sourceLineNo">149</span><a id="line.149"> * @param role the parent role</a> |
| <span class="sourceLineNo">150</span><a id="line.150"> * @param childRole the child role, that is added to the parent role</a> |
| <span class="sourceLineNo">151</span><a id="line.151"> * @throws RbacObjectInvalidException if one of the role objects was not valid</a> |
| <span class="sourceLineNo">152</span><a id="line.152"> * @throws RbacManagerException if the access to the backend datastore failed</a> |
| <span class="sourceLineNo">153</span><a id="line.153"> */</a> |
| <span class="sourceLineNo">154</span><a id="line.154"> void addChildRole( Role role, Role childRole )</a> |
| <span class="sourceLineNo">155</span><a id="line.155"> throws RbacObjectInvalidException, RbacManagerException;</a> |
| <span class="sourceLineNo">156</span><a id="line.156"></a> |
| <span class="sourceLineNo">157</span><a id="line.157"> /**</a> |
| <span class="sourceLineNo">158</span><a id="line.158"> * Returns all the child roles of a given role as (name, role) pairs.</a> |
| <span class="sourceLineNo">159</span><a id="line.159"> * @param role the parent role</a> |
| <span class="sourceLineNo">160</span><a id="line.160"> * @return the list of child roles</a> |
| <span class="sourceLineNo">161</span><a id="line.161"> * @throws RbacManagerException if the access to the backend datastore failed</a> |
| <span class="sourceLineNo">162</span><a id="line.162"> */</a> |
| <span class="sourceLineNo">163</span><a id="line.163"> Map<String, ? extends Role> getChildRoleNames( Role role )</a> |
| <span class="sourceLineNo">164</span><a id="line.164"> throws RbacManagerException;</a> |
| <span class="sourceLineNo">165</span><a id="line.165"></a> |
| <span class="sourceLineNo">166</span><a id="line.166"> /**</a> |
| <span class="sourceLineNo">167</span><a id="line.167"> * Returns all the child roles of a given role as (role id, role) pairs.</a> |
| <span class="sourceLineNo">168</span><a id="line.168"> * @param role the parent role</a> |
| <span class="sourceLineNo">169</span><a id="line.169"> * @return the map of child roles as (role id, role) pairs</a> |
| <span class="sourceLineNo">170</span><a id="line.170"> * @throws RbacManagerException if the access to the backend datastore failed</a> |
| <span class="sourceLineNo">171</span><a id="line.171"> */</a> |
| <span class="sourceLineNo">172</span><a id="line.172"> Map<String, ? extends Role> getChildRoleIds( Role role )</a> |
| <span class="sourceLineNo">173</span><a id="line.173"> throws RbacManagerException;</a> |
| <span class="sourceLineNo">174</span><a id="line.174"></a> |
| <span class="sourceLineNo">175</span><a id="line.175"> /**</a> |
| <span class="sourceLineNo">176</span><a id="line.176"> * Returns all the parent roles of a given role as map of (name, role) elements.</a> |
| <span class="sourceLineNo">177</span><a id="line.177"> * @param role the role to check for parent roles</a> |
| <span class="sourceLineNo">178</span><a id="line.178"> * @return the list of parent roles that have <code>role</code> als child</a> |
| <span class="sourceLineNo">179</span><a id="line.179"> * @throws RbacManagerException if the access to the backend datastore failed</a> |
| <span class="sourceLineNo">180</span><a id="line.180"> */</a> |
| <span class="sourceLineNo">181</span><a id="line.181"> Map<String, ? extends Role> getParentRoleNames( Role role )</a> |
| <span class="sourceLineNo">182</span><a id="line.182"> throws RbacManagerException;</a> |
| <span class="sourceLineNo">183</span><a id="line.183"></a> |
| <span class="sourceLineNo">184</span><a id="line.184"> /**</a> |
| <span class="sourceLineNo">185</span><a id="line.185"> * Returns all the parent roles of a given role as map of (id, role) elements.</a> |
| <span class="sourceLineNo">186</span><a id="line.186"> * @param role the role to check for parents roles</a> |
| <span class="sourceLineNo">187</span><a id="line.187"> * @return a map of (role id, role) pairs that have <code>role</code> as child</a> |
| <span class="sourceLineNo">188</span><a id="line.188"> * @throws RbacManagerException if the access to the backend datastore failed</a> |
| <span class="sourceLineNo">189</span><a id="line.189"> */</a> |
| <span class="sourceLineNo">190</span><a id="line.190"> Map<String, ? extends Role> getParentRoleIds( Role role )</a> |
| <span class="sourceLineNo">191</span><a id="line.191"> throws RbacManagerException;</a> |
| <span class="sourceLineNo">192</span><a id="line.192"></a> |
| <span class="sourceLineNo">193</span><a id="line.193"> /**</a> |
| <span class="sourceLineNo">194</span><a id="line.194"> * Returns all roles defined in the datastore.</a> |
| <span class="sourceLineNo">195</span><a id="line.195"> *</a> |
| <span class="sourceLineNo">196</span><a id="line.196"> * @return the list of roles defined in the datastore</a> |
| <span class="sourceLineNo">197</span><a id="line.197"> * @throws RbacManagerException if the access to the backend datastore failed</a> |
| <span class="sourceLineNo">198</span><a id="line.198"> */</a> |
| <span class="sourceLineNo">199</span><a id="line.199"> List<? extends Role> getAllRoles()</a> |
| <span class="sourceLineNo">200</span><a id="line.200"> throws RbacManagerException;</a> |
| <span class="sourceLineNo">201</span><a id="line.201"></a> |
| <span class="sourceLineNo">202</span><a id="line.202"> /**</a> |
| <span class="sourceLineNo">203</span><a id="line.203"> * Returns all effective roles. Which means a list with the current role and all child roles recursively.</a> |
| <span class="sourceLineNo">204</span><a id="line.204"> *</a> |
| <span class="sourceLineNo">205</span><a id="line.205"> * @param role the role to use as starting point</a> |
| <span class="sourceLineNo">206</span><a id="line.206"> * @return the set of roles that are found as children of the given role</a> |
| <span class="sourceLineNo">207</span><a id="line.207"> * @throws RbacObjectNotFoundException if the given role was not found</a> |
| <span class="sourceLineNo">208</span><a id="line.208"> * @throws RbacManagerException if the access to the backend datastore failed</a> |
| <span class="sourceLineNo">209</span><a id="line.209"> */</a> |
| <span class="sourceLineNo">210</span><a id="line.210"> Set<? extends Role> getEffectiveRoles( Role role )</a> |
| <span class="sourceLineNo">211</span><a id="line.211"> throws RbacObjectNotFoundException, RbacManagerException;</a> |
| <span class="sourceLineNo">212</span><a id="line.212"></a> |
| <span class="sourceLineNo">213</span><a id="line.213"> /**</a> |
| <span class="sourceLineNo">214</span><a id="line.214"> * Removes the given role from the datastore.</a> |
| <span class="sourceLineNo">215</span><a id="line.215"> *</a> |
| <span class="sourceLineNo">216</span><a id="line.216"> * @param role the role to remove</a> |
| <span class="sourceLineNo">217</span><a id="line.217"> * @throws RbacManagerException if the access to the backend datastore failed</a> |
| <span class="sourceLineNo">218</span><a id="line.218"> * @throws RbacObjectNotFoundException if the given role was not found</a> |
| <span class="sourceLineNo">219</span><a id="line.219"> * @throws RbacObjectInvalidException if the given role has invalid data</a> |
| <span class="sourceLineNo">220</span><a id="line.220"> */</a> |
| <span class="sourceLineNo">221</span><a id="line.221"> void removeRole( Role role )</a> |
| <span class="sourceLineNo">222</span><a id="line.222"> throws RbacObjectNotFoundException, RbacObjectInvalidException, RbacManagerException;</a> |
| <span class="sourceLineNo">223</span><a id="line.223"></a> |
| <span class="sourceLineNo">224</span><a id="line.224"> /**</a> |
| <span class="sourceLineNo">225</span><a id="line.225"> * Removes the role with the given name from the datastore.</a> |
| <span class="sourceLineNo">226</span><a id="line.226"> *</a> |
| <span class="sourceLineNo">227</span><a id="line.227"> * @param roleName the role name</a> |
| <span class="sourceLineNo">228</span><a id="line.228"> * @throws RbacObjectNotFoundException if the role with the given name was not found</a> |
| <span class="sourceLineNo">229</span><a id="line.229"> * @throws RbacManagerException if the access to the backend datastore failed</a> |
| <span class="sourceLineNo">230</span><a id="line.230"> */</a> |
| <span class="sourceLineNo">231</span><a id="line.231"> void removeRole( String roleName )</a> |
| <span class="sourceLineNo">232</span><a id="line.232"> throws RbacObjectNotFoundException, RbacManagerException;</a> |
| <span class="sourceLineNo">233</span><a id="line.233"></a> |
| <span class="sourceLineNo">234</span><a id="line.234"> /**</a> |
| <span class="sourceLineNo">235</span><a id="line.235"> * Removes the role with the given id from the datastore.</a> |
| <span class="sourceLineNo">236</span><a id="line.236"> *</a> |
| <span class="sourceLineNo">237</span><a id="line.237"> * @param id the role id</a> |
| <span class="sourceLineNo">238</span><a id="line.238"> * @throws RbacObjectNotFoundException if no role with the given id was found</a> |
| <span class="sourceLineNo">239</span><a id="line.239"> * @throws RbacManagerException if the access to the backend datastore failed</a> |
| <span class="sourceLineNo">240</span><a id="line.240"> */</a> |
| <span class="sourceLineNo">241</span><a id="line.241"> void removeRoleById( String id ) throws RbacObjectNotFoundException, RbacManagerException;</a> |
| <span class="sourceLineNo">242</span><a id="line.242"></a> |
| <span class="sourceLineNo">243</span><a id="line.243"> // ------------------------------------------------------------------</a> |
| <span class="sourceLineNo">244</span><a id="line.244"> // Permission Methods</a> |
| <span class="sourceLineNo">245</span><a id="line.245"> // ------------------------------------------------------------------</a> |
| <span class="sourceLineNo">246</span><a id="line.246"></a> |
| <span class="sourceLineNo">247</span><a id="line.247"> /**</a> |
| <span class="sourceLineNo">248</span><a id="line.248"> * Creates an implementation specific {@link Permission}, or return an existing {@link Permission}, depending</a> |
| <span class="sourceLineNo">249</span><a id="line.249"> * on the provided <code>name</code> parameter.</a> |
| <span class="sourceLineNo">250</span><a id="line.250"> *</a> |
| <span class="sourceLineNo">251</span><a id="line.251"> * Note: Be sure to use {@link #savePermission(Permission)} in order to persist any changes to the Role.</a> |
| <span class="sourceLineNo">252</span><a id="line.252"> *</a> |
| <span class="sourceLineNo">253</span><a id="line.253"> * @param name the name.</a> |
| <span class="sourceLineNo">254</span><a id="line.254"> * @return the new Permission.</a> |
| <span class="sourceLineNo">255</span><a id="line.255"> * @throws RbacManagerException if the access to the backend datastore failed</a> |
| <span class="sourceLineNo">256</span><a id="line.256"> */</a> |
| <span class="sourceLineNo">257</span><a id="line.257"> Permission createPermission( String name )</a> |
| <span class="sourceLineNo">258</span><a id="line.258"> throws RbacManagerException;</a> |
| <span class="sourceLineNo">259</span><a id="line.259"></a> |
| <span class="sourceLineNo">260</span><a id="line.260"> /**</a> |
| <span class="sourceLineNo">261</span><a id="line.261"> * Creates an implementation specific {@link Permission} with specified {@link Operation},</a> |
| <span class="sourceLineNo">262</span><a id="line.262"> * and {@link Resource} identifiers.</a> |
| <span class="sourceLineNo">263</span><a id="line.263"> *</a> |
| <span class="sourceLineNo">264</span><a id="line.264"> * Note: Be sure to use {@link #savePermission(Permission)} in order to persist any changes to the Role.</a> |
| <span class="sourceLineNo">265</span><a id="line.265"> *</a> |
| <span class="sourceLineNo">266</span><a id="line.266"> * @param name the name.</a> |
| <span class="sourceLineNo">267</span><a id="line.267"> * @param operationName the {@link Operation#setName(String)} value</a> |
| <span class="sourceLineNo">268</span><a id="line.268"> * @param resourceIdentifier the {@link Resource#setIdentifier(String)} value</a> |
| <span class="sourceLineNo">269</span><a id="line.269"> * @return the new Permission.</a> |
| <span class="sourceLineNo">270</span><a id="line.270"> * @throws RbacManagerException if the access to the backend datastore failed</a> |
| <span class="sourceLineNo">271</span><a id="line.271"> */</a> |
| <span class="sourceLineNo">272</span><a id="line.272"> Permission createPermission( String name, String operationName, String resourceIdentifier )</a> |
| <span class="sourceLineNo">273</span><a id="line.273"> throws RbacManagerException;</a> |
| <span class="sourceLineNo">274</span><a id="line.274"></a> |
| <span class="sourceLineNo">275</span><a id="line.275"> /**</a> |
| <span class="sourceLineNo">276</span><a id="line.276"> * Tests for the existence of a permission.</a> |
| <span class="sourceLineNo">277</span><a id="line.277"> *</a> |
| <span class="sourceLineNo">278</span><a id="line.278"> * @param name the name to test for.</a> |
| <span class="sourceLineNo">279</span><a id="line.279"> * @return true if permission exists.</a> |
| <span class="sourceLineNo">280</span><a id="line.280"> */</a> |
| <span class="sourceLineNo">281</span><a id="line.281"> boolean permissionExists( String name );</a> |
| <span class="sourceLineNo">282</span><a id="line.282"></a> |
| <span class="sourceLineNo">283</span><a id="line.283"> boolean permissionExists( Permission permission );</a> |
| <span class="sourceLineNo">284</span><a id="line.284"></a> |
| <span class="sourceLineNo">285</span><a id="line.285"> @SuppressWarnings( "DuplicateThrows" )</a> |
| <span class="sourceLineNo">286</span><a id="line.286"> Permission savePermission( Permission permission )</a> |
| <span class="sourceLineNo">287</span><a id="line.287"> throws RbacObjectInvalidException, RbacManagerException;</a> |
| <span class="sourceLineNo">288</span><a id="line.288"></a> |
| <span class="sourceLineNo">289</span><a id="line.289"> @SuppressWarnings( "DuplicateThrows" )</a> |
| <span class="sourceLineNo">290</span><a id="line.290"> Permission getPermission( String permissionName )</a> |
| <span class="sourceLineNo">291</span><a id="line.291"> throws RbacObjectNotFoundException, RbacManagerException;</a> |
| <span class="sourceLineNo">292</span><a id="line.292"></a> |
| <span class="sourceLineNo">293</span><a id="line.293"> List<? extends Permission> getAllPermissions()</a> |
| <span class="sourceLineNo">294</span><a id="line.294"> throws RbacManagerException;</a> |
| <span class="sourceLineNo">295</span><a id="line.295"></a> |
| <span class="sourceLineNo">296</span><a id="line.296"> @SuppressWarnings( "DuplicateThrows" )</a> |
| <span class="sourceLineNo">297</span><a id="line.297"> void removePermission( Permission permission )</a> |
| <span class="sourceLineNo">298</span><a id="line.298"> throws RbacObjectNotFoundException, RbacObjectInvalidException, RbacManagerException;</a> |
| <span class="sourceLineNo">299</span><a id="line.299"></a> |
| <span class="sourceLineNo">300</span><a id="line.300"> @SuppressWarnings( "DuplicateThrows" )</a> |
| <span class="sourceLineNo">301</span><a id="line.301"> void removePermission( String permissionName )</a> |
| <span class="sourceLineNo">302</span><a id="line.302"> throws RbacObjectNotFoundException, RbacObjectInvalidException, RbacManagerException;</a> |
| <span class="sourceLineNo">303</span><a id="line.303"></a> |
| <span class="sourceLineNo">304</span><a id="line.304"> // ------------------------------------------------------------------</a> |
| <span class="sourceLineNo">305</span><a id="line.305"> // Operation Methods</a> |
| <span class="sourceLineNo">306</span><a id="line.306"> // ------------------------------------------------------------------</a> |
| <span class="sourceLineNo">307</span><a id="line.307"></a> |
| <span class="sourceLineNo">308</span><a id="line.308"> /**</a> |
| <span class="sourceLineNo">309</span><a id="line.309"> * Creates an implementation specific {@link Operation}, or return an existing {@link Operation}, depending</a> |
| <span class="sourceLineNo">310</span><a id="line.310"> * on the provided <code>name</code> parameter.</a> |
| <span class="sourceLineNo">311</span><a id="line.311"> *</a> |
| <span class="sourceLineNo">312</span><a id="line.312"> * Note: Be sure to use {@link #saveOperation(Operation)} in order to persist any changes to the Role.</a> |
| <span class="sourceLineNo">313</span><a id="line.313"> *</a> |
| <span class="sourceLineNo">314</span><a id="line.314"> * @param name the name.</a> |
| <span class="sourceLineNo">315</span><a id="line.315"> * @return the new Operation.</a> |
| <span class="sourceLineNo">316</span><a id="line.316"> * @throws RbacManagerException if the access to the backend datastore failed</a> |
| <span class="sourceLineNo">317</span><a id="line.317"> */</a> |
| <span class="sourceLineNo">318</span><a id="line.318"> Operation createOperation( String name )</a> |
| <span class="sourceLineNo">319</span><a id="line.319"> throws RbacManagerException;</a> |
| <span class="sourceLineNo">320</span><a id="line.320"></a> |
| <span class="sourceLineNo">321</span><a id="line.321"> boolean operationExists( String name );</a> |
| <span class="sourceLineNo">322</span><a id="line.322"></a> |
| <span class="sourceLineNo">323</span><a id="line.323"> boolean operationExists( Operation operation );</a> |
| <span class="sourceLineNo">324</span><a id="line.324"></a> |
| <span class="sourceLineNo">325</span><a id="line.325"> /**</a> |
| <span class="sourceLineNo">326</span><a id="line.326"> * Save the new or existing operation to the store.</a> |
| <span class="sourceLineNo">327</span><a id="line.327"> *</a> |
| <span class="sourceLineNo">328</span><a id="line.328"> * @param operation the operation to save (new or existing)</a> |
| <span class="sourceLineNo">329</span><a id="line.329"> * @return the Operation that was saved.</a> |
| <span class="sourceLineNo">330</span><a id="line.330"> * @throws RbacObjectInvalidException if the object is not valid and cannot be saved</a> |
| <span class="sourceLineNo">331</span><a id="line.331"> * @throws RbacManagerException if the access to the backend datastore failed</a> |
| <span class="sourceLineNo">332</span><a id="line.332"> */</a> |
| <span class="sourceLineNo">333</span><a id="line.333"> Operation saveOperation( Operation operation )</a> |
| <span class="sourceLineNo">334</span><a id="line.334"> throws RbacObjectInvalidException, RbacManagerException;</a> |
| <span class="sourceLineNo">335</span><a id="line.335"></a> |
| <span class="sourceLineNo">336</span><a id="line.336"> @SuppressWarnings( "DuplicateThrows" )</a> |
| <span class="sourceLineNo">337</span><a id="line.337"> Operation getOperation( String operationName )</a> |
| <span class="sourceLineNo">338</span><a id="line.338"> throws RbacObjectNotFoundException, RbacManagerException;</a> |
| <span class="sourceLineNo">339</span><a id="line.339"></a> |
| <span class="sourceLineNo">340</span><a id="line.340"> List<? extends Operation> getAllOperations()</a> |
| <span class="sourceLineNo">341</span><a id="line.341"> throws RbacManagerException;</a> |
| <span class="sourceLineNo">342</span><a id="line.342"></a> |
| <span class="sourceLineNo">343</span><a id="line.343"> @SuppressWarnings( "DuplicateThrows" )</a> |
| <span class="sourceLineNo">344</span><a id="line.344"> void removeOperation( Operation operation )</a> |
| <span class="sourceLineNo">345</span><a id="line.345"> throws RbacObjectNotFoundException, RbacObjectInvalidException, RbacManagerException;</a> |
| <span class="sourceLineNo">346</span><a id="line.346"></a> |
| <span class="sourceLineNo">347</span><a id="line.347"> @SuppressWarnings( "DuplicateThrows" )</a> |
| <span class="sourceLineNo">348</span><a id="line.348"> void removeOperation( String operationName )</a> |
| <span class="sourceLineNo">349</span><a id="line.349"> throws RbacObjectNotFoundException, RbacObjectInvalidException, RbacManagerException;</a> |
| <span class="sourceLineNo">350</span><a id="line.350"></a> |
| <span class="sourceLineNo">351</span><a id="line.351"> // ------------------------------------------------------------------</a> |
| <span class="sourceLineNo">352</span><a id="line.352"> // Resource Methods</a> |
| <span class="sourceLineNo">353</span><a id="line.353"> // ------------------------------------------------------------------</a> |
| <span class="sourceLineNo">354</span><a id="line.354"></a> |
| <span class="sourceLineNo">355</span><a id="line.355"> /**</a> |
| <span class="sourceLineNo">356</span><a id="line.356"> * Creates an implementation specific {@link Resource}, or return an existing {@link Resource}, depending</a> |
| <span class="sourceLineNo">357</span><a id="line.357"> * on the provided <code>identifier</code> parameter.</a> |
| <span class="sourceLineNo">358</span><a id="line.358"> *</a> |
| <span class="sourceLineNo">359</span><a id="line.359"> * Note: Be sure to use {@link #saveResource(Resource)} in order to persist any changes to the Role.</a> |
| <span class="sourceLineNo">360</span><a id="line.360"> *</a> |
| <span class="sourceLineNo">361</span><a id="line.361"> * @param identifier the identifier.</a> |
| <span class="sourceLineNo">362</span><a id="line.362"> * @return the new Resource.</a> |
| <span class="sourceLineNo">363</span><a id="line.363"> * @throws RbacManagerException if the access to the backend datastore failed</a> |
| <span class="sourceLineNo">364</span><a id="line.364"> */</a> |
| <span class="sourceLineNo">365</span><a id="line.365"> Resource createResource( String identifier )</a> |
| <span class="sourceLineNo">366</span><a id="line.366"> throws RbacManagerException;</a> |
| <span class="sourceLineNo">367</span><a id="line.367"></a> |
| <span class="sourceLineNo">368</span><a id="line.368"> boolean resourceExists( String identifier );</a> |
| <span class="sourceLineNo">369</span><a id="line.369"></a> |
| <span class="sourceLineNo">370</span><a id="line.370"> boolean resourceExists( Resource resource );</a> |
| <span class="sourceLineNo">371</span><a id="line.371"></a> |
| <span class="sourceLineNo">372</span><a id="line.372"> @SuppressWarnings( "DuplicateThrows" )</a> |
| <span class="sourceLineNo">373</span><a id="line.373"> Resource saveResource( Resource resource )</a> |
| <span class="sourceLineNo">374</span><a id="line.374"> throws RbacObjectInvalidException, RbacManagerException;</a> |
| <span class="sourceLineNo">375</span><a id="line.375"></a> |
| <span class="sourceLineNo">376</span><a id="line.376"> @SuppressWarnings( "DuplicateThrows" )</a> |
| <span class="sourceLineNo">377</span><a id="line.377"> Resource getResource( String resourceIdentifier )</a> |
| <span class="sourceLineNo">378</span><a id="line.378"> throws RbacObjectNotFoundException, RbacManagerException;</a> |
| <span class="sourceLineNo">379</span><a id="line.379"></a> |
| <span class="sourceLineNo">380</span><a id="line.380"> List<? extends Resource> getAllResources()</a> |
| <span class="sourceLineNo">381</span><a id="line.381"> throws RbacManagerException;</a> |
| <span class="sourceLineNo">382</span><a id="line.382"></a> |
| <span class="sourceLineNo">383</span><a id="line.383"> @SuppressWarnings( "DuplicateThrows" )</a> |
| <span class="sourceLineNo">384</span><a id="line.384"> void removeResource( Resource resource )</a> |
| <span class="sourceLineNo">385</span><a id="line.385"> throws RbacObjectNotFoundException, RbacObjectInvalidException, RbacManagerException;</a> |
| <span class="sourceLineNo">386</span><a id="line.386"></a> |
| <span class="sourceLineNo">387</span><a id="line.387"> @SuppressWarnings( "DuplicateThrows" )</a> |
| <span class="sourceLineNo">388</span><a id="line.388"> void removeResource( String resourceIdentifier )</a> |
| <span class="sourceLineNo">389</span><a id="line.389"> throws RbacObjectNotFoundException, RbacObjectInvalidException, RbacManagerException;</a> |
| <span class="sourceLineNo">390</span><a id="line.390"></a> |
| <span class="sourceLineNo">391</span><a id="line.391"> // ------------------------------------------------------------------</a> |
| <span class="sourceLineNo">392</span><a id="line.392"> // UserAssignment Methods</a> |
| <span class="sourceLineNo">393</span><a id="line.393"> // ------------------------------------------------------------------</a> |
| <span class="sourceLineNo">394</span><a id="line.394"></a> |
| <span class="sourceLineNo">395</span><a id="line.395"> /**</a> |
| <span class="sourceLineNo">396</span><a id="line.396"> * Creates an implementation specific {@link UserAssignment}, or return an existing {@link UserAssignment},</a> |
| <span class="sourceLineNo">397</span><a id="line.397"> * depending on the provided <code>identifier</code> parameter.</a> |
| <span class="sourceLineNo">398</span><a id="line.398"> *</a> |
| <span class="sourceLineNo">399</span><a id="line.399"> * Note: Be sure to use {@link #saveUserAssignment(UserAssignment)} in order to persist any changes to the Role.</a> |
| <span class="sourceLineNo">400</span><a id="line.400"> *</a> |
| <span class="sourceLineNo">401</span><a id="line.401"> * @param principal the principal reference to the user.</a> |
| <span class="sourceLineNo">402</span><a id="line.402"> * @return the new UserAssignment object.</a> |
| <span class="sourceLineNo">403</span><a id="line.403"> * @throws RbacManagerException if the access to the backend datastore failed</a> |
| <span class="sourceLineNo">404</span><a id="line.404"> */</a> |
| <span class="sourceLineNo">405</span><a id="line.405"> UserAssignment createUserAssignment( String principal )</a> |
| <span class="sourceLineNo">406</span><a id="line.406"> throws RbacManagerException;</a> |
| <span class="sourceLineNo">407</span><a id="line.407"></a> |
| <span class="sourceLineNo">408</span><a id="line.408"> boolean userAssignmentExists( String principal );</a> |
| <span class="sourceLineNo">409</span><a id="line.409"></a> |
| <span class="sourceLineNo">410</span><a id="line.410"> boolean userAssignmentExists( UserAssignment assignment );</a> |
| <span class="sourceLineNo">411</span><a id="line.411"></a> |
| <span class="sourceLineNo">412</span><a id="line.412"> /**</a> |
| <span class="sourceLineNo">413</span><a id="line.413"> * Method saveUserAssignment</a> |
| <span class="sourceLineNo">414</span><a id="line.414"> *</a> |
| <span class="sourceLineNo">415</span><a id="line.415"> * @param userAssignment the user assignment instance to save</a> |
| <span class="sourceLineNo">416</span><a id="line.416"> * @throws RbacObjectInvalidException if the instance has invalid data and cannot be saved</a> |
| <span class="sourceLineNo">417</span><a id="line.417"> * @throws RbacManagerException if the access to the backend datastore failed</a> |
| <span class="sourceLineNo">418</span><a id="line.418"> */</a> |
| <span class="sourceLineNo">419</span><a id="line.419"> UserAssignment saveUserAssignment( UserAssignment userAssignment )</a> |
| <span class="sourceLineNo">420</span><a id="line.420"> throws RbacObjectInvalidException, RbacManagerException;</a> |
| <span class="sourceLineNo">421</span><a id="line.421"></a> |
| <span class="sourceLineNo">422</span><a id="line.422"> @SuppressWarnings( "DuplicateThrows" )</a> |
| <span class="sourceLineNo">423</span><a id="line.423"> UserAssignment getUserAssignment( String principal )</a> |
| <span class="sourceLineNo">424</span><a id="line.424"> throws RbacObjectNotFoundException, RbacManagerException;</a> |
| <span class="sourceLineNo">425</span><a id="line.425"></a> |
| <span class="sourceLineNo">426</span><a id="line.426"> /**</a> |
| <span class="sourceLineNo">427</span><a id="line.427"> * Returns all user assignments defined</a> |
| <span class="sourceLineNo">428</span><a id="line.428"> * @return list of assignments</a> |
| <span class="sourceLineNo">429</span><a id="line.429"> * @throws RbacManagerException if the access to the backend datastore failed</a> |
| <span class="sourceLineNo">430</span><a id="line.430"> */</a> |
| <span class="sourceLineNo">431</span><a id="line.431"> List<? extends UserAssignment> getAllUserAssignments()</a> |
| <span class="sourceLineNo">432</span><a id="line.432"> throws RbacManagerException;</a> |
| <span class="sourceLineNo">433</span><a id="line.433"></a> |
| <span class="sourceLineNo">434</span><a id="line.434"> /**</a> |
| <span class="sourceLineNo">435</span><a id="line.435"> * Returns the assignments for the given roles</a> |
| <span class="sourceLineNo">436</span><a id="line.436"> * @param roleIds collection of role names</a> |
| <span class="sourceLineNo">437</span><a id="line.437"> * @throws RbacManagerException if the access to the backend datastore failed</a> |
| <span class="sourceLineNo">438</span><a id="line.438"> */</a> |
| <span class="sourceLineNo">439</span><a id="line.439"> List<? extends UserAssignment> getUserAssignmentsForRoles( Collection<String> roleIds )</a> |
| <span class="sourceLineNo">440</span><a id="line.440"> throws RbacManagerException;</a> |
| <span class="sourceLineNo">441</span><a id="line.441"></a> |
| <span class="sourceLineNo">442</span><a id="line.442"> /**</a> |
| <span class="sourceLineNo">443</span><a id="line.443"> * Method removeAssignment</a> |
| <span class="sourceLineNo">444</span><a id="line.444"> *</a> |
| <span class="sourceLineNo">445</span><a id="line.445"> * @param userAssignment the assignment to remove</a> |
| <span class="sourceLineNo">446</span><a id="line.446"> * @throws RbacObjectNotFoundException if the assignment was not found</a> |
| <span class="sourceLineNo">447</span><a id="line.447"> * @throws RbacObjectInvalidException if the provided assignment instance has invalid data</a> |
| <span class="sourceLineNo">448</span><a id="line.448"> * @throws RbacManagerException if the access to the backend datastore failed</a> |
| <span class="sourceLineNo">449</span><a id="line.449"> */</a> |
| <span class="sourceLineNo">450</span><a id="line.450"> void removeUserAssignment( UserAssignment userAssignment )</a> |
| <span class="sourceLineNo">451</span><a id="line.451"> throws RbacObjectNotFoundException, RbacObjectInvalidException, RbacManagerException;</a> |
| <span class="sourceLineNo">452</span><a id="line.452"></a> |
| <span class="sourceLineNo">453</span><a id="line.453"> /**</a> |
| <span class="sourceLineNo">454</span><a id="line.454"> * Method removeAssignment</a> |
| <span class="sourceLineNo">455</span><a id="line.455"> *</a> |
| <span class="sourceLineNo">456</span><a id="line.456"> * @param principal the principal for which the assignment should be removed</a> |
| <span class="sourceLineNo">457</span><a id="line.457"> * @throws RbacObjectNotFoundException if the user with the given principal name was not found</a> |
| <span class="sourceLineNo">458</span><a id="line.458"> * @throws RbacObjectInvalidException if the principal string was invalid</a> |
| <span class="sourceLineNo">459</span><a id="line.459"> * @throws RbacManagerException if the access to the backend datastore failed</a> |
| <span class="sourceLineNo">460</span><a id="line.460"> */</a> |
| <span class="sourceLineNo">461</span><a id="line.461"> void removeUserAssignment( String principal )</a> |
| <span class="sourceLineNo">462</span><a id="line.462"> throws RbacObjectNotFoundException, RbacObjectInvalidException, RbacManagerException;</a> |
| <span class="sourceLineNo">463</span><a id="line.463"></a> |
| <span class="sourceLineNo">464</span><a id="line.464"> // ------------------------------------------------------------------</a> |
| <span class="sourceLineNo">465</span><a id="line.465"> // UserAssignment Utility Methods</a> |
| <span class="sourceLineNo">466</span><a id="line.466"> // ------------------------------------------------------------------</a> |
| <span class="sourceLineNo">467</span><a id="line.467"></a> |
| <span class="sourceLineNo">468</span><a id="line.468"> /**</a> |
| <span class="sourceLineNo">469</span><a id="line.469"> * Returns the active roles for a given principal</a> |
| <span class="sourceLineNo">470</span><a id="line.470"> *</a> |
| <span class="sourceLineNo">471</span><a id="line.471"> * NOTE: roles that are returned might have parent roles themselves, if</a> |
| <span class="sourceLineNo">472</span><a id="line.472"> * you just want all permissions then use {@link #getAssignedPermissions(String principal)}</a> |
| <span class="sourceLineNo">473</span><a id="line.473"> *</a> |
| <span class="sourceLineNo">474</span><a id="line.474"> * @param principal the user principal to search for assignments</a> |
| <span class="sourceLineNo">475</span><a id="line.475"> * @return Collection of {@link Role} objects.</a> |
| <span class="sourceLineNo">476</span><a id="line.476"> * @throws RbacObjectNotFoundException if the user with the given principal name was not found</a> |
| <span class="sourceLineNo">477</span><a id="line.477"> * @throws RbacManagerException if the access to the backend datastore failed</a> |
| <span class="sourceLineNo">478</span><a id="line.478"> */</a> |
| <span class="sourceLineNo">479</span><a id="line.479"> Collection<? extends Role> getAssignedRoles( String principal )</a> |
| <span class="sourceLineNo">480</span><a id="line.480"> throws RbacObjectNotFoundException, RbacManagerException;</a> |
| <span class="sourceLineNo">481</span><a id="line.481"></a> |
| <span class="sourceLineNo">482</span><a id="line.482"> /**</a> |
| <span class="sourceLineNo">483</span><a id="line.483"> * Get the Collection of {@link Role} objects for this UserAssignment.</a> |
| <span class="sourceLineNo">484</span><a id="line.484"> *</a> |
| <span class="sourceLineNo">485</span><a id="line.485"> * @param userAssignment the user assignment instance</a> |
| <span class="sourceLineNo">486</span><a id="line.486"> * @return Collection of {@link Role} objects for the provided UserAssignment.</a> |
| <span class="sourceLineNo">487</span><a id="line.487"> * @throws RbacObjectNotFoundException if the assignment could not be found</a> |
| <span class="sourceLineNo">488</span><a id="line.488"> * @throws RbacManagerException if the access to the backend datastore failed</a> |
| <span class="sourceLineNo">489</span><a id="line.489"> */</a> |
| <span class="sourceLineNo">490</span><a id="line.490"> Collection<? extends Role> getAssignedRoles( UserAssignment userAssignment )</a> |
| <span class="sourceLineNo">491</span><a id="line.491"> throws RbacObjectNotFoundException, RbacManagerException;</a> |
| <span class="sourceLineNo">492</span><a id="line.492"></a> |
| <span class="sourceLineNo">493</span><a id="line.493"> /**</a> |
| <span class="sourceLineNo">494</span><a id="line.494"> * Get a list of all assignable roles that are currently not effectively assigned to the specific user,</a> |
| <span class="sourceLineNo">495</span><a id="line.495"> * meaning, not a child of any already granted role</a> |
| <span class="sourceLineNo">496</span><a id="line.496"> *</a> |
| <span class="sourceLineNo">497</span><a id="line.497"> * @param principal the user principal</a> |
| <span class="sourceLineNo">498</span><a id="line.498"> * @return the list of roles, that are currently not assigned to the user, or a empty list, if no such role was found.</a> |
| <span class="sourceLineNo">499</span><a id="line.499"> * @throws RbacManagerException if the access to the backend datastore failed</a> |
| <span class="sourceLineNo">500</span><a id="line.500"> * @throws RbacObjectNotFoundException if the user with the given principal was not found</a> |
| <span class="sourceLineNo">501</span><a id="line.501"> */</a> |
| <span class="sourceLineNo">502</span><a id="line.502"> Collection<? extends Role> getEffectivelyUnassignedRoles( String principal )</a> |
| <span class="sourceLineNo">503</span><a id="line.503"> throws RbacManagerException, RbacObjectNotFoundException;</a> |
| <span class="sourceLineNo">504</span><a id="line.504"></a> |
| <span class="sourceLineNo">505</span><a id="line.505"> /**</a> |
| <span class="sourceLineNo">506</span><a id="line.506"> * Get a list of the effectively assigned roles to the specified user, this includes child roles</a> |
| <span class="sourceLineNo">507</span><a id="line.507"> *</a> |
| <span class="sourceLineNo">508</span><a id="line.508"> * @param principal the user principal</a> |
| <span class="sourceLineNo">509</span><a id="line.509"> * @return the list of roles effectively assigned to the given user</a> |
| <span class="sourceLineNo">510</span><a id="line.510"> * @throws RbacObjectNotFoundException if the user with the given principal was not found</a> |
| <span class="sourceLineNo">511</span><a id="line.511"> * @throws RbacManagerException if the access to the backend datastore failed</a> |
| <span class="sourceLineNo">512</span><a id="line.512"> */</a> |
| <span class="sourceLineNo">513</span><a id="line.513"> Collection<? extends Role> getEffectivelyAssignedRoles( String principal )</a> |
| <span class="sourceLineNo">514</span><a id="line.514"> throws RbacObjectNotFoundException, RbacManagerException;</a> |
| <span class="sourceLineNo">515</span><a id="line.515"></a> |
| <span class="sourceLineNo">516</span><a id="line.516"> /**</a> |
| <span class="sourceLineNo">517</span><a id="line.517"> * Get a list of all assignable roles that are currently not assigned to the specific user.</a> |
| <span class="sourceLineNo">518</span><a id="line.518"> *</a> |
| <span class="sourceLineNo">519</span><a id="line.519"> * @param principal the user principal name</a> |
| <span class="sourceLineNo">520</span><a id="line.520"> * @return the list of roles not assigned to the given user</a> |
| <span class="sourceLineNo">521</span><a id="line.521"> * @throws RbacManagerException if the access to the backend datastore failed</a> |
| <span class="sourceLineNo">522</span><a id="line.522"> * @throws RbacObjectNotFoundException if the user with the given principal was not found</a> |
| <span class="sourceLineNo">523</span><a id="line.523"> */</a> |
| <span class="sourceLineNo">524</span><a id="line.524"> Collection<? extends Role> getUnassignedRoles( String principal )</a> |
| <span class="sourceLineNo">525</span><a id="line.525"> throws RbacManagerException, RbacObjectNotFoundException;</a> |
| <span class="sourceLineNo">526</span><a id="line.526"></a> |
| <span class="sourceLineNo">527</span><a id="line.527"> /**</a> |
| <span class="sourceLineNo">528</span><a id="line.528"> * Returns a set of all permissions that are in all active roles for a given</a> |
| <span class="sourceLineNo">529</span><a id="line.529"> * principal. This includes permissions from all assigned parent roles.</a> |
| <span class="sourceLineNo">530</span><a id="line.530"> *</a> |
| <span class="sourceLineNo">531</span><a id="line.531"> * @param principal the user principal name</a> |
| <span class="sourceLineNo">532</span><a id="line.532"> * @return the list of all permissions assigned to the user</a> |
| <span class="sourceLineNo">533</span><a id="line.533"> * @throws RbacObjectNotFoundException if the user with the given principal name was not found</a> |
| <span class="sourceLineNo">534</span><a id="line.534"> * @throws RbacManagerException if the access to the backend datastore failed</a> |
| <span class="sourceLineNo">535</span><a id="line.535"> */</a> |
| <span class="sourceLineNo">536</span><a id="line.536"> Set<? extends Permission> getAssignedPermissions( String principal )</a> |
| <span class="sourceLineNo">537</span><a id="line.537"> throws RbacObjectNotFoundException, RbacManagerException;</a> |
| <span class="sourceLineNo">538</span><a id="line.538"></a> |
| <span class="sourceLineNo">539</span><a id="line.539"> /**</a> |
| <span class="sourceLineNo">540</span><a id="line.540"> * returns a map of assigned permissions keyed off of operation with a list value of Permissions</a> |
| <span class="sourceLineNo">541</span><a id="line.541"> *</a> |
| <span class="sourceLineNo">542</span><a id="line.542"> * @param principal the user principal name</a> |
| <span class="sourceLineNo">543</span><a id="line.543"> * @return the map of (operation,permission list) pairs</a> |
| <span class="sourceLineNo">544</span><a id="line.544"> * @throws RbacObjectNotFoundException if the user with the given principal was not found</a> |
| <span class="sourceLineNo">545</span><a id="line.545"> * @throws RbacManagerException if the access to the backend datastore failed</a> |
| <span class="sourceLineNo">546</span><a id="line.546"> */</a> |
| <span class="sourceLineNo">547</span><a id="line.547"> Map<String, List<? extends Permission>> getAssignedPermissionMap( String principal )</a> |
| <span class="sourceLineNo">548</span><a id="line.548"> throws RbacObjectNotFoundException, RbacManagerException;</a> |
| <span class="sourceLineNo">549</span><a id="line.549"></a> |
| <span class="sourceLineNo">550</span><a id="line.550"> /**</a> |
| <span class="sourceLineNo">551</span><a id="line.551"> * Returns a list of all assignable roles</a> |
| <span class="sourceLineNo">552</span><a id="line.552"> *</a> |
| <span class="sourceLineNo">553</span><a id="line.553"> * @return list of assignable roles</a> |
| <span class="sourceLineNo">554</span><a id="line.554"> * @throws RbacManagerException if the access to the backend datastore failed</a> |
| <span class="sourceLineNo">555</span><a id="line.555"> */</a> |
| <span class="sourceLineNo">556</span><a id="line.556"> List<? extends Role> getAllAssignableRoles()</a> |
| <span class="sourceLineNo">557</span><a id="line.557"> throws RbacManagerException;</a> |
| <span class="sourceLineNo">558</span><a id="line.558"></a> |
| <span class="sourceLineNo">559</span><a id="line.559"> /**</a> |
| <span class="sourceLineNo">560</span><a id="line.560"> * Returns the global resource object</a> |
| <span class="sourceLineNo">561</span><a id="line.561"> *</a> |
| <span class="sourceLineNo">562</span><a id="line.562"> * @return the global resource object</a> |
| <span class="sourceLineNo">563</span><a id="line.563"> * @throws RbacManagerException if the access to the backend datastore failed</a> |
| <span class="sourceLineNo">564</span><a id="line.564"> */</a> |
| <span class="sourceLineNo">565</span><a id="line.565"> Resource getGlobalResource()</a> |
| <span class="sourceLineNo">566</span><a id="line.566"> throws RbacManagerException;</a> |
| <span class="sourceLineNo">567</span><a id="line.567"></a> |
| <span class="sourceLineNo">568</span><a id="line.568"> void eraseDatabase();</a> |
| <span class="sourceLineNo">569</span><a id="line.569"></a> |
| <span class="sourceLineNo">570</span><a id="line.570"> /**</a> |
| <span class="sourceLineNo">571</span><a id="line.571"> * consumer of user manager can use it to reload various configuration</a> |
| <span class="sourceLineNo">572</span><a id="line.572"> * with the configurable implementation is possible to change dynamically the real implementation used.</a> |
| <span class="sourceLineNo">573</span><a id="line.573"> *</a> |
| <span class="sourceLineNo">574</span><a id="line.574"> * @since 2.1</a> |
| <span class="sourceLineNo">575</span><a id="line.575"> */</a> |
| <span class="sourceLineNo">576</span><a id="line.576"> void initialize();</a> |
| <span class="sourceLineNo">577</span><a id="line.577"></a> |
| <span class="sourceLineNo">578</span><a id="line.578"> /**</a> |
| <span class="sourceLineNo">579</span><a id="line.579"> * @return true if this implementation is a final one and not a wrapper (configurable, cached)</a> |
| <span class="sourceLineNo">580</span><a id="line.580"> * @since 2.1</a> |
| <span class="sourceLineNo">581</span><a id="line.581"> */</a> |
| <span class="sourceLineNo">582</span><a id="line.582"> boolean isFinalImplementation();</a> |
| <span class="sourceLineNo">583</span><a id="line.583"></a> |
| <span class="sourceLineNo">584</span><a id="line.584"> /**</a> |
| <span class="sourceLineNo">585</span><a id="line.585"> * @return a key to be able to customize label in UI</a> |
| <span class="sourceLineNo">586</span><a id="line.586"> * @since 2.1</a> |
| <span class="sourceLineNo">587</span><a id="line.587"> */</a> |
| <span class="sourceLineNo">588</span><a id="line.588"> String getDescriptionKey();</a> |
| <span class="sourceLineNo">589</span><a id="line.589"></a> |
| <span class="sourceLineNo">590</span><a id="line.590"> /**</a> |
| <span class="sourceLineNo">591</span><a id="line.591"> * Is the RBACManager read only? if so then create and modify actions are to be disabled</a> |
| <span class="sourceLineNo">592</span><a id="line.592"> *</a> |
| <span class="sourceLineNo">593</span><a id="line.593"> * @return boolean true if user manager is read only</a> |
| <span class="sourceLineNo">594</span><a id="line.594"> */</a> |
| <span class="sourceLineNo">595</span><a id="line.595"> boolean isReadOnly();</a> |
| <span class="sourceLineNo">596</span><a id="line.596">}</a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
