Google Git
Sign in
apache / shiro-site / 01016f43374d9b054f3ea1e568b015d5d69428f9 / . / src / site / assets / static / 1.5.0 / shiro-core / apidocs / src-html / org / apache / shiro / authz / permission / DomainPermission.html
blob: c791635b8a06187cc6a7b82debbab145757c4080 [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.permission;</a>
<span class="sourceLineNo">020</span><a id="line.20"></a>
<span class="sourceLineNo">021</span><a id="line.21">import org.apache.shiro.util.StringUtils;</a>
<span class="sourceLineNo">022</span><a id="line.22"></a>
<span class="sourceLineNo">023</span><a id="line.23">import java.util.Set;</a>
<span class="sourceLineNo">024</span><a id="line.24"></a>
<span class="sourceLineNo">025</span><a id="line.25">/**</a>
<span class="sourceLineNo">026</span><a id="line.26"> * Provides a base Permission class from which type-safe/domain-specific subclasses may extend. Can be used</a>
<span class="sourceLineNo">027</span><a id="line.27"> * as a base class for JPA/Hibernate persisted permissions that wish to store the parts of the permission string</a>
<span class="sourceLineNo">028</span><a id="line.28"> * in separate columns (e.g. 'domain', 'actions' and 'targets' columns), which can be used in querying</a>
<span class="sourceLineNo">029</span><a id="line.29"> * strategies.</a>
<span class="sourceLineNo">030</span><a id="line.30"> *</a>
<span class="sourceLineNo">031</span><a id="line.31"> * @since 1.0</a>
<span class="sourceLineNo">032</span><a id="line.32"> */</a>
<span class="sourceLineNo">033</span><a id="line.33">public class DomainPermission extends WildcardPermission {</a>
<span class="sourceLineNo">034</span><a id="line.34"></a>
<span class="sourceLineNo">035</span><a id="line.35"> private String domain;</a>
<span class="sourceLineNo">036</span><a id="line.36"> private Set&lt;String&gt; actions;</a>
<span class="sourceLineNo">037</span><a id="line.37"> private Set&lt;String&gt; targets;</a>
<span class="sourceLineNo">038</span><a id="line.38"></a>
<span class="sourceLineNo">039</span><a id="line.39"> private static final long serialVersionUID = 1l;</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"> * Creates a domain permission with *all* actions for *all* targets;</a>
<span class="sourceLineNo">043</span><a id="line.43"> */</a>
<span class="sourceLineNo">044</span><a id="line.44"> public DomainPermission() {</a>
<span class="sourceLineNo">045</span><a id="line.45"> this.domain = getDomain(getClass());</a>
<span class="sourceLineNo">046</span><a id="line.46"> setParts(getDomain(getClass()));</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 DomainPermission(String actions) {</a>
<span class="sourceLineNo">050</span><a id="line.50"> domain = getDomain(getClass());</a>
<span class="sourceLineNo">051</span><a id="line.51"> this.actions = StringUtils.splitToSet(actions, SUBPART_DIVIDER_TOKEN);</a>
<span class="sourceLineNo">052</span><a id="line.52"> encodeParts(domain, actions, null);</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"> public DomainPermission(String actions, String targets) {</a>
<span class="sourceLineNo">056</span><a id="line.56"> this.domain = getDomain(getClass());</a>
<span class="sourceLineNo">057</span><a id="line.57"> this.actions = StringUtils.splitToSet(actions, SUBPART_DIVIDER_TOKEN);</a>
<span class="sourceLineNo">058</span><a id="line.58"> this.targets = StringUtils.splitToSet(targets, SUBPART_DIVIDER_TOKEN);</a>
<span class="sourceLineNo">059</span><a id="line.59"> encodeParts(this.domain, actions, targets);</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"> protected DomainPermission(Set&lt;String&gt; actions, Set&lt;String&gt; targets) {</a>
<span class="sourceLineNo">063</span><a id="line.63"> this.domain = getDomain(getClass());</a>
<span class="sourceLineNo">064</span><a id="line.64"> setParts(domain, actions, targets);</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"> private void encodeParts(String domain, String actions, String targets) {</a>
<span class="sourceLineNo">068</span><a id="line.68"> if (!StringUtils.hasText(domain)) {</a>
<span class="sourceLineNo">069</span><a id="line.69"> throw new IllegalArgumentException("domain argument cannot be null or empty.");</a>
<span class="sourceLineNo">070</span><a id="line.70"> }</a>
<span class="sourceLineNo">071</span><a id="line.71"> StringBuilder sb = new StringBuilder(domain);</a>
<span class="sourceLineNo">072</span><a id="line.72"></a>
<span class="sourceLineNo">073</span><a id="line.73"> if (!StringUtils.hasText(actions)) {</a>
<span class="sourceLineNo">074</span><a id="line.74"> if (StringUtils.hasText(targets)) {</a>
<span class="sourceLineNo">075</span><a id="line.75"> sb.append(PART_DIVIDER_TOKEN).append(WILDCARD_TOKEN);</a>
<span class="sourceLineNo">076</span><a id="line.76"> }</a>
<span class="sourceLineNo">077</span><a id="line.77"> } else {</a>
<span class="sourceLineNo">078</span><a id="line.78"> sb.append(PART_DIVIDER_TOKEN).append(actions);</a>
<span class="sourceLineNo">079</span><a id="line.79"> }</a>
<span class="sourceLineNo">080</span><a id="line.80"> if (StringUtils.hasText(targets)) {</a>
<span class="sourceLineNo">081</span><a id="line.81"> sb.append(PART_DIVIDER_TOKEN).append(targets);</a>
<span class="sourceLineNo">082</span><a id="line.82"> }</a>
<span class="sourceLineNo">083</span><a id="line.83"> setParts(sb.toString());</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"> protected void setParts(String domain, Set&lt;String&gt; actions, Set&lt;String&gt; targets) {</a>
<span class="sourceLineNo">087</span><a id="line.87"> String actionsString = StringUtils.toDelimitedString(actions, SUBPART_DIVIDER_TOKEN);</a>
<span class="sourceLineNo">088</span><a id="line.88"> String targetsString = StringUtils.toDelimitedString(targets, SUBPART_DIVIDER_TOKEN);</a>
<span class="sourceLineNo">089</span><a id="line.89"> encodeParts(domain, actionsString, targetsString);</a>
<span class="sourceLineNo">090</span><a id="line.90"> this.domain = domain;</a>
<span class="sourceLineNo">091</span><a id="line.91"> this.actions = actions;</a>
<span class="sourceLineNo">092</span><a id="line.92"> this.targets = targets;</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"> protected String getDomain(Class&lt;? extends DomainPermission&gt; clazz) {</a>
<span class="sourceLineNo">096</span><a id="line.96"> String domain = clazz.getSimpleName().toLowerCase();</a>
<span class="sourceLineNo">097</span><a id="line.97"> //strip any trailing 'permission' text from the name (as all subclasses should have been named):</a>
<span class="sourceLineNo">098</span><a id="line.98"> int index = domain.lastIndexOf("permission");</a>
<span class="sourceLineNo">099</span><a id="line.99"> if (index != -1) {</a>
<span class="sourceLineNo">100</span><a id="line.100"> domain = domain.substring(0, index);</a>
<span class="sourceLineNo">101</span><a id="line.101"> }</a>
<span class="sourceLineNo">102</span><a id="line.102"> return domain;</a>
<span class="sourceLineNo">103</span><a id="line.103"> }</a>
<span class="sourceLineNo">104</span><a id="line.104"></a>
<span class="sourceLineNo">105</span><a id="line.105"> public String getDomain() {</a>
<span class="sourceLineNo">106</span><a id="line.106"> return domain;</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"> protected void setDomain(String domain) {</a>
<span class="sourceLineNo">110</span><a id="line.110"> if (this.domain != null &amp;&amp; this.domain.equals(domain)) {</a>
<span class="sourceLineNo">111</span><a id="line.111"> return;</a>
<span class="sourceLineNo">112</span><a id="line.112"> }</a>
<span class="sourceLineNo">113</span><a id="line.113"> this.domain = domain;</a>
<span class="sourceLineNo">114</span><a id="line.114"> setParts(domain, actions, targets);</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"> public Set&lt;String&gt; getActions() {</a>
<span class="sourceLineNo">118</span><a id="line.118"> return actions;</a>
<span class="sourceLineNo">119</span><a id="line.119"> }</a>
<span class="sourceLineNo">120</span><a id="line.120"></a>
<span class="sourceLineNo">121</span><a id="line.121"> protected void setActions(Set&lt;String&gt; actions) {</a>
<span class="sourceLineNo">122</span><a id="line.122"> if (this.actions != null &amp;&amp; this.actions.equals(actions)) {</a>
<span class="sourceLineNo">123</span><a id="line.123"> return;</a>
<span class="sourceLineNo">124</span><a id="line.124"> }</a>
<span class="sourceLineNo">125</span><a id="line.125"> this.actions = actions;</a>
<span class="sourceLineNo">126</span><a id="line.126"> setParts(domain, actions, targets);</a>
<span class="sourceLineNo">127</span><a id="line.127"> }</a>
<span class="sourceLineNo">128</span><a id="line.128"></a>
<span class="sourceLineNo">129</span><a id="line.129"> public Set&lt;String&gt; getTargets() {</a>
<span class="sourceLineNo">130</span><a id="line.130"> return targets;</a>
<span class="sourceLineNo">131</span><a id="line.131"> }</a>
<span class="sourceLineNo">132</span><a id="line.132"></a>
<span class="sourceLineNo">133</span><a id="line.133"> protected void setTargets(Set&lt;String&gt; targets) {</a>
<span class="sourceLineNo">134</span><a id="line.134"> if (this.targets != null &amp;&amp; this.targets.equals(targets)) {</a>
<span class="sourceLineNo">135</span><a id="line.135"> return;</a>
<span class="sourceLineNo">136</span><a id="line.136"> }</a>
<span class="sourceLineNo">137</span><a id="line.137"> this.targets = targets;</a>
<span class="sourceLineNo">138</span><a id="line.138"> setParts(domain, actions, targets);</a>
<span class="sourceLineNo">139</span><a id="line.139"> }</a>
<span class="sourceLineNo">140</span><a id="line.140">}</a>
</pre>
</div>
</main>
</body>
</html>