| <!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.v2;</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 io.swagger.v3.oas.annotations.Operation;</a> |
| <span class="sourceLineNo">022</span><a id="line.22">import io.swagger.v3.oas.annotations.Parameter;</a> |
| <span class="sourceLineNo">023</span><a id="line.23">import io.swagger.v3.oas.annotations.headers.Header;</a> |
| <span class="sourceLineNo">024</span><a id="line.24">import io.swagger.v3.oas.annotations.media.Schema;</a> |
| <span class="sourceLineNo">025</span><a id="line.25">import io.swagger.v3.oas.annotations.responses.ApiResponse;</a> |
| <span class="sourceLineNo">026</span><a id="line.26">import io.swagger.v3.oas.annotations.security.SecurityRequirement;</a> |
| <span class="sourceLineNo">027</span><a id="line.27">import io.swagger.v3.oas.annotations.tags.Tag;</a> |
| <span class="sourceLineNo">028</span><a id="line.28">import org.apache.archiva.components.rest.model.PagedResult;</a> |
| <span class="sourceLineNo">029</span><a id="line.29">import org.apache.archiva.redback.authorization.RedbackAuthorization;</a> |
| <span class="sourceLineNo">030</span><a id="line.30">import org.apache.archiva.redback.integration.security.role.RedbackRoleConstants;</a> |
| <span class="sourceLineNo">031</span><a id="line.31">import org.apache.archiva.redback.rest.api.Constants;</a> |
| <span class="sourceLineNo">032</span><a id="line.32">import org.apache.archiva.redback.rest.api.model.v2.Group;</a> |
| <span class="sourceLineNo">033</span><a id="line.33">import org.apache.archiva.redback.rest.api.model.v2.GroupMapping;</a> |
| <span class="sourceLineNo">034</span><a id="line.34">import org.apache.archiva.redback.rest.api.services.RedbackServiceException;</a> |
| <span class="sourceLineNo">035</span><a id="line.35"></a> |
| <span class="sourceLineNo">036</span><a id="line.36">import javax.ws.rs.Consumes;</a> |
| <span class="sourceLineNo">037</span><a id="line.37">import javax.ws.rs.DELETE;</a> |
| <span class="sourceLineNo">038</span><a id="line.38">import javax.ws.rs.DefaultValue;</a> |
| <span class="sourceLineNo">039</span><a id="line.39">import javax.ws.rs.GET;</a> |
| <span class="sourceLineNo">040</span><a id="line.40">import javax.ws.rs.POST;</a> |
| <span class="sourceLineNo">041</span><a id="line.41">import javax.ws.rs.PUT;</a> |
| <span class="sourceLineNo">042</span><a id="line.42">import javax.ws.rs.Path;</a> |
| <span class="sourceLineNo">043</span><a id="line.43">import javax.ws.rs.PathParam;</a> |
| <span class="sourceLineNo">044</span><a id="line.44">import javax.ws.rs.Produces;</a> |
| <span class="sourceLineNo">045</span><a id="line.45">import javax.ws.rs.QueryParam;</a> |
| <span class="sourceLineNo">046</span><a id="line.46">import javax.ws.rs.core.Context;</a> |
| <span class="sourceLineNo">047</span><a id="line.47">import javax.ws.rs.core.MediaType;</a> |
| <span class="sourceLineNo">048</span><a id="line.48">import javax.ws.rs.core.Response;</a> |
| <span class="sourceLineNo">049</span><a id="line.49">import javax.ws.rs.core.UriInfo;</a> |
| <span class="sourceLineNo">050</span><a id="line.50">import java.util.List;</a> |
| <span class="sourceLineNo">051</span><a id="line.51"></a> |
| <span class="sourceLineNo">052</span><a id="line.52">import static org.apache.archiva.redback.rest.api.Constants.DEFAULT_PAGE_LIMIT;</a> |
| <span class="sourceLineNo">053</span><a id="line.53"></a> |
| <span class="sourceLineNo">054</span><a id="line.54">/**</a> |
| <span class="sourceLineNo">055</span><a id="line.55"> * @author Olivier Lamy</a> |
| <span class="sourceLineNo">056</span><a id="line.56"> * @author Martin Stockhammer</a> |
| <span class="sourceLineNo">057</span><a id="line.57"> * @since 3.0</a> |
| <span class="sourceLineNo">058</span><a id="line.58"> */</a> |
| <span class="sourceLineNo">059</span><a id="line.59">@Path( "/groups" )</a> |
| <span class="sourceLineNo">060</span><a id="line.60">@Tag(name = "v2")</a> |
| <span class="sourceLineNo">061</span><a id="line.61">@Tag(name = "v2/Groups")</a> |
| <span class="sourceLineNo">062</span><a id="line.62">@SecurityRequirement(name = "BearerAuth")</a> |
| <span class="sourceLineNo">063</span><a id="line.63">public interface GroupService</a> |
| <span class="sourceLineNo">064</span><a id="line.64">{</a> |
| <span class="sourceLineNo">065</span><a id="line.65"></a> |
| <span class="sourceLineNo">066</span><a id="line.66"> @Path( "" )</a> |
| <span class="sourceLineNo">067</span><a id="line.67"> @GET</a> |
| <span class="sourceLineNo">068</span><a id="line.68"> @Produces( {MediaType.APPLICATION_JSON} )</a> |
| <span class="sourceLineNo">069</span><a id="line.69"> @RedbackAuthorization( permissions = RedbackRoleConstants.CONFIGURATION_EDIT_OPERATION )</a> |
| <span class="sourceLineNo">070</span><a id="line.70"> @Operation( summary = "Get list of group objects",</a> |
| <span class="sourceLineNo">071</span><a id="line.71"> parameters = {</a> |
| <span class="sourceLineNo">072</span><a id="line.72"> @Parameter(name = "q", description = "Search term"),</a> |
| <span class="sourceLineNo">073</span><a id="line.73"> @Parameter(name = "offset", description = "The offset of the first element returned"),</a> |
| <span class="sourceLineNo">074</span><a id="line.74"> @Parameter(name = "limit", description = "Maximum number of items to return in the response"),</a> |
| <span class="sourceLineNo">075</span><a id="line.75"> @Parameter(name = "orderBy", description = "List of attribute used for sorting (id, name, description, assignable)"),</a> |
| <span class="sourceLineNo">076</span><a id="line.76"> @Parameter(name = "order", description = "The sort order. Either ascending (asc) or descending (desc)")</a> |
| <span class="sourceLineNo">077</span><a id="line.77"> },</a> |
| <span class="sourceLineNo">078</span><a id="line.78"></a> |
| <span class="sourceLineNo">079</span><a id="line.79"> responses = {</a> |
| <span class="sourceLineNo">080</span><a id="line.80"> @ApiResponse( description = "List of group objects. The number of returned results depend on the pagination parameters offset and limit." )</a> |
| <span class="sourceLineNo">081</span><a id="line.81"> }</a> |
| <span class="sourceLineNo">082</span><a id="line.82"> )</a> |
| <span class="sourceLineNo">083</span><a id="line.83"> PagedResult<Group> getGroups( @QueryParam("q") @DefaultValue( "" ) String searchTerm,</a> |
| <span class="sourceLineNo">084</span><a id="line.84"> @QueryParam( "offset" ) @DefaultValue( "0" ) Integer offset,</a> |
| <span class="sourceLineNo">085</span><a id="line.85"> @QueryParam( "limit" ) @DefaultValue( value = DEFAULT_PAGE_LIMIT ) Integer limit,</a> |
| <span class="sourceLineNo">086</span><a id="line.86"> @QueryParam( "orderBy") @DefaultValue( "name" ) List<String> orderBy,</a> |
| <span class="sourceLineNo">087</span><a id="line.87"> @QueryParam("order") @DefaultValue( "asc" ) String order)</a> |
| <span class="sourceLineNo">088</span><a id="line.88"> throws RedbackServiceException;</a> |
| <span class="sourceLineNo">089</span><a id="line.89"></a> |
| <span class="sourceLineNo">090</span><a id="line.90"></a> |
| <span class="sourceLineNo">091</span><a id="line.91"> @Path( "mappings" )</a> |
| <span class="sourceLineNo">092</span><a id="line.92"> @GET</a> |
| <span class="sourceLineNo">093</span><a id="line.93"> @Produces( {MediaType.APPLICATION_JSON} )</a> |
| <span class="sourceLineNo">094</span><a id="line.94"> @RedbackAuthorization( permissions = RedbackRoleConstants.CONFIGURATION_EDIT_OPERATION )</a> |
| <span class="sourceLineNo">095</span><a id="line.95"> @Operation( summary = "Get list of group mappings",</a> |
| <span class="sourceLineNo">096</span><a id="line.96"> responses = {</a> |
| <span class="sourceLineNo">097</span><a id="line.97"> @ApiResponse( description = "List of group mappings" )</a> |
| <span class="sourceLineNo">098</span><a id="line.98"> }</a> |
| <span class="sourceLineNo">099</span><a id="line.99"> )</a> |
| <span class="sourceLineNo">100</span><a id="line.100"> List<GroupMapping> getGroupMappings( )</a> |
| <span class="sourceLineNo">101</span><a id="line.101"> throws RedbackServiceException;</a> |
| <span class="sourceLineNo">102</span><a id="line.102"></a> |
| <span class="sourceLineNo">103</span><a id="line.103"></a> |
| <span class="sourceLineNo">104</span><a id="line.104"> @Path( "mappings" )</a> |
| <span class="sourceLineNo">105</span><a id="line.105"> @POST</a> |
| <span class="sourceLineNo">106</span><a id="line.106"> @Consumes( {MediaType.APPLICATION_JSON} )</a> |
| <span class="sourceLineNo">107</span><a id="line.107"> @Produces( {MediaType.APPLICATION_JSON} )</a> |
| <span class="sourceLineNo">108</span><a id="line.108"> @RedbackAuthorization( permissions = RedbackRoleConstants.CONFIGURATION_EDIT_OPERATION )</a> |
| <span class="sourceLineNo">109</span><a id="line.109"> @Operation( summary = "Adds a group mapping",</a> |
| <span class="sourceLineNo">110</span><a id="line.110"> responses = {</a> |
| <span class="sourceLineNo">111</span><a id="line.111"> @ApiResponse( responseCode = "201",</a> |
| <span class="sourceLineNo">112</span><a id="line.112"> description = "If the group addition was successful",</a> |
| <span class="sourceLineNo">113</span><a id="line.113"> headers = {</a> |
| <span class="sourceLineNo">114</span><a id="line.114"> @Header( name="Location", description = "The URL of the created mapping", schema = @Schema(type="string"))</a> |
| <span class="sourceLineNo">115</span><a id="line.115"> }</a> |
| <span class="sourceLineNo">116</span><a id="line.116"> ),</a> |
| <span class="sourceLineNo">117</span><a id="line.117"> @ApiResponse( responseCode = "405", description = "Invalid input" )</a> |
| <span class="sourceLineNo">118</span><a id="line.118"> }</a> |
| <span class="sourceLineNo">119</span><a id="line.119"> )</a> |
| <span class="sourceLineNo">120</span><a id="line.120"> Response addGroupMapping( @Parameter( description = "The data of the group mapping", required = true )</a> |
| <span class="sourceLineNo">121</span><a id="line.121"> GroupMapping groupMapping, @Context UriInfo uriInfo )</a> |
| <span class="sourceLineNo">122</span><a id="line.122"> throws RedbackServiceException;</a> |
| <span class="sourceLineNo">123</span><a id="line.123"></a> |
| <span class="sourceLineNo">124</span><a id="line.124"> @Path( "mappings/{group}" )</a> |
| <span class="sourceLineNo">125</span><a id="line.125"> @GET</a> |
| <span class="sourceLineNo">126</span><a id="line.126"> @Produces( {MediaType.APPLICATION_JSON} )</a> |
| <span class="sourceLineNo">127</span><a id="line.127"> @RedbackAuthorization( permissions = RedbackRoleConstants.CONFIGURATION_EDIT_OPERATION )</a> |
| <span class="sourceLineNo">128</span><a id="line.128"> @Operation( summary = "Returns the list of roles of a given group mapping",</a> |
| <span class="sourceLineNo">129</span><a id="line.129"> responses = {</a> |
| <span class="sourceLineNo">130</span><a id="line.130"> @ApiResponse( responseCode = "200", description = "If the list could be returned" ),</a> |
| <span class="sourceLineNo">131</span><a id="line.131"> @ApiResponse( responseCode = "404", description = "Group mapping not found" )</a> |
| <span class="sourceLineNo">132</span><a id="line.132"> }</a> |
| <span class="sourceLineNo">133</span><a id="line.133"> )</a> |
| <span class="sourceLineNo">134</span><a id="line.134"> List<String> getGroupMapping( @Parameter( description = "The group name", required = true )</a> |
| <span class="sourceLineNo">135</span><a id="line.135"> @PathParam( "group" ) String group )</a> |
| <span class="sourceLineNo">136</span><a id="line.136"> throws RedbackServiceException;</a> |
| <span class="sourceLineNo">137</span><a id="line.137"></a> |
| <span class="sourceLineNo">138</span><a id="line.138"> @Path( "mappings/{group}" )</a> |
| <span class="sourceLineNo">139</span><a id="line.139"> @DELETE</a> |
| <span class="sourceLineNo">140</span><a id="line.140"> @Consumes( {MediaType.APPLICATION_JSON} )</a> |
| <span class="sourceLineNo">141</span><a id="line.141"> @Produces( {MediaType.APPLICATION_JSON} )</a> |
| <span class="sourceLineNo">142</span><a id="line.142"> @RedbackAuthorization( permissions = RedbackRoleConstants.CONFIGURATION_EDIT_OPERATION )</a> |
| <span class="sourceLineNo">143</span><a id="line.143"> @Operation( summary = "Deletes a group mapping",</a> |
| <span class="sourceLineNo">144</span><a id="line.144"> responses = {</a> |
| <span class="sourceLineNo">145</span><a id="line.145"> @ApiResponse( responseCode = "200", description = "If the status of the delete action was successful" ),</a> |
| <span class="sourceLineNo">146</span><a id="line.146"> @ApiResponse( responseCode = "404", description = "Group mapping not found" )</a> |
| <span class="sourceLineNo">147</span><a id="line.147"> }</a> |
| <span class="sourceLineNo">148</span><a id="line.148"> )</a> |
| <span class="sourceLineNo">149</span><a id="line.149"> void removeGroupMapping( @Parameter( description = "The group name", required = true )</a> |
| <span class="sourceLineNo">150</span><a id="line.150"> @PathParam( "group" ) String group )</a> |
| <span class="sourceLineNo">151</span><a id="line.151"> throws RedbackServiceException;</a> |
| <span class="sourceLineNo">152</span><a id="line.152"></a> |
| <span class="sourceLineNo">153</span><a id="line.153"> @Path( "mappings/{group}" )</a> |
| <span class="sourceLineNo">154</span><a id="line.154"> @PUT</a> |
| <span class="sourceLineNo">155</span><a id="line.155"> @Consumes( {MediaType.APPLICATION_JSON} )</a> |
| <span class="sourceLineNo">156</span><a id="line.156"> @Produces( {MediaType.APPLICATION_JSON} )</a> |
| <span class="sourceLineNo">157</span><a id="line.157"> @RedbackAuthorization( permissions = RedbackRoleConstants.CONFIGURATION_EDIT_OPERATION )</a> |
| <span class="sourceLineNo">158</span><a id="line.158"> @Operation( summary = "Updates a group mapping",</a> |
| <span class="sourceLineNo">159</span><a id="line.159"> responses = {</a> |
| <span class="sourceLineNo">160</span><a id="line.160"> @ApiResponse( responseCode = "200", description = "If the update was successful" ),</a> |
| <span class="sourceLineNo">161</span><a id="line.161"> @ApiResponse( responseCode = "404", description = "Group mapping not found" )</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"> Response updateGroupMapping( @Parameter( description = "The group name", required = true )</a> |
| <span class="sourceLineNo">165</span><a id="line.165"> @PathParam( "group" ) String groupName,</a> |
| <span class="sourceLineNo">166</span><a id="line.166"> @Parameter( description = "The updated role list of the group mapping", required = true )</a> |
| <span class="sourceLineNo">167</span><a id="line.167"> List<String> roles )</a> |
| <span class="sourceLineNo">168</span><a id="line.168"> throws RedbackServiceException;</a> |
| <span class="sourceLineNo">169</span><a id="line.169"></a> |
| <span class="sourceLineNo">170</span><a id="line.170"> @Path( "mappings/{group}/roles/{roleId}" )</a> |
| <span class="sourceLineNo">171</span><a id="line.171"> @PUT</a> |
| <span class="sourceLineNo">172</span><a id="line.172"> @Consumes( {MediaType.APPLICATION_JSON} )</a> |
| <span class="sourceLineNo">173</span><a id="line.173"> @Produces( {MediaType.APPLICATION_JSON} )</a> |
| <span class="sourceLineNo">174</span><a id="line.174"> @RedbackAuthorization( permissions = RedbackRoleConstants.CONFIGURATION_EDIT_OPERATION )</a> |
| <span class="sourceLineNo">175</span><a id="line.175"> @Operation( summary = "Adds a role to a given group mapping.",</a> |
| <span class="sourceLineNo">176</span><a id="line.176"> responses = {</a> |
| <span class="sourceLineNo">177</span><a id="line.177"> @ApiResponse( responseCode = "200", description = "If the update was successful" ),</a> |
| <span class="sourceLineNo">178</span><a id="line.178"> }</a> |
| <span class="sourceLineNo">179</span><a id="line.179"> )</a> |
| <span class="sourceLineNo">180</span><a id="line.180"> Response addRolesToGroupMapping( @Parameter( description = "The group name", required = true )</a> |
| <span class="sourceLineNo">181</span><a id="line.181"> @PathParam( "group" ) String groupName,</a> |
| <span class="sourceLineNo">182</span><a id="line.182"> @PathParam( "roleId" )</a> |
| <span class="sourceLineNo">183</span><a id="line.183"> @Parameter( description = "The id of the role to add to the mapping", required = true )</a> |
| <span class="sourceLineNo">184</span><a id="line.184"> String roleId )</a> |
| <span class="sourceLineNo">185</span><a id="line.185"> throws RedbackServiceException;</a> |
| <span class="sourceLineNo">186</span><a id="line.186">}</a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
