Google Git
Sign in
apache / shiro-site / 01016f43374d9b054f3ea1e568b015d5d69428f9 / . / src / site / assets / static / 1.5.0 / shiro-core / apidocs / src-html / org / apache / shiro / authz / SimpleRole.html
blob: 9ed5f35d65806d8cc5b8ac71623f004171766f2d [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="fr">
<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">/*</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"> *</a>
<span class="sourceLineNo">012</span><a id="line.12"> * Unless required by applicable law or agreed to in writing,</a>
<span class="sourceLineNo">013</span><a id="line.13"> * software distributed under the License is distributed on an</a>
<span class="sourceLineNo">014</span><a id="line.14"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</a>
<span class="sourceLineNo">015</span><a id="line.15"> * KIND, either express or implied. See the License for the</a>
<span class="sourceLineNo">016</span><a id="line.16"> * specific language governing permissions and limitations</a>
<span class="sourceLineNo">017</span><a id="line.17"> * under the License.</a>
<span class="sourceLineNo">018</span><a id="line.18"> */</a>
<span class="sourceLineNo">019</span><a id="line.19">package org.apache.shiro.authz;</a>
<span class="sourceLineNo">020</span><a id="line.20"></a>
<span class="sourceLineNo">021</span><a id="line.21">import java.io.Serializable;</a>
<span class="sourceLineNo">022</span><a id="line.22">import java.util.Collection;</a>
<span class="sourceLineNo">023</span><a id="line.23">import java.util.LinkedHashSet;</a>
<span class="sourceLineNo">024</span><a id="line.24">import java.util.Set;</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"> * A simple representation of a security role that has a name and a collection of permissions. This object can be</a>
<span class="sourceLineNo">028</span><a id="line.28"> * used internally by Realms to maintain authorization state.</a>
<span class="sourceLineNo">029</span><a id="line.29"> *</a>
<span class="sourceLineNo">030</span><a id="line.30"> * @since 0.2</a>
<span class="sourceLineNo">031</span><a id="line.31"> */</a>
<span class="sourceLineNo">032</span><a id="line.32">public class SimpleRole implements Serializable {</a>
<span class="sourceLineNo">033</span><a id="line.33"></a>
<span class="sourceLineNo">034</span><a id="line.34"> protected String name = null;</a>
<span class="sourceLineNo">035</span><a id="line.35"> protected Set&lt;Permission&gt; permissions;</a>
<span class="sourceLineNo">036</span><a id="line.36"></a>
<span class="sourceLineNo">037</span><a id="line.37"> public SimpleRole() {</a>
<span class="sourceLineNo">038</span><a id="line.38"> }</a>
<span class="sourceLineNo">039</span><a id="line.39"></a>
<span class="sourceLineNo">040</span><a id="line.40"> public SimpleRole(String name) {</a>
<span class="sourceLineNo">041</span><a id="line.41"> setName(name);</a>
<span class="sourceLineNo">042</span><a id="line.42"> }</a>
<span class="sourceLineNo">043</span><a id="line.43"></a>
<span class="sourceLineNo">044</span><a id="line.44"> public SimpleRole(String name, Set&lt;Permission&gt; permissions) {</a>
<span class="sourceLineNo">045</span><a id="line.45"> setName(name);</a>
<span class="sourceLineNo">046</span><a id="line.46"> setPermissions(permissions);</a>
<span class="sourceLineNo">047</span><a id="line.47"> }</a>
<span class="sourceLineNo">048</span><a id="line.48"></a>
<span class="sourceLineNo">049</span><a id="line.49"> public String getName() {</a>
<span class="sourceLineNo">050</span><a id="line.50"> return name;</a>
<span class="sourceLineNo">051</span><a id="line.51"> }</a>
<span class="sourceLineNo">052</span><a id="line.52"></a>
<span class="sourceLineNo">053</span><a id="line.53"> public void setName(String name) {</a>
<span class="sourceLineNo">054</span><a id="line.54"> this.name = name;</a>
<span class="sourceLineNo">055</span><a id="line.55"> }</a>
<span class="sourceLineNo">056</span><a id="line.56"></a>
<span class="sourceLineNo">057</span><a id="line.57"> public Set&lt;Permission&gt; getPermissions() {</a>
<span class="sourceLineNo">058</span><a id="line.58"> return permissions;</a>
<span class="sourceLineNo">059</span><a id="line.59"> }</a>
<span class="sourceLineNo">060</span><a id="line.60"></a>
<span class="sourceLineNo">061</span><a id="line.61"> public void setPermissions(Set&lt;Permission&gt; permissions) {</a>
<span class="sourceLineNo">062</span><a id="line.62"> this.permissions = permissions;</a>
<span class="sourceLineNo">063</span><a id="line.63"> }</a>
<span class="sourceLineNo">064</span><a id="line.64"></a>
<span class="sourceLineNo">065</span><a id="line.65"> public void add(Permission permission) {</a>
<span class="sourceLineNo">066</span><a id="line.66"> Set&lt;Permission&gt; permissions = getPermissions();</a>
<span class="sourceLineNo">067</span><a id="line.67"> if (permissions == null) {</a>
<span class="sourceLineNo">068</span><a id="line.68"> permissions = new LinkedHashSet&lt;Permission&gt;();</a>
<span class="sourceLineNo">069</span><a id="line.69"> setPermissions(permissions);</a>
<span class="sourceLineNo">070</span><a id="line.70"> }</a>
<span class="sourceLineNo">071</span><a id="line.71"> permissions.add(permission);</a>
<span class="sourceLineNo">072</span><a id="line.72"> }</a>
<span class="sourceLineNo">073</span><a id="line.73"></a>
<span class="sourceLineNo">074</span><a id="line.74"> public void addAll(Collection&lt;Permission&gt; perms) {</a>
<span class="sourceLineNo">075</span><a id="line.75"> if (perms != null &amp;&amp; !perms.isEmpty()) {</a>
<span class="sourceLineNo">076</span><a id="line.76"> Set&lt;Permission&gt; permissions = getPermissions();</a>
<span class="sourceLineNo">077</span><a id="line.77"> if (permissions == null) {</a>
<span class="sourceLineNo">078</span><a id="line.78"> permissions = new LinkedHashSet&lt;Permission&gt;(perms.size());</a>
<span class="sourceLineNo">079</span><a id="line.79"> setPermissions(permissions);</a>
<span class="sourceLineNo">080</span><a id="line.80"> }</a>
<span class="sourceLineNo">081</span><a id="line.81"> permissions.addAll(perms);</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"></a>
<span class="sourceLineNo">085</span><a id="line.85"> public boolean isPermitted(Permission p) {</a>
<span class="sourceLineNo">086</span><a id="line.86"> Collection&lt;Permission&gt; perms = getPermissions();</a>
<span class="sourceLineNo">087</span><a id="line.87"> if (perms != null &amp;&amp; !perms.isEmpty()) {</a>
<span class="sourceLineNo">088</span><a id="line.88"> for (Permission perm : perms) {</a>
<span class="sourceLineNo">089</span><a id="line.89"> if (perm.implies(p)) {</a>
<span class="sourceLineNo">090</span><a id="line.90"> return true;</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"> }</a>
<span class="sourceLineNo">094</span><a id="line.94"> return false;</a>
<span class="sourceLineNo">095</span><a id="line.95"> }</a>
<span class="sourceLineNo">096</span><a id="line.96"></a>
<span class="sourceLineNo">097</span><a id="line.97"> public int hashCode() {</a>
<span class="sourceLineNo">098</span><a id="line.98"> return (getName() != null ? getName().hashCode() : 0);</a>
<span class="sourceLineNo">099</span><a id="line.99"> }</a>
<span class="sourceLineNo">100</span><a id="line.100"></a>
<span class="sourceLineNo">101</span><a id="line.101"> public boolean equals(Object o) {</a>
<span class="sourceLineNo">102</span><a id="line.102"> if (o == this) {</a>
<span class="sourceLineNo">103</span><a id="line.103"> return true;</a>
<span class="sourceLineNo">104</span><a id="line.104"> }</a>
<span class="sourceLineNo">105</span><a id="line.105"> if (o instanceof SimpleRole) {</a>
<span class="sourceLineNo">106</span><a id="line.106"> SimpleRole sr = (SimpleRole) o;</a>
<span class="sourceLineNo">107</span><a id="line.107"> //only check name, since role names should be unique across an entire application:</a>
<span class="sourceLineNo">108</span><a id="line.108"> return (getName() != null ? getName().equals(sr.getName()) : sr.getName() == null);</a>
<span class="sourceLineNo">109</span><a id="line.109"> }</a>
<span class="sourceLineNo">110</span><a id="line.110"> return false;</a>
<span class="sourceLineNo">111</span><a id="line.111"> }</a>
<span class="sourceLineNo">112</span><a id="line.112"></a>
<span class="sourceLineNo">113</span><a id="line.113"> public String toString() {</a>
<span class="sourceLineNo">114</span><a id="line.114"> return getName();</a>
<span class="sourceLineNo">115</span><a id="line.115"> }</a>
<span class="sourceLineNo">116</span><a id="line.116">}</a>
</pre>
</div>
</main>
</body>
</html>