blob: 76852400dfc8e1899034fde58208e2905aee67e1 [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.model.v2;/*</a>
<span class="sourceLineNo">002</span><a id="line.2"> * Licensed to the Apache Software Foundation (ASF) under one</a>
<span class="sourceLineNo">003</span><a id="line.3"> * or more contributor license agreements. See the NOTICE file</a>
<span class="sourceLineNo">004</span><a id="line.4"> * distributed with this work for additional information</a>
<span class="sourceLineNo">005</span><a id="line.5"> * regarding copyright ownership. The ASF licenses this file</a>
<span class="sourceLineNo">006</span><a id="line.6"> * to you under the Apache License, Version 2.0 (the</a>
<span class="sourceLineNo">007</span><a id="line.7"> * "License"); you may not use this file except in compliance</a>
<span class="sourceLineNo">008</span><a id="line.8"> * with the License. You may obtain a copy of the License at</a>
<span class="sourceLineNo">009</span><a id="line.9"> *</a>
<span class="sourceLineNo">010</span><a id="line.10"> * http://www.apache.org/licenses/LICENSE-2.0</a>
<span class="sourceLineNo">011</span><a id="line.11"> * Unless required by applicable law or agreed to in writing,</a>
<span class="sourceLineNo">012</span><a id="line.12"> * software distributed under the License is distributed on an</a>
<span class="sourceLineNo">013</span><a id="line.13"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</a>
<span class="sourceLineNo">014</span><a id="line.14"> * KIND, either express or implied. See the License for the</a>
<span class="sourceLineNo">015</span><a id="line.15"> * specific language governing permissions and limitations</a>
<span class="sourceLineNo">016</span><a id="line.16"> * under the License.</a>
<span class="sourceLineNo">017</span><a id="line.17"> */</a>
<span class="sourceLineNo">018</span><a id="line.18"></a>
<span class="sourceLineNo">019</span><a id="line.19">import io.swagger.v3.oas.annotations.media.Schema;</a>
<span class="sourceLineNo">020</span><a id="line.20">import org.apache.archiva.redback.rbac.Role;</a>
<span class="sourceLineNo">021</span><a id="line.21">import org.apache.archiva.redback.role.model.ModelRole;</a>
<span class="sourceLineNo">022</span><a id="line.22"></a>
<span class="sourceLineNo">023</span><a id="line.23">import javax.xml.bind.annotation.XmlTransient;</a>
<span class="sourceLineNo">024</span><a id="line.24">import java.io.Serializable;</a>
<span class="sourceLineNo">025</span><a id="line.25">import java.util.ArrayList;</a>
<span class="sourceLineNo">026</span><a id="line.26">import java.util.List;</a>
<span class="sourceLineNo">027</span><a id="line.27"></a>
<span class="sourceLineNo">028</span><a id="line.28">/**</a>
<span class="sourceLineNo">029</span><a id="line.29"> * Basic role information. This class contains only the standard attributes used for displaying a role.</a>
<span class="sourceLineNo">030</span><a id="line.30"> *</a>
<span class="sourceLineNo">031</span><a id="line.31"> * @author Martin Stockhammer &lt;martin_s@apache.org&gt;</a>
<span class="sourceLineNo">032</span><a id="line.32"> */</a>
<span class="sourceLineNo">033</span><a id="line.33">@Schema(name="BaseRoleInfo", description = "Basic role attributes")</a>
<span class="sourceLineNo">034</span><a id="line.34">public class BaseRoleInfo implements Serializable</a>
<span class="sourceLineNo">035</span><a id="line.35">{</a>
<span class="sourceLineNo">036</span><a id="line.36"> private static final long serialVersionUID = -6725489773301720068L;</a>
<span class="sourceLineNo">037</span><a id="line.37"></a>
<span class="sourceLineNo">038</span><a id="line.38"> protected String id;</a>
<span class="sourceLineNo">039</span><a id="line.39"> protected String name;</a>
<span class="sourceLineNo">040</span><a id="line.40"> protected String description = "";</a>
<span class="sourceLineNo">041</span><a id="line.41"> protected boolean permanent = false;</a>
<span class="sourceLineNo">042</span><a id="line.42"> protected String modelId = "";</a>
<span class="sourceLineNo">043</span><a id="line.43"> protected String resource = "";</a>
<span class="sourceLineNo">044</span><a id="line.44"> protected boolean isTemplateInstance = false;</a>
<span class="sourceLineNo">045</span><a id="line.45"> protected boolean assignable = true;</a>
<span class="sourceLineNo">046</span><a id="line.46"> private String applicationId = "";</a>
<span class="sourceLineNo">047</span><a id="line.47"> private boolean isChild = false;</a>
<span class="sourceLineNo">048</span><a id="line.48"></a>
<span class="sourceLineNo">049</span><a id="line.49"> protected boolean assigned = false;</a>
<span class="sourceLineNo">050</span><a id="line.50"> private List&lt;BaseRoleInfo&gt; children = new ArrayList&lt;&gt;( 0 );</a>
<span class="sourceLineNo">051</span><a id="line.51"></a>
<span class="sourceLineNo">052</span><a id="line.52"> public BaseRoleInfo() {</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"></a>
<span class="sourceLineNo">056</span><a id="line.56"> public static BaseRoleInfo ofName(String name) {</a>
<span class="sourceLineNo">057</span><a id="line.57"> BaseRoleInfo info = new BaseRoleInfo( );</a>
<span class="sourceLineNo">058</span><a id="line.58"> info.setName( name );</a>
<span class="sourceLineNo">059</span><a id="line.59"> return info;</a>
<span class="sourceLineNo">060</span><a id="line.60"> }</a>
<span class="sourceLineNo">061</span><a id="line.61"></a>
<span class="sourceLineNo">062</span><a id="line.62"> public static BaseRoleInfo ofId(String id) {</a>
<span class="sourceLineNo">063</span><a id="line.63"> BaseRoleInfo info = new BaseRoleInfo( );</a>
<span class="sourceLineNo">064</span><a id="line.64"> info.setId( id );</a>
<span class="sourceLineNo">065</span><a id="line.65"> return info;</a>
<span class="sourceLineNo">066</span><a id="line.66"> }</a>
<span class="sourceLineNo">067</span><a id="line.67"></a>
<span class="sourceLineNo">068</span><a id="line.68"> public static BaseRoleInfo of(Role rbacRole) {</a>
<span class="sourceLineNo">069</span><a id="line.69"> return of( rbacRole, new BaseRoleInfo( ) );</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"> public static &lt;T extends BaseRoleInfo&gt; T of( Role rbacRole, T role ) {</a>
<span class="sourceLineNo">074</span><a id="line.74"> role.id = rbacRole.getId( );</a>
<span class="sourceLineNo">075</span><a id="line.75"> role.name = rbacRole.getName( );</a>
<span class="sourceLineNo">076</span><a id="line.76"> role.description = rbacRole.getDescription( ) == null ?"": rbacRole.getDescription();</a>
<span class="sourceLineNo">077</span><a id="line.77"> role.permanent = rbacRole.isPermanent( );</a>
<span class="sourceLineNo">078</span><a id="line.78"> role.modelId = rbacRole.getModelId( );</a>
<span class="sourceLineNo">079</span><a id="line.79"> role.resource = rbacRole.getResource( );</a>
<span class="sourceLineNo">080</span><a id="line.80"> role.isTemplateInstance = rbacRole.isTemplateInstance( );</a>
<span class="sourceLineNo">081</span><a id="line.81"> role.assignable = rbacRole.isAssignable( );</a>
<span class="sourceLineNo">082</span><a id="line.82"> return role;</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"></a>
<span class="sourceLineNo">087</span><a id="line.87"> @Schema(description = "The role name")</a>
<span class="sourceLineNo">088</span><a id="line.88"> public String getName()</a>
<span class="sourceLineNo">089</span><a id="line.89"> {</a>
<span class="sourceLineNo">090</span><a id="line.90"> return name;</a>
<span class="sourceLineNo">091</span><a id="line.91"> }</a>
<span class="sourceLineNo">092</span><a id="line.92"></a>
<span class="sourceLineNo">093</span><a id="line.93"> public void setName( String name )</a>
<span class="sourceLineNo">094</span><a id="line.94"> {</a>
<span class="sourceLineNo">095</span><a id="line.95"> this.name = name;</a>
<span class="sourceLineNo">096</span><a id="line.96"> }</a>
<span class="sourceLineNo">097</span><a id="line.97"></a>
<span class="sourceLineNo">098</span><a id="line.98"> @Schema( description = "A description of the role" )</a>
<span class="sourceLineNo">099</span><a id="line.99"> public String getDescription( )</a>
<span class="sourceLineNo">100</span><a id="line.100"> {</a>
<span class="sourceLineNo">101</span><a id="line.101"> return description;</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"> public void setDescription( String description )</a>
<span class="sourceLineNo">105</span><a id="line.105"> {</a>
<span class="sourceLineNo">106</span><a id="line.106"> this.description = description;</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"> @Schema( description = "True, if this role cannot be deleted.")</a>
<span class="sourceLineNo">110</span><a id="line.110"> public boolean isPermanent()</a>
<span class="sourceLineNo">111</span><a id="line.111"> {</a>
<span class="sourceLineNo">112</span><a id="line.112"> return permanent;</a>
<span class="sourceLineNo">113</span><a id="line.113"> }</a>
<span class="sourceLineNo">114</span><a id="line.114"></a>
<span class="sourceLineNo">115</span><a id="line.115"> public void setPermanent( boolean permanent )</a>
<span class="sourceLineNo">116</span><a id="line.116"> {</a>
<span class="sourceLineNo">117</span><a id="line.117"> this.permanent = permanent;</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"> @Schema(description = "The identifier of this role")</a>
<span class="sourceLineNo">121</span><a id="line.121"> public String getId( )</a>
<span class="sourceLineNo">122</span><a id="line.122"> {</a>
<span class="sourceLineNo">123</span><a id="line.123"> return id;</a>
<span class="sourceLineNo">124</span><a id="line.124"> }</a>
<span class="sourceLineNo">125</span><a id="line.125"></a>
<span class="sourceLineNo">126</span><a id="line.126"> public void setId( String id )</a>
<span class="sourceLineNo">127</span><a id="line.127"> {</a>
<span class="sourceLineNo">128</span><a id="line.128"> this.id = id;</a>
<span class="sourceLineNo">129</span><a id="line.129"> }</a>
<span class="sourceLineNo">130</span><a id="line.130"></a>
<span class="sourceLineNo">131</span><a id="line.131"> @Schema(name="model_id", description = "The model this role is derived from")</a>
<span class="sourceLineNo">132</span><a id="line.132"> public String getModelId( )</a>
<span class="sourceLineNo">133</span><a id="line.133"> {</a>
<span class="sourceLineNo">134</span><a id="line.134"> return modelId;</a>
<span class="sourceLineNo">135</span><a id="line.135"> }</a>
<span class="sourceLineNo">136</span><a id="line.136"></a>
<span class="sourceLineNo">137</span><a id="line.137"> public void setModelId( String modelId )</a>
<span class="sourceLineNo">138</span><a id="line.138"> {</a>
<span class="sourceLineNo">139</span><a id="line.139"> this.modelId = modelId;</a>
<span class="sourceLineNo">140</span><a id="line.140"> }</a>
<span class="sourceLineNo">141</span><a id="line.141"></a>
<span class="sourceLineNo">142</span><a id="line.142"> @Schema(description = "The resource this model is built for, if it is built by a template.")</a>
<span class="sourceLineNo">143</span><a id="line.143"> public String getResource( )</a>
<span class="sourceLineNo">144</span><a id="line.144"> {</a>
<span class="sourceLineNo">145</span><a id="line.145"> return resource;</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"> public void setResource( String resource )</a>
<span class="sourceLineNo">149</span><a id="line.149"> {</a>
<span class="sourceLineNo">150</span><a id="line.150"> this.resource = resource;</a>
<span class="sourceLineNo">151</span><a id="line.151"> }</a>
<span class="sourceLineNo">152</span><a id="line.152"></a>
<span class="sourceLineNo">153</span><a id="line.153"> @Schema(name="template_instance", description = "True, if this is a instance of a role template")</a>
<span class="sourceLineNo">154</span><a id="line.154"> public boolean isTemplateInstance( )</a>
<span class="sourceLineNo">155</span><a id="line.155"> {</a>
<span class="sourceLineNo">156</span><a id="line.156"> return isTemplateInstance;</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"> public void setTemplateInstance( boolean templateInstance )</a>
<span class="sourceLineNo">160</span><a id="line.160"> {</a>
<span class="sourceLineNo">161</span><a id="line.161"> isTemplateInstance = templateInstance;</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"> @Schema(description = "Roles that are children of this role. This field may not be populated, depending on the REST method call.")</a>
<span class="sourceLineNo">165</span><a id="line.165"> public List&lt;BaseRoleInfo&gt; getChildren( )</a>
<span class="sourceLineNo">166</span><a id="line.166"> {</a>
<span class="sourceLineNo">167</span><a id="line.167"> return children;</a>
<span class="sourceLineNo">168</span><a id="line.168"> }</a>
<span class="sourceLineNo">169</span><a id="line.169"></a>
<span class="sourceLineNo">170</span><a id="line.170"> public void setChildren( List&lt;BaseRoleInfo&gt; children )</a>
<span class="sourceLineNo">171</span><a id="line.171"> {</a>
<span class="sourceLineNo">172</span><a id="line.172"> this.children = children;</a>
<span class="sourceLineNo">173</span><a id="line.173"> }</a>
<span class="sourceLineNo">174</span><a id="line.174"></a>
<span class="sourceLineNo">175</span><a id="line.175"> public void addChild(BaseRoleInfo child) {</a>
<span class="sourceLineNo">176</span><a id="line.176"> if (!this.children.contains( child ))</a>
<span class="sourceLineNo">177</span><a id="line.177"> {</a>
<span class="sourceLineNo">178</span><a id="line.178"> this.children.add( child );</a>
<span class="sourceLineNo">179</span><a id="line.179"> }</a>
<span class="sourceLineNo">180</span><a id="line.180"> }</a>
<span class="sourceLineNo">181</span><a id="line.181"></a>
<span class="sourceLineNo">182</span><a id="line.182"> @Schema(description = "This attribute is only set at specific REST calls, that return roles, that are either assigned or not assigned to a given user.")</a>
<span class="sourceLineNo">183</span><a id="line.183"> public boolean isAssigned( )</a>
<span class="sourceLineNo">184</span><a id="line.184"> {</a>
<span class="sourceLineNo">185</span><a id="line.185"> return assigned;</a>
<span class="sourceLineNo">186</span><a id="line.186"> }</a>
<span class="sourceLineNo">187</span><a id="line.187"></a>
<span class="sourceLineNo">188</span><a id="line.188"> public void setAssigned( boolean assigned )</a>
<span class="sourceLineNo">189</span><a id="line.189"> {</a>
<span class="sourceLineNo">190</span><a id="line.190"> this.assigned = assigned;</a>
<span class="sourceLineNo">191</span><a id="line.191"> }</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"> @Schema( description = "If true, the role is assignable to users or roles. Otherwise, it can be used only as parent role.")</a>
<span class="sourceLineNo">195</span><a id="line.195"> public boolean isAssignable()</a>
<span class="sourceLineNo">196</span><a id="line.196"> {</a>
<span class="sourceLineNo">197</span><a id="line.197"> return assignable;</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"> public void setAssignable( boolean assignable )</a>
<span class="sourceLineNo">201</span><a id="line.201"> {</a>
<span class="sourceLineNo">202</span><a id="line.202"> this.assignable = assignable;</a>
<span class="sourceLineNo">203</span><a id="line.203"> }</a>
<span class="sourceLineNo">204</span><a id="line.204"></a>
<span class="sourceLineNo">205</span><a id="line.205"> @Override</a>
<span class="sourceLineNo">206</span><a id="line.206"> public int hashCode( )</a>
<span class="sourceLineNo">207</span><a id="line.207"> {</a>
<span class="sourceLineNo">208</span><a id="line.208"> return id.hashCode( );</a>
<span class="sourceLineNo">209</span><a id="line.209"> }</a>
<span class="sourceLineNo">210</span><a id="line.210"></a>
<span class="sourceLineNo">211</span><a id="line.211"> @Override</a>
<span class="sourceLineNo">212</span><a id="line.212"> public String toString( )</a>
<span class="sourceLineNo">213</span><a id="line.213"> {</a>
<span class="sourceLineNo">214</span><a id="line.214"> final StringBuilder sb = new StringBuilder( "BaseRoleInfo{" );</a>
<span class="sourceLineNo">215</span><a id="line.215"> sb.append( "id='" ).append( id ).append( '\'' );</a>
<span class="sourceLineNo">216</span><a id="line.216"> sb.append( ", name='" ).append( name ).append( '\'' );</a>
<span class="sourceLineNo">217</span><a id="line.217"> sb.append( ", description='" ).append( description ).append( '\'' );</a>
<span class="sourceLineNo">218</span><a id="line.218"> sb.append( ", permanent=" ).append( permanent );</a>
<span class="sourceLineNo">219</span><a id="line.219"> sb.append( ", modelId='" ).append( modelId ).append( '\'' );</a>
<span class="sourceLineNo">220</span><a id="line.220"> sb.append( ", resource='" ).append( resource ).append( '\'' );</a>
<span class="sourceLineNo">221</span><a id="line.221"> sb.append( ", isTemplateInstance=" ).append( isTemplateInstance );</a>
<span class="sourceLineNo">222</span><a id="line.222"> sb.append( '}' );</a>
<span class="sourceLineNo">223</span><a id="line.223"> return sb.toString( );</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"> @Schema(name="application_id", description = "Application id, where this role belongs to. This is only filled by certain REST methods.")</a>
<span class="sourceLineNo">227</span><a id="line.227"> public String getApplicationId( )</a>
<span class="sourceLineNo">228</span><a id="line.228"> {</a>
<span class="sourceLineNo">229</span><a id="line.229"> return applicationId;</a>
<span class="sourceLineNo">230</span><a id="line.230"> }</a>
<span class="sourceLineNo">231</span><a id="line.231"></a>
<span class="sourceLineNo">232</span><a id="line.232"> public void setApplicationId( String applicationId )</a>
<span class="sourceLineNo">233</span><a id="line.233"> {</a>
<span class="sourceLineNo">234</span><a id="line.234"> this.applicationId = applicationId;</a>
<span class="sourceLineNo">235</span><a id="line.235"> }</a>
<span class="sourceLineNo">236</span><a id="line.236"></a>
<span class="sourceLineNo">237</span><a id="line.237"> public boolean isChild( )</a>
<span class="sourceLineNo">238</span><a id="line.238"> {</a>
<span class="sourceLineNo">239</span><a id="line.239"> return isChild;</a>
<span class="sourceLineNo">240</span><a id="line.240"> }</a>
<span class="sourceLineNo">241</span><a id="line.241"></a>
<span class="sourceLineNo">242</span><a id="line.242"> public void setChild( boolean child )</a>
<span class="sourceLineNo">243</span><a id="line.243"> {</a>
<span class="sourceLineNo">244</span><a id="line.244"> isChild = child;</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"> @XmlTransient</a>
<span class="sourceLineNo">248</span><a id="line.248"> public boolean isNotChild() {</a>
<span class="sourceLineNo">249</span><a id="line.249"> return !isChild;</a>
<span class="sourceLineNo">250</span><a id="line.250"> }</a>
<span class="sourceLineNo">251</span><a id="line.251"></a>
<span class="sourceLineNo">252</span><a id="line.252"> @Override</a>
<span class="sourceLineNo">253</span><a id="line.253"> public boolean equals( Object o )</a>
<span class="sourceLineNo">254</span><a id="line.254"> {</a>
<span class="sourceLineNo">255</span><a id="line.255"> if ( this == o ) return true;</a>
<span class="sourceLineNo">256</span><a id="line.256"> if ( o == null || getClass( ) != o.getClass( ) ) return false;</a>
<span class="sourceLineNo">257</span><a id="line.257"></a>
<span class="sourceLineNo">258</span><a id="line.258"> BaseRoleInfo that = (BaseRoleInfo) o;</a>
<span class="sourceLineNo">259</span><a id="line.259"></a>
<span class="sourceLineNo">260</span><a id="line.260"> if ( permanent != that.permanent ) return false;</a>
<span class="sourceLineNo">261</span><a id="line.261"> if ( isTemplateInstance != that.isTemplateInstance ) return false;</a>
<span class="sourceLineNo">262</span><a id="line.262"> if ( assignable != that.assignable ) return false;</a>
<span class="sourceLineNo">263</span><a id="line.263"> if ( !id.equals( that.id ) ) return false;</a>
<span class="sourceLineNo">264</span><a id="line.264"> if ( !name.equals( that.name ) ) return false;</a>
<span class="sourceLineNo">265</span><a id="line.265"> if ( description != null ? !description.equals( that.description ) : that.description != null ) return false;</a>
<span class="sourceLineNo">266</span><a id="line.266"> if ( modelId != null ? !modelId.equals( that.modelId ) : that.modelId != null ) return false;</a>
<span class="sourceLineNo">267</span><a id="line.267"> if ( resource != null ? !resource.equals( that.resource ) : that.resource != null ) return false;</a>
<span class="sourceLineNo">268</span><a id="line.268"> return applicationId != null ? applicationId.equals( that.applicationId ) : that.applicationId == null;</a>
<span class="sourceLineNo">269</span><a id="line.269"> }</a>
<span class="sourceLineNo">270</span><a id="line.270">}</a>
</pre>
</div>
</main>
</body>
</html>