blob: e0b21d209b1168236b8ee94cca87a2e0c35baf5e [file] [log] [blame]
<!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.rest.api.services;</a>
<span class="sourceLineNo">002</span><a id="line.2">/*</a>
<span class="sourceLineNo">003</span><a id="line.3"> * Licensed to the Apache Software Foundation (ASF) under one</a>
<span class="sourceLineNo">004</span><a id="line.4"> * or more contributor license agreements. See the NOTICE file</a>
<span class="sourceLineNo">005</span><a id="line.5"> * distributed with this work for additional information</a>
<span class="sourceLineNo">006</span><a id="line.6"> * regarding copyright ownership. The ASF licenses this file</a>
<span class="sourceLineNo">007</span><a id="line.7"> * to you under the Apache License, Version 2.0 (the</a>
<span class="sourceLineNo">008</span><a id="line.8"> * "License"); you may not use this file except in compliance</a>
<span class="sourceLineNo">009</span><a id="line.9"> * with the License. You may obtain a copy of the License at</a>
<span class="sourceLineNo">010</span><a id="line.10"> *</a>
<span class="sourceLineNo">011</span><a id="line.11"> * http://www.apache.org/licenses/LICENSE-2.0</a>
<span class="sourceLineNo">012</span><a id="line.12"> *</a>
<span class="sourceLineNo">013</span><a id="line.13"> * Unless required by applicable law or agreed to in writing,</a>
<span class="sourceLineNo">014</span><a id="line.14"> * software distributed under the License is distributed on an</a>
<span class="sourceLineNo">015</span><a id="line.15"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</a>
<span class="sourceLineNo">016</span><a id="line.16"> * KIND, either express or implied. See the License for the</a>
<span class="sourceLineNo">017</span><a id="line.17"> * specific language governing permissions and limitations</a>
<span class="sourceLineNo">018</span><a id="line.18"> * under the License.</a>
<span class="sourceLineNo">019</span><a id="line.19"> */</a>
<span class="sourceLineNo">020</span><a id="line.20"></a>
<span class="sourceLineNo">021</span><a id="line.21">import org.apache.archiva.redback.authorization.RedbackAuthorization;</a>
<span class="sourceLineNo">022</span><a id="line.22">import org.apache.archiva.redback.integration.security.role.RedbackRoleConstants;</a>
<span class="sourceLineNo">023</span><a id="line.23">import org.apache.archiva.redback.rest.api.model.ActionStatus;</a>
<span class="sourceLineNo">024</span><a id="line.24">import org.apache.archiva.redback.rest.api.model.Application;</a>
<span class="sourceLineNo">025</span><a id="line.25">import org.apache.archiva.redback.rest.api.model.ApplicationRoles;</a>
<span class="sourceLineNo">026</span><a id="line.26">import org.apache.archiva.redback.rest.api.model.v2.AvailabilityStatus;</a>
<span class="sourceLineNo">027</span><a id="line.27">import org.apache.archiva.redback.rest.api.model.Role;</a>
<span class="sourceLineNo">028</span><a id="line.28">import org.apache.archiva.redback.rest.api.model.User;</a>
<span class="sourceLineNo">029</span><a id="line.29">import org.apache.archiva.redback.rest.api.model.VerificationStatus;</a>
<span class="sourceLineNo">030</span><a id="line.30"></a>
<span class="sourceLineNo">031</span><a id="line.31">import javax.ws.rs.Consumes;</a>
<span class="sourceLineNo">032</span><a id="line.32">import javax.ws.rs.GET;</a>
<span class="sourceLineNo">033</span><a id="line.33">import javax.ws.rs.POST;</a>
<span class="sourceLineNo">034</span><a id="line.34">import javax.ws.rs.Path;</a>
<span class="sourceLineNo">035</span><a id="line.35">import javax.ws.rs.PathParam;</a>
<span class="sourceLineNo">036</span><a id="line.36">import javax.ws.rs.Produces;</a>
<span class="sourceLineNo">037</span><a id="line.37">import javax.ws.rs.QueryParam;</a>
<span class="sourceLineNo">038</span><a id="line.38">import javax.ws.rs.core.MediaType;</a>
<span class="sourceLineNo">039</span><a id="line.39">import java.util.List;</a>
<span class="sourceLineNo">040</span><a id="line.40"></a>
<span class="sourceLineNo">041</span><a id="line.41">/**</a>
<span class="sourceLineNo">042</span><a id="line.42"> *</a>
<span class="sourceLineNo">043</span><a id="line.43"> * @deprecated Use the new v2 service {@link org.apache.archiva.redback.rest.api.services.v2.RoleService}</a>
<span class="sourceLineNo">044</span><a id="line.44"> * @author Olivier Lamy</a>
<span class="sourceLineNo">045</span><a id="line.45"> */</a>
<span class="sourceLineNo">046</span><a id="line.46">@Deprecated</a>
<span class="sourceLineNo">047</span><a id="line.47">@Path( "/roleManagementService/" )</a>
<span class="sourceLineNo">048</span><a id="line.48">public interface RoleManagementService</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"> @Path( "createTemplatedRole" )</a>
<span class="sourceLineNo">052</span><a id="line.52"> @GET</a>
<span class="sourceLineNo">053</span><a id="line.53"> @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )</a>
<span class="sourceLineNo">054</span><a id="line.54"> @RedbackAuthorization( permissions = RedbackRoleConstants.USER_MANAGEMENT_RBAC_ADMIN_OPERATION )</a>
<span class="sourceLineNo">055</span><a id="line.55"> ActionStatus createTemplatedRole( @QueryParam( "templateId" ) String templateId,</a>
<span class="sourceLineNo">056</span><a id="line.56"> @QueryParam( "resource" ) String resource )</a>
<span class="sourceLineNo">057</span><a id="line.57"> throws RedbackServiceException;</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"> */</a>
<span class="sourceLineNo">067</span><a id="line.67"> @Path( "removeTemplatedRole" )</a>
<span class="sourceLineNo">068</span><a id="line.68"> @GET</a>
<span class="sourceLineNo">069</span><a id="line.69"> @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )</a>
<span class="sourceLineNo">070</span><a id="line.70"> @RedbackAuthorization( permissions = RedbackRoleConstants.USER_MANAGEMENT_RBAC_ADMIN_OPERATION )</a>
<span class="sourceLineNo">071</span><a id="line.71"> ActionStatus removeTemplatedRole( @QueryParam( "templateId" ) String templateId,</a>
<span class="sourceLineNo">072</span><a id="line.72"> @QueryParam( "resource" ) String resource )</a>
<span class="sourceLineNo">073</span><a id="line.73"> throws RedbackServiceException;</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"> /**</a>
<span class="sourceLineNo">077</span><a id="line.77"> * allows for a role coming from a template to be renamed effectively swapping out the bits of it that</a>
<span class="sourceLineNo">078</span><a id="line.78"> * were labeled with the oldResource with the newResource</a>
<span class="sourceLineNo">079</span><a id="line.79"> *</a>
<span class="sourceLineNo">080</span><a id="line.80"> * it also manages any user assignments for that role</a>
<span class="sourceLineNo">081</span><a id="line.81"> *</a>
<span class="sourceLineNo">082</span><a id="line.82"> * @param templateId</a>
<span class="sourceLineNo">083</span><a id="line.83"> * @param oldResource</a>
<span class="sourceLineNo">084</span><a id="line.84"> * @param newResource</a>
<span class="sourceLineNo">085</span><a id="line.85"> */</a>
<span class="sourceLineNo">086</span><a id="line.86"> @Path( "updateRole" )</a>
<span class="sourceLineNo">087</span><a id="line.87"> @GET</a>
<span class="sourceLineNo">088</span><a id="line.88"> @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )</a>
<span class="sourceLineNo">089</span><a id="line.89"> @RedbackAuthorization( permissions = RedbackRoleConstants.USER_MANAGEMENT_RBAC_ADMIN_OPERATION )</a>
<span class="sourceLineNo">090</span><a id="line.90"> ActionStatus updateRole( @QueryParam( "templateId" ) String templateId, @QueryParam( "oldResource" ) String oldResource,</a>
<span class="sourceLineNo">091</span><a id="line.91"> @QueryParam( "newResource" ) String newResource )</a>
<span class="sourceLineNo">092</span><a id="line.92"> throws RedbackServiceException;</a>
<span class="sourceLineNo">093</span><a id="line.93"></a>
<span class="sourceLineNo">094</span><a id="line.94"></a>
<span class="sourceLineNo">095</span><a id="line.95"> /**</a>
<span class="sourceLineNo">096</span><a id="line.96"> * Assigns the role indicated by the roleId 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 roleId</a>
<span class="sourceLineNo">099</span><a id="line.99"> * @param principal</a>
<span class="sourceLineNo">100</span><a id="line.100"> */</a>
<span class="sourceLineNo">101</span><a id="line.101"> @Path( "assignRole" )</a>
<span class="sourceLineNo">102</span><a id="line.102"> @GET</a>
<span class="sourceLineNo">103</span><a id="line.103"> @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )</a>
<span class="sourceLineNo">104</span><a id="line.104"> @RedbackAuthorization( permissions = RedbackRoleConstants.USER_MANAGEMENT_RBAC_ADMIN_OPERATION )</a>
<span class="sourceLineNo">105</span><a id="line.105"> ActionStatus assignRole( @QueryParam( "roleId" ) String roleId, @QueryParam( "principal" ) String principal )</a>
<span class="sourceLineNo">106</span><a id="line.106"> throws RedbackServiceException;</a>
<span class="sourceLineNo">107</span><a id="line.107"></a>
<span class="sourceLineNo">108</span><a id="line.108"> /**</a>
<span class="sourceLineNo">109</span><a id="line.109"> * Assigns the role indicated by the roleName to the given principal</a>
<span class="sourceLineNo">110</span><a id="line.110"> *</a>
<span class="sourceLineNo">111</span><a id="line.111"> * @param roleName</a>
<span class="sourceLineNo">112</span><a id="line.112"> * @param principal</a>
<span class="sourceLineNo">113</span><a id="line.113"> * @throws RedbackServiceException</a>
<span class="sourceLineNo">114</span><a id="line.114"> */</a>
<span class="sourceLineNo">115</span><a id="line.115"> @Path( "assignRoleByName" )</a>
<span class="sourceLineNo">116</span><a id="line.116"> @GET</a>
<span class="sourceLineNo">117</span><a id="line.117"> @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )</a>
<span class="sourceLineNo">118</span><a id="line.118"> @RedbackAuthorization( permissions = RedbackRoleConstants.USER_MANAGEMENT_RBAC_ADMIN_OPERATION )</a>
<span class="sourceLineNo">119</span><a id="line.119"> ActionStatus assignRoleByName( @QueryParam( "roleName" ) String roleName, @QueryParam( "principal" ) String principal )</a>
<span class="sourceLineNo">120</span><a id="line.120"> throws RedbackServiceException;</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"> * Assigns the templated role indicated by the templateId</a>
<span class="sourceLineNo">124</span><a id="line.124"> *</a>
<span class="sourceLineNo">125</span><a id="line.125"> * fails if the templated role has not been created</a>
<span class="sourceLineNo">126</span><a id="line.126"> *</a>
<span class="sourceLineNo">127</span><a id="line.127"> * @param templateId</a>
<span class="sourceLineNo">128</span><a id="line.128"> * @param resource</a>
<span class="sourceLineNo">129</span><a id="line.129"> * @param principal</a>
<span class="sourceLineNo">130</span><a id="line.130"> */</a>
<span class="sourceLineNo">131</span><a id="line.131"> @Path( "assignTemplatedRole" )</a>
<span class="sourceLineNo">132</span><a id="line.132"> @GET</a>
<span class="sourceLineNo">133</span><a id="line.133"> @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )</a>
<span class="sourceLineNo">134</span><a id="line.134"> @RedbackAuthorization( permissions = RedbackRoleConstants.USER_MANAGEMENT_RBAC_ADMIN_OPERATION )</a>
<span class="sourceLineNo">135</span><a id="line.135"> ActionStatus assignTemplatedRole( @QueryParam( "templateId" ) String templateId,</a>
<span class="sourceLineNo">136</span><a id="line.136"> @QueryParam( "resource" ) String resource,</a>
<span class="sourceLineNo">137</span><a id="line.137"> @QueryParam( "principal" ) String principal )</a>
<span class="sourceLineNo">138</span><a id="line.138"> throws RedbackServiceException;</a>
<span class="sourceLineNo">139</span><a id="line.139"></a>
<span class="sourceLineNo">140</span><a id="line.140"> /**</a>
<span class="sourceLineNo">141</span><a id="line.141"> * Unassigns the role indicated by the role id from the given principal</a>
<span class="sourceLineNo">142</span><a id="line.142"> *</a>
<span class="sourceLineNo">143</span><a id="line.143"> * @param roleId</a>
<span class="sourceLineNo">144</span><a id="line.144"> * @param principal</a>
<span class="sourceLineNo">145</span><a id="line.145"> * @throws RedbackServiceException</a>
<span class="sourceLineNo">146</span><a id="line.146"> */</a>
<span class="sourceLineNo">147</span><a id="line.147"> @Path( "unassignRole" )</a>
<span class="sourceLineNo">148</span><a id="line.148"> @GET</a>
<span class="sourceLineNo">149</span><a id="line.149"> @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )</a>
<span class="sourceLineNo">150</span><a id="line.150"> @RedbackAuthorization( permissions = RedbackRoleConstants.USER_MANAGEMENT_RBAC_ADMIN_OPERATION )</a>
<span class="sourceLineNo">151</span><a id="line.151"> ActionStatus unassignRole( @QueryParam( "roleId" ) String roleId, @QueryParam( "principal" ) String principal )</a>
<span class="sourceLineNo">152</span><a id="line.152"> throws RedbackServiceException;</a>
<span class="sourceLineNo">153</span><a id="line.153"></a>
<span class="sourceLineNo">154</span><a id="line.154"> /**</a>
<span class="sourceLineNo">155</span><a id="line.155"> * Unassigns the role indicated by the role name from the given principal</a>
<span class="sourceLineNo">156</span><a id="line.156"> *</a>
<span class="sourceLineNo">157</span><a id="line.157"> * @param roleName</a>
<span class="sourceLineNo">158</span><a id="line.158"> * @param principal</a>
<span class="sourceLineNo">159</span><a id="line.159"> * @throws RedbackServiceException</a>
<span class="sourceLineNo">160</span><a id="line.160"> */</a>
<span class="sourceLineNo">161</span><a id="line.161"> @Path( "unassignRoleByName" )</a>
<span class="sourceLineNo">162</span><a id="line.162"> @GET</a>
<span class="sourceLineNo">163</span><a id="line.163"> @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )</a>
<span class="sourceLineNo">164</span><a id="line.164"> @RedbackAuthorization( permissions = RedbackRoleConstants.USER_MANAGEMENT_RBAC_ADMIN_OPERATION )</a>
<span class="sourceLineNo">165</span><a id="line.165"> ActionStatus unassignRoleByName( @QueryParam( "roleName" ) String roleName, @QueryParam( "principal" ) String principal )</a>
<span class="sourceLineNo">166</span><a id="line.166"> throws RedbackServiceException;</a>
<span class="sourceLineNo">167</span><a id="line.167"></a>
<span class="sourceLineNo">168</span><a id="line.168"> /**</a>
<span class="sourceLineNo">169</span><a id="line.169"> * true of a role exists with the given roleId</a>
<span class="sourceLineNo">170</span><a id="line.170"> *</a>
<span class="sourceLineNo">171</span><a id="line.171"> * @param roleId</a>
<span class="sourceLineNo">172</span><a id="line.172"> * @return</a>
<span class="sourceLineNo">173</span><a id="line.173"> * @throws RedbackServiceException</a>
<span class="sourceLineNo">174</span><a id="line.174"> */</a>
<span class="sourceLineNo">175</span><a id="line.175"> @Path( "roleExists" )</a>
<span class="sourceLineNo">176</span><a id="line.176"> @GET</a>
<span class="sourceLineNo">177</span><a id="line.177"> @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )</a>
<span class="sourceLineNo">178</span><a id="line.178"> @RedbackAuthorization( permissions = RedbackRoleConstants.USER_MANAGEMENT_RBAC_ADMIN_OPERATION )</a>
<span class="sourceLineNo">179</span><a id="line.179"> Boolean roleExists( @QueryParam( "roleId" ) String roleId )</a>
<span class="sourceLineNo">180</span><a id="line.180"> throws RedbackServiceException;</a>
<span class="sourceLineNo">181</span><a id="line.181"></a>
<span class="sourceLineNo">182</span><a id="line.182"> /**</a>
<span class="sourceLineNo">183</span><a id="line.183"> * true of a role exists with the given roleId</a>
<span class="sourceLineNo">184</span><a id="line.184"> *</a>
<span class="sourceLineNo">185</span><a id="line.185"> * @param templateId</a>
<span class="sourceLineNo">186</span><a id="line.186"> * @param resource</a>
<span class="sourceLineNo">187</span><a id="line.187"> * @return</a>
<span class="sourceLineNo">188</span><a id="line.188"> * @throws RedbackServiceException</a>
<span class="sourceLineNo">189</span><a id="line.189"> */</a>
<span class="sourceLineNo">190</span><a id="line.190"> @Path( "templatedRoleExists" )</a>
<span class="sourceLineNo">191</span><a id="line.191"> @GET</a>
<span class="sourceLineNo">192</span><a id="line.192"> @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )</a>
<span class="sourceLineNo">193</span><a id="line.193"> @RedbackAuthorization( permissions = RedbackRoleConstants.USER_MANAGEMENT_RBAC_ADMIN_OPERATION )</a>
<span class="sourceLineNo">194</span><a id="line.194"> Boolean templatedRoleExists( @QueryParam( "templateId" ) String templateId,</a>
<span class="sourceLineNo">195</span><a id="line.195"> @QueryParam( "resource" ) String resource )</a>
<span class="sourceLineNo">196</span><a id="line.196"> throws RedbackServiceException;</a>
<span class="sourceLineNo">197</span><a id="line.197"></a>
<span class="sourceLineNo">198</span><a id="line.198"></a>
<span class="sourceLineNo">199</span><a id="line.199"> /**</a>
<span class="sourceLineNo">200</span><a id="line.200"> * Check a role template is complete in the RBAC store.</a>
<span class="sourceLineNo">201</span><a id="line.201"> *</a>
<span class="sourceLineNo">202</span><a id="line.202"> * @param templateId the templated role</a>
<span class="sourceLineNo">203</span><a id="line.203"> * @param resource the resource to verify</a>
<span class="sourceLineNo">204</span><a id="line.204"> * @throws RedbackServiceException</a>
<span class="sourceLineNo">205</span><a id="line.205"> */</a>
<span class="sourceLineNo">206</span><a id="line.206"> @Path( "verifyTemplatedRole" )</a>
<span class="sourceLineNo">207</span><a id="line.207"> @GET</a>
<span class="sourceLineNo">208</span><a id="line.208"> @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )</a>
<span class="sourceLineNo">209</span><a id="line.209"> @RedbackAuthorization( permissions = RedbackRoleConstants.USER_MANAGEMENT_RBAC_ADMIN_OPERATION )</a>
<span class="sourceLineNo">210</span><a id="line.210"> VerificationStatus verifyTemplatedRole( @QueryParam( "templateId" ) String templateId,</a>
<span class="sourceLineNo">211</span><a id="line.211"> @QueryParam( "resource" ) String resource )</a>
<span class="sourceLineNo">212</span><a id="line.212"> throws RedbackServiceException;</a>
<span class="sourceLineNo">213</span><a id="line.213"></a>
<span class="sourceLineNo">214</span><a id="line.214"> /**</a>
<span class="sourceLineNo">215</span><a id="line.215"> * @since 1.4</a>
<span class="sourceLineNo">216</span><a id="line.216"> */</a>
<span class="sourceLineNo">217</span><a id="line.217"> @Path( "getEffectivelyAssignedRoles/{username}" )</a>
<span class="sourceLineNo">218</span><a id="line.218"> @GET</a>
<span class="sourceLineNo">219</span><a id="line.219"> @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )</a>
<span class="sourceLineNo">220</span><a id="line.220"> @RedbackAuthorization( permissions = RedbackRoleConstants.USER_MANAGEMENT_RBAC_ADMIN_OPERATION )</a>
<span class="sourceLineNo">221</span><a id="line.221"> List&lt;Role&gt; getEffectivelyAssignedRoles( @PathParam( "username" ) String username )</a>
<span class="sourceLineNo">222</span><a id="line.222"> throws RedbackServiceException;</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"> /**</a>
<span class="sourceLineNo">226</span><a id="line.226"> * @since 2.0</a>
<span class="sourceLineNo">227</span><a id="line.227"> */</a>
<span class="sourceLineNo">228</span><a id="line.228"> @Path( "allRoles" )</a>
<span class="sourceLineNo">229</span><a id="line.229"> @GET</a>
<span class="sourceLineNo">230</span><a id="line.230"> @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )</a>
<span class="sourceLineNo">231</span><a id="line.231"> @RedbackAuthorization( permissions = RedbackRoleConstants.USER_MANAGEMENT_RBAC_ADMIN_OPERATION )</a>
<span class="sourceLineNo">232</span><a id="line.232"> List&lt;Role&gt; getAllRoles()</a>
<span class="sourceLineNo">233</span><a id="line.233"> throws RedbackServiceException;</a>
<span class="sourceLineNo">234</span><a id="line.234"></a>
<span class="sourceLineNo">235</span><a id="line.235"> /**</a>
<span class="sourceLineNo">236</span><a id="line.236"> * @since 2.0</a>
<span class="sourceLineNo">237</span><a id="line.237"> */</a>
<span class="sourceLineNo">238</span><a id="line.238"> @Path( "detailledAllRoles" )</a>
<span class="sourceLineNo">239</span><a id="line.239"> @GET</a>
<span class="sourceLineNo">240</span><a id="line.240"> @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )</a>
<span class="sourceLineNo">241</span><a id="line.241"> @RedbackAuthorization( permissions = RedbackRoleConstants.USER_MANAGEMENT_RBAC_ADMIN_OPERATION )</a>
<span class="sourceLineNo">242</span><a id="line.242"> List&lt;Role&gt; getDetailedAllRoles()</a>
<span class="sourceLineNo">243</span><a id="line.243"> throws RedbackServiceException;</a>
<span class="sourceLineNo">244</span><a id="line.244"></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"> * @since 2.0</a>
<span class="sourceLineNo">248</span><a id="line.248"> */</a>
<span class="sourceLineNo">249</span><a id="line.249"> @Path( "getApplications/{username}" )</a>
<span class="sourceLineNo">250</span><a id="line.250"> @GET</a>
<span class="sourceLineNo">251</span><a id="line.251"> @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )</a>
<span class="sourceLineNo">252</span><a id="line.252"> @RedbackAuthorization( permissions = RedbackRoleConstants.USER_MANAGEMENT_RBAC_ADMIN_OPERATION )</a>
<span class="sourceLineNo">253</span><a id="line.253"> List&lt;Application&gt; getApplications( @PathParam( "username" ) String username )</a>
<span class="sourceLineNo">254</span><a id="line.254"> throws RedbackServiceException;</a>
<span class="sourceLineNo">255</span><a id="line.255"></a>
<span class="sourceLineNo">256</span><a id="line.256"></a>
<span class="sourceLineNo">257</span><a id="line.257"> /**</a>
<span class="sourceLineNo">258</span><a id="line.258"> * @since 2.0</a>
<span class="sourceLineNo">259</span><a id="line.259"> */</a>
<span class="sourceLineNo">260</span><a id="line.260"> @Path( "getRole/{roleName}" )</a>
<span class="sourceLineNo">261</span><a id="line.261"> @GET</a>
<span class="sourceLineNo">262</span><a id="line.262"> @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )</a>
<span class="sourceLineNo">263</span><a id="line.263"> @RedbackAuthorization( permissions = RedbackRoleConstants.USER_MANAGEMENT_RBAC_ADMIN_OPERATION )</a>
<span class="sourceLineNo">264</span><a id="line.264"> Role getRole( @PathParam( "roleName" ) String roleName )</a>
<span class="sourceLineNo">265</span><a id="line.265"> throws RedbackServiceException;</a>
<span class="sourceLineNo">266</span><a id="line.266"></a>
<span class="sourceLineNo">267</span><a id="line.267"> /**</a>
<span class="sourceLineNo">268</span><a id="line.268"> * @since 2.0</a>
<span class="sourceLineNo">269</span><a id="line.269"> */</a>
<span class="sourceLineNo">270</span><a id="line.270"> @Path( "updateRoleDescription" )</a>
<span class="sourceLineNo">271</span><a id="line.271"> @GET</a>
<span class="sourceLineNo">272</span><a id="line.272"> @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )</a>
<span class="sourceLineNo">273</span><a id="line.273"> @RedbackAuthorization( permissions = RedbackRoleConstants.USER_MANAGEMENT_RBAC_ADMIN_OPERATION )</a>
<span class="sourceLineNo">274</span><a id="line.274"> ActionStatus updateRoleDescription( @QueryParam( "roleName" ) String roleName,</a>
<span class="sourceLineNo">275</span><a id="line.275"> @QueryParam( "roleDescription" ) String description )</a>
<span class="sourceLineNo">276</span><a id="line.276"> throws RedbackServiceException;</a>
<span class="sourceLineNo">277</span><a id="line.277"></a>
<span class="sourceLineNo">278</span><a id="line.278"> /**</a>
<span class="sourceLineNo">279</span><a id="line.279"> * update users assigned to a role</a>
<span class="sourceLineNo">280</span><a id="line.280"> * @since 2.0</a>
<span class="sourceLineNo">281</span><a id="line.281"> */</a>
<span class="sourceLineNo">282</span><a id="line.282"> @Path( "updateRoleUsers" )</a>
<span class="sourceLineNo">283</span><a id="line.283"> @POST</a>
<span class="sourceLineNo">284</span><a id="line.284"> @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )</a>
<span class="sourceLineNo">285</span><a id="line.285"> @Consumes( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )</a>
<span class="sourceLineNo">286</span><a id="line.286"> @RedbackAuthorization( permissions = RedbackRoleConstants.USER_MANAGEMENT_RBAC_ADMIN_OPERATION )</a>
<span class="sourceLineNo">287</span><a id="line.287"> ActionStatus updateRoleUsers( Role role )</a>
<span class="sourceLineNo">288</span><a id="line.288"> throws RedbackServiceException;</a>
<span class="sourceLineNo">289</span><a id="line.289"></a>
<span class="sourceLineNo">290</span><a id="line.290"> /**</a>
<span class="sourceLineNo">291</span><a id="line.291"> * @since 2.0</a>
<span class="sourceLineNo">292</span><a id="line.292"> */</a>
<span class="sourceLineNo">293</span><a id="line.293"> @Path( "getApplicationRoles/{username}" )</a>
<span class="sourceLineNo">294</span><a id="line.294"> @GET</a>
<span class="sourceLineNo">295</span><a id="line.295"> @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )</a>
<span class="sourceLineNo">296</span><a id="line.296"> @RedbackAuthorization( permissions = RedbackRoleConstants.USER_MANAGEMENT_RBAC_ADMIN_OPERATION )</a>
<span class="sourceLineNo">297</span><a id="line.297"> List&lt;ApplicationRoles&gt; getApplicationRoles( @PathParam( "username" ) String username )</a>
<span class="sourceLineNo">298</span><a id="line.298"> throws RedbackServiceException;</a>
<span class="sourceLineNo">299</span><a id="line.299"></a>
<span class="sourceLineNo">300</span><a id="line.300"> /**</a>
<span class="sourceLineNo">301</span><a id="line.301"> * update roles assigned to a user</a>
<span class="sourceLineNo">302</span><a id="line.302"> * @since 2.0</a>
<span class="sourceLineNo">303</span><a id="line.303"> */</a>
<span class="sourceLineNo">304</span><a id="line.304"> @Path( "updateUserRoles" )</a>
<span class="sourceLineNo">305</span><a id="line.305"> @POST</a>
<span class="sourceLineNo">306</span><a id="line.306"> @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )</a>
<span class="sourceLineNo">307</span><a id="line.307"> @Consumes( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )</a>
<span class="sourceLineNo">308</span><a id="line.308"> @RedbackAuthorization( permissions = RedbackRoleConstants.USER_MANAGEMENT_RBAC_ADMIN_OPERATION )</a>
<span class="sourceLineNo">309</span><a id="line.309"> ActionStatus updateUserRoles( User user )</a>
<span class="sourceLineNo">310</span><a id="line.310"> throws RedbackServiceException;</a>
<span class="sourceLineNo">311</span><a id="line.311"></a>
<span class="sourceLineNo">312</span><a id="line.312">}</a>
</pre>
</div>
</main>
</body>
</html>