| <!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.role;</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 org.apache.archiva.redback.role.model.RedbackRoleModel;</a> |
| <span class="sourceLineNo">023</span><a id="line.23"></a> |
| <span class="sourceLineNo">024</span><a id="line.24">import java.net.URL;</a> |
| <span class="sourceLineNo">025</span><a id="line.25"></a> |
| <span class="sourceLineNo">026</span><a id="line.26">/**</a> |
| <span class="sourceLineNo">027</span><a id="line.27"> * RoleProfileManager:</a> |
| <span class="sourceLineNo">028</span><a id="line.28"> *</a> |
| <span class="sourceLineNo">029</span><a id="line.29"> * @author: Jesse McConnell</a> |
| <span class="sourceLineNo">030</span><a id="line.30"> *</a> |
| <span class="sourceLineNo">031</span><a id="line.31"> */</a> |
| <span class="sourceLineNo">032</span><a id="line.32">public interface RoleManager</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"> /**</a> |
| <span class="sourceLineNo">036</span><a id="line.36"> * load the model and create/verify operations, resources, etc exist and make static roles</a> |
| <span class="sourceLineNo">037</span><a id="line.37"> *</a> |
| <span class="sourceLineNo">038</span><a id="line.38"> * @param resourceLocation</a> |
| <span class="sourceLineNo">039</span><a id="line.39"> * @throws RoleManagerException</a> |
| <span class="sourceLineNo">040</span><a id="line.40"> */</a> |
| <span class="sourceLineNo">041</span><a id="line.41"> void loadRoleModel( URL resourceLocation )</a> |
| <span class="sourceLineNo">042</span><a id="line.42"> throws RoleManagerException;</a> |
| <span class="sourceLineNo">043</span><a id="line.43"></a> |
| <span class="sourceLineNo">044</span><a id="line.44"> void loadRoleModel( RedbackRoleModel model )</a> |
| <span class="sourceLineNo">045</span><a id="line.45"> throws RoleManagerException;</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"> * locate a role with the corresponding name and generate it with the given resource, ${resource}</a> |
| <span class="sourceLineNo">049</span><a id="line.49"> * in the model will be replaced with this resource string, if this resource does not exist, it</a> |
| <span class="sourceLineNo">050</span><a id="line.50"> * will be created.</a> |
| <span class="sourceLineNo">051</span><a id="line.51"> *</a> |
| <span class="sourceLineNo">052</span><a id="line.52"> * @param templateId</a> |
| <span class="sourceLineNo">053</span><a id="line.53"> * @param resource</a> |
| <span class="sourceLineNo">054</span><a id="line.54"> * @throws RoleManagerException</a> |
| <span class="sourceLineNo">055</span><a id="line.55"> */</a> |
| <span class="sourceLineNo">056</span><a id="line.56"> String createTemplatedRole( String templateId, String resource )</a> |
| <span class="sourceLineNo">057</span><a id="line.57"> throws RoleManagerException;</a> |
| <span class="sourceLineNo">058</span><a id="line.58"></a> |
| <span class="sourceLineNo">059</span><a id="line.59"> /**</a> |
| <span class="sourceLineNo">060</span><a id="line.60"> * removes a role corresponding to the role Id that was manufactured with the given resource</a> |
| <span class="sourceLineNo">061</span><a id="line.61"> *</a> |
| <span class="sourceLineNo">062</span><a id="line.62"> * it also removes any user assignments for that role</a> |
| <span class="sourceLineNo">063</span><a id="line.63"> *</a> |
| <span class="sourceLineNo">064</span><a id="line.64"> * @param templateId</a> |
| <span class="sourceLineNo">065</span><a id="line.65"> * @param resource</a> |
| <span class="sourceLineNo">066</span><a id="line.66"> * @throws RoleManagerException</a> |
| <span class="sourceLineNo">067</span><a id="line.67"> */</a> |
| <span class="sourceLineNo">068</span><a id="line.68"> void removeTemplatedRole( String templateId, String resource )</a> |
| <span class="sourceLineNo">069</span><a id="line.69"> throws RoleManagerException;</a> |
| <span class="sourceLineNo">070</span><a id="line.70"></a> |
| <span class="sourceLineNo">071</span><a id="line.71"></a> |
| <span class="sourceLineNo">072</span><a id="line.72"> /**</a> |
| <span class="sourceLineNo">073</span><a id="line.73"> * Moves the instance of the templated role from the old resource to the new resource and updates the</a> |
| <span class="sourceLineNo">074</span><a id="line.74"> * user assignments.</a> |
| <span class="sourceLineNo">075</span><a id="line.75"> *</a> |
| <span class="sourceLineNo">076</span><a id="line.76"> * @param templateId the name of the role template</a> |
| <span class="sourceLineNo">077</span><a id="line.77"> * @param oldResource the old resource name</a> |
| <span class="sourceLineNo">078</span><a id="line.78"> * @param newResource the new resource name</a> |
| <span class="sourceLineNo">079</span><a id="line.79"> * @throws RoleManagerException</a> |
| <span class="sourceLineNo">080</span><a id="line.80"> */</a> |
| <span class="sourceLineNo">081</span><a id="line.81"> String moveTemplatedRole( String templateId, String oldResource, String newResource )</a> |
| <span class="sourceLineNo">082</span><a id="line.82"> throws RoleManagerException;</a> |
| <span class="sourceLineNo">083</span><a id="line.83"></a> |
| <span class="sourceLineNo">084</span><a id="line.84"></a> |
| <span class="sourceLineNo">085</span><a id="line.85"> /**</a> |
| <span class="sourceLineNo">086</span><a id="line.86"> * Assigns the role indicated by the roleId to the given principal</a> |
| <span class="sourceLineNo">087</span><a id="line.87"> *</a> |
| <span class="sourceLineNo">088</span><a id="line.88"> * @param roleId</a> |
| <span class="sourceLineNo">089</span><a id="line.89"> * @param principal</a> |
| <span class="sourceLineNo">090</span><a id="line.90"> * @throws RoleManagerException</a> |
| <span class="sourceLineNo">091</span><a id="line.91"> */</a> |
| <span class="sourceLineNo">092</span><a id="line.92"> void assignRole( String roleId, String principal )</a> |
| <span class="sourceLineNo">093</span><a id="line.93"> throws RoleManagerException;</a> |
| <span class="sourceLineNo">094</span><a id="line.94"></a> |
| <span class="sourceLineNo">095</span><a id="line.95"> /**</a> |
| <span class="sourceLineNo">096</span><a id="line.96"> * Assigns the role indicated by the roleName to the given principal</a> |
| <span class="sourceLineNo">097</span><a id="line.97"> *</a> |
| <span class="sourceLineNo">098</span><a id="line.98"> * @param roleName</a> |
| <span class="sourceLineNo">099</span><a id="line.99"> * @param principal</a> |
| <span class="sourceLineNo">100</span><a id="line.100"> * @throws RoleManagerException</a> |
| <span class="sourceLineNo">101</span><a id="line.101"> */</a> |
| <span class="sourceLineNo">102</span><a id="line.102"> void assignRoleByName( String roleName, String principal )</a> |
| <span class="sourceLineNo">103</span><a id="line.103"> throws RoleManagerException;</a> |
| <span class="sourceLineNo">104</span><a id="line.104"></a> |
| <span class="sourceLineNo">105</span><a id="line.105"> /**</a> |
| <span class="sourceLineNo">106</span><a id="line.106"> * Assigns the templated role indicated by the templateId</a> |
| <span class="sourceLineNo">107</span><a id="line.107"> *</a> |
| <span class="sourceLineNo">108</span><a id="line.108"> * fails if the templated role has not been created</a> |
| <span class="sourceLineNo">109</span><a id="line.109"> *</a> |
| <span class="sourceLineNo">110</span><a id="line.110"> * @param templateId</a> |
| <span class="sourceLineNo">111</span><a id="line.111"> * @param resource</a> |
| <span class="sourceLineNo">112</span><a id="line.112"> * @param principal</a> |
| <span class="sourceLineNo">113</span><a id="line.113"> */</a> |
| <span class="sourceLineNo">114</span><a id="line.114"> void assignTemplatedRole( String templateId, String resource, String principal )</a> |
| <span class="sourceLineNo">115</span><a id="line.115"> throws RoleManagerException;</a> |
| <span class="sourceLineNo">116</span><a id="line.116"></a> |
| <span class="sourceLineNo">117</span><a id="line.117"> /**</a> |
| <span class="sourceLineNo">118</span><a id="line.118"> * Unassigns the role indicated by the role id from the given principal</a> |
| <span class="sourceLineNo">119</span><a id="line.119"> *</a> |
| <span class="sourceLineNo">120</span><a id="line.120"> * @param roleId</a> |
| <span class="sourceLineNo">121</span><a id="line.121"> * @param principal</a> |
| <span class="sourceLineNo">122</span><a id="line.122"> * @throws RoleManagerException</a> |
| <span class="sourceLineNo">123</span><a id="line.123"> */</a> |
| <span class="sourceLineNo">124</span><a id="line.124"> void unassignRole( String roleId, String principal )</a> |
| <span class="sourceLineNo">125</span><a id="line.125"> throws RoleManagerException;</a> |
| <span class="sourceLineNo">126</span><a id="line.126"></a> |
| <span class="sourceLineNo">127</span><a id="line.127"> /**</a> |
| <span class="sourceLineNo">128</span><a id="line.128"> * Unassigns the role indicated by the role name from the given principal</a> |
| <span class="sourceLineNo">129</span><a id="line.129"> *</a> |
| <span class="sourceLineNo">130</span><a id="line.130"> * @param roleName</a> |
| <span class="sourceLineNo">131</span><a id="line.131"> * @param principal</a> |
| <span class="sourceLineNo">132</span><a id="line.132"> * @throws RoleManagerException</a> |
| <span class="sourceLineNo">133</span><a id="line.133"> */</a> |
| <span class="sourceLineNo">134</span><a id="line.134"> void unassignRoleByName( String roleName, String principal )</a> |
| <span class="sourceLineNo">135</span><a id="line.135"> throws RoleManagerException;</a> |
| <span class="sourceLineNo">136</span><a id="line.136"></a> |
| <span class="sourceLineNo">137</span><a id="line.137"> /**</a> |
| <span class="sourceLineNo">138</span><a id="line.138"> * true of a role exists with the given roleId</a> |
| <span class="sourceLineNo">139</span><a id="line.139"> *</a> |
| <span class="sourceLineNo">140</span><a id="line.140"> * @param roleId</a> |
| <span class="sourceLineNo">141</span><a id="line.141"> * @return</a> |
| <span class="sourceLineNo">142</span><a id="line.142"> * @throws RoleManagerException</a> |
| <span class="sourceLineNo">143</span><a id="line.143"> */</a> |
| <span class="sourceLineNo">144</span><a id="line.144"> boolean roleExists( String roleId )</a> |
| <span class="sourceLineNo">145</span><a id="line.145"> throws RoleManagerException;</a> |
| <span class="sourceLineNo">146</span><a id="line.146"></a> |
| <span class="sourceLineNo">147</span><a id="line.147"> /**</a> |
| <span class="sourceLineNo">148</span><a id="line.148"> * true of a role exists with the given roleId</a> |
| <span class="sourceLineNo">149</span><a id="line.149"> *</a> |
| <span class="sourceLineNo">150</span><a id="line.150"> * @param templateId</a> |
| <span class="sourceLineNo">151</span><a id="line.151"> * @param resource</a> |
| <span class="sourceLineNo">152</span><a id="line.152"> * @return</a> |
| <span class="sourceLineNo">153</span><a id="line.153"> * @throws RoleManagerException</a> |
| <span class="sourceLineNo">154</span><a id="line.154"> */</a> |
| <span class="sourceLineNo">155</span><a id="line.155"> boolean templatedRoleExists( String templateId, String resource )</a> |
| <span class="sourceLineNo">156</span><a id="line.156"> throws RoleManagerException;</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"> * get the blessed model, the current operating instructions for all things role management</a> |
| <span class="sourceLineNo">160</span><a id="line.160"> */</a> |
| <span class="sourceLineNo">161</span><a id="line.161"> RedbackRoleModel getModel();</a> |
| <span class="sourceLineNo">162</span><a id="line.162"></a> |
| <span class="sourceLineNo">163</span><a id="line.163"> /**</a> |
| <span class="sourceLineNo">164</span><a id="line.164"> * Check a role template is complete in the RBAC store.</a> |
| <span class="sourceLineNo">165</span><a id="line.165"> *</a> |
| <span class="sourceLineNo">166</span><a id="line.166"> * @param templateID the templated role</a> |
| <span class="sourceLineNo">167</span><a id="line.167"> * @param resource the resource to verify</a> |
| <span class="sourceLineNo">168</span><a id="line.168"> * @throws RoleManagerException</a> |
| <span class="sourceLineNo">169</span><a id="line.169"> */</a> |
| <span class="sourceLineNo">170</span><a id="line.170"> void verifyTemplatedRole( String templateID, String resource )</a> |
| <span class="sourceLineNo">171</span><a id="line.171"> throws RoleManagerException;</a> |
| <span class="sourceLineNo">172</span><a id="line.172"></a> |
| <span class="sourceLineNo">173</span><a id="line.173"> /**</a> |
| <span class="sourceLineNo">174</span><a id="line.174"> * intialize the role manager</a> |
| <span class="sourceLineNo">175</span><a id="line.175"> * @since 2.1</a> |
| <span class="sourceLineNo">176</span><a id="line.176"> */</a> |
| <span class="sourceLineNo">177</span><a id="line.177"> void initialize();</a> |
| <span class="sourceLineNo">178</span><a id="line.178">}</a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
