Google Git
Sign in
apache / archiva-web-content / 1b7e811f9aa411dd1b001fe82a147012e4cce823 / . / redback / core / 3.0.0-SNAPSHOT / apidocs / src-html / org / apache / archiva / redback / rest / api / model / v2 / Permission.html
blob: 8c7677ffe76e12a2ab4991fd0ee99ff9a7f971cd [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">/*</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.media.Schema;</a>
<span class="sourceLineNo">022</span><a id="line.22">import org.apache.archiva.redback.rest.api.model.v2.Resource;</a>
<span class="sourceLineNo">023</span><a id="line.23"></a>
<span class="sourceLineNo">024</span><a id="line.24">import javax.xml.bind.annotation.XmlRootElement;</a>
<span class="sourceLineNo">025</span><a id="line.25">import java.io.Serializable;</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"> * @author Olivier Lamy</a>
<span class="sourceLineNo">029</span><a id="line.29"> * @since 1.4</a>
<span class="sourceLineNo">030</span><a id="line.30"> */</a>
<span class="sourceLineNo">031</span><a id="line.31">@XmlRootElement( name = "permission" )</a>
<span class="sourceLineNo">032</span><a id="line.32">@Schema(name="Permission", description = "Permission that allows operation on resources")</a>
<span class="sourceLineNo">033</span><a id="line.33">public class Permission</a>
<span class="sourceLineNo">034</span><a id="line.34"> 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 = 4243488525173718059L;</a>
<span class="sourceLineNo">037</span><a id="line.37"> private String name;</a>
<span class="sourceLineNo">038</span><a id="line.38"></a>
<span class="sourceLineNo">039</span><a id="line.39"> private String description;</a>
<span class="sourceLineNo">040</span><a id="line.40"></a>
<span class="sourceLineNo">041</span><a id="line.41"> private String descriptionKey;</a>
<span class="sourceLineNo">042</span><a id="line.42"></a>
<span class="sourceLineNo">043</span><a id="line.43"> private Operation operation;</a>
<span class="sourceLineNo">044</span><a id="line.44"></a>
<span class="sourceLineNo">045</span><a id="line.45"> private Resource resource;</a>
<span class="sourceLineNo">046</span><a id="line.46"></a>
<span class="sourceLineNo">047</span><a id="line.47"> private boolean permanent;</a>
<span class="sourceLineNo">048</span><a id="line.48"></a>
<span class="sourceLineNo">049</span><a id="line.49"> public Permission()</a>
<span class="sourceLineNo">050</span><a id="line.50"> {</a>
<span class="sourceLineNo">051</span><a id="line.51"> // no op</a>
<span class="sourceLineNo">052</span><a id="line.52"> }</a>
<span class="sourceLineNo">053</span><a id="line.53"></a>
<span class="sourceLineNo">054</span><a id="line.54"> public Permission( org.apache.archiva.redback.rbac.Permission permission )</a>
<span class="sourceLineNo">055</span><a id="line.55"> {</a>
<span class="sourceLineNo">056</span><a id="line.56"> this.name = permission.getName();</a>
<span class="sourceLineNo">057</span><a id="line.57"> this.description = permission.getDescription();</a>
<span class="sourceLineNo">058</span><a id="line.58"> this.operation = permission.getOperation() == null ? null : new Operation( permission.getOperation() );</a>
<span class="sourceLineNo">059</span><a id="line.59"> this.resource = permission.getResource() == null ? null : new Resource( permission.getResource() );</a>
<span class="sourceLineNo">060</span><a id="line.60"> this.permanent = permission.isPermanent();</a>
<span class="sourceLineNo">061</span><a id="line.61"> }</a>
<span class="sourceLineNo">062</span><a id="line.62"></a>
<span class="sourceLineNo">063</span><a id="line.63"> public static Permission of( org.apache.archiva.redback.rbac.Permission perm ) {</a>
<span class="sourceLineNo">064</span><a id="line.64"> return new Permission( perm );</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"> @Schema(name="name", description = "The identifier of the permission")</a>
<span class="sourceLineNo">068</span><a id="line.68"> public String getName()</a>
<span class="sourceLineNo">069</span><a id="line.69"> {</a>
<span class="sourceLineNo">070</span><a id="line.70"> return name;</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 void setName( String name )</a>
<span class="sourceLineNo">074</span><a id="line.74"> {</a>
<span class="sourceLineNo">075</span><a id="line.75"> this.name = name;</a>
<span class="sourceLineNo">076</span><a id="line.76"> }</a>
<span class="sourceLineNo">077</span><a id="line.77"></a>
<span class="sourceLineNo">078</span><a id="line.78"> @Schema(name="operation", description = "The operation that is assigned to this permission")</a>
<span class="sourceLineNo">079</span><a id="line.79"> public Operation getOperation()</a>
<span class="sourceLineNo">080</span><a id="line.80"> {</a>
<span class="sourceLineNo">081</span><a id="line.81"> return operation;</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"> public void setOperation( Operation operation )</a>
<span class="sourceLineNo">085</span><a id="line.85"> {</a>
<span class="sourceLineNo">086</span><a id="line.86"> this.operation = operation;</a>
<span class="sourceLineNo">087</span><a id="line.87"> }</a>
<span class="sourceLineNo">088</span><a id="line.88"></a>
<span class="sourceLineNo">089</span><a id="line.89"> @Schema(name="resource", description = "The resource this permission applies to")</a>
<span class="sourceLineNo">090</span><a id="line.90"> public Resource getResource()</a>
<span class="sourceLineNo">091</span><a id="line.91"> {</a>
<span class="sourceLineNo">092</span><a id="line.92"> return resource;</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"> public void setResource( Resource resource )</a>
<span class="sourceLineNo">096</span><a id="line.96"> {</a>
<span class="sourceLineNo">097</span><a id="line.97"> this.resource = resource;</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"> @Override</a>
<span class="sourceLineNo">101</span><a id="line.101"> public String toString()</a>
<span class="sourceLineNo">102</span><a id="line.102"> {</a>
<span class="sourceLineNo">103</span><a id="line.103"> final StringBuilder sb = new StringBuilder();</a>
<span class="sourceLineNo">104</span><a id="line.104"> sb.append( "Permission" );</a>
<span class="sourceLineNo">105</span><a id="line.105"> sb.append( "{name='" ).append( name ).append( '\'' );</a>
<span class="sourceLineNo">106</span><a id="line.106"> sb.append( ", description='" ).append( description ).append( '\'' );</a>
<span class="sourceLineNo">107</span><a id="line.107"> sb.append( ", operation=" ).append( operation );</a>
<span class="sourceLineNo">108</span><a id="line.108"> sb.append( ", resource=" ).append( resource );</a>
<span class="sourceLineNo">109</span><a id="line.109"> sb.append( ", permanent=" ).append( permanent );</a>
<span class="sourceLineNo">110</span><a id="line.110"> sb.append( '}' );</a>
<span class="sourceLineNo">111</span><a id="line.111"> return sb.toString();</a>
<span class="sourceLineNo">112</span><a id="line.112"> }</a>
<span class="sourceLineNo">113</span><a id="line.113"></a>
<span class="sourceLineNo">114</span><a id="line.114"> @Schema(name="description_key",description = "The language key for the description")</a>
<span class="sourceLineNo">115</span><a id="line.115"> public String getDescriptionKey( )</a>
<span class="sourceLineNo">116</span><a id="line.116"> {</a>
<span class="sourceLineNo">117</span><a id="line.117"> return descriptionKey;</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"> public void setDescriptionKey( String descriptionKey )</a>
<span class="sourceLineNo">121</span><a id="line.121"> {</a>
<span class="sourceLineNo">122</span><a id="line.122"> this.descriptionKey = descriptionKey;</a>
<span class="sourceLineNo">123</span><a id="line.123"> }</a>
<span class="sourceLineNo">124</span><a id="line.124">}</a>
</pre>
</div>
</main>
</body>
</html>