Google Git
Sign in
apache / shiro-site / 01016f43374d9b054f3ea1e568b015d5d69428f9 / . / src / site / assets / static / 1.2.5 / xref / org / apache / shiro / authz / permission / DomainPermission.html
blob: f831347e4c899f94df37b5bac7cf7bd95c784fed [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
<title>DomainPermission xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../apidocs/org/apache/shiro/authz/permission/DomainPermission.html">View Javadoc</a></div><pre>
<a name="1" href="#1">1</a> <em class="jxr_comment">/*</em>
<a name="2" href="#2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
<a name="3" href="#3">3</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em>
<a name="4" href="#4">4</a> <em class="jxr_comment"> * distributed with this work for additional information</em>
<a name="5" href="#5">5</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em>
<a name="6" href="#6">6</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em>
<a name="7" href="#7">7</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em>
<a name="8" href="#8">8</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em>
<a name="9" href="#9">9</a> <em class="jxr_comment"> *</em>
<a name="10" href="#10">10</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a name="11" href="#11">11</a> <em class="jxr_comment"> *</em>
<a name="12" href="#12">12</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em>
<a name="13" href="#13">13</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em>
<a name="14" href="#14">14</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em>
<a name="15" href="#15">15</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em>
<a name="16" href="#16">16</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em>
<a name="17" href="#17">17</a> <em class="jxr_comment"> * under the License.</em>
<a name="18" href="#18">18</a> <em class="jxr_comment"> */</em>
<a name="19" href="#19">19</a> <strong class="jxr_keyword">package</strong> org.apache.shiro.authz.permission;
<a name="20" href="#20">20</a>
<a name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.util.StringUtils;
<a name="22" href="#22">22</a>
<a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> java.util.Set;
<a name="24" href="#24">24</a>
<a name="25" href="#25">25</a> <em class="jxr_javadoccomment">/**</em>
<a name="26" href="#26">26</a> <em class="jxr_javadoccomment"> * Provides a base Permission class from which type-safe/domain-specific subclasses may extend. Can be used</em>
<a name="27" href="#27">27</a> <em class="jxr_javadoccomment"> * as a base class for JPA/Hibernate persisted permissions that wish to store the parts of the permission string</em>
<a name="28" href="#28">28</a> <em class="jxr_javadoccomment"> * in separate columns (e.g. 'domain', 'actions' and 'targets' columns), which can be used in querying</em>
<a name="29" href="#29">29</a> <em class="jxr_javadoccomment"> * strategies.</em>
<a name="30" href="#30">30</a> <em class="jxr_javadoccomment"> *</em>
<a name="31" href="#31">31</a> <em class="jxr_javadoccomment"> * @since 1.0</em>
<a name="32" href="#32">32</a> <em class="jxr_javadoccomment"> */</em>
<a name="33" href="#33">33</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/shiro/authz/permission/DomainPermission.html">DomainPermission</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../org/apache/shiro/authz/permission/WildcardPermission.html">WildcardPermission</a> {
<a name="34" href="#34">34</a>
<a name="35" href="#35">35</a> <strong class="jxr_keyword">private</strong> String domain;
<a name="36" href="#36">36</a> <strong class="jxr_keyword">private</strong> Set&lt;String&gt; actions;
<a name="37" href="#37">37</a> <strong class="jxr_keyword">private</strong> Set&lt;String&gt; targets;
<a name="38" href="#38">38</a>
<a name="39" href="#39">39</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">long</strong> serialVersionUID = 1l;
<a name="40" href="#40">40</a>
<a name="41" href="#41">41</a> <em class="jxr_javadoccomment">/**</em>
<a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * Creates a domain permission with *all* actions for *all* targets;</em>
<a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> */</em>
<a name="44" href="#44">44</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/shiro/authz/permission/DomainPermission.html">DomainPermission</a>() {
<a name="45" href="#45">45</a> <strong class="jxr_keyword">this</strong>.domain = getDomain(getClass());
<a name="46" href="#46">46</a> setParts(getDomain(getClass()));
<a name="47" href="#47">47</a> }
<a name="48" href="#48">48</a>
<a name="49" href="#49">49</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/shiro/authz/permission/DomainPermission.html">DomainPermission</a>(String actions) {
<a name="50" href="#50">50</a> domain = getDomain(getClass());
<a name="51" href="#51">51</a> <strong class="jxr_keyword">this</strong>.actions = StringUtils.splitToSet(actions, SUBPART_DIVIDER_TOKEN);
<a name="52" href="#52">52</a> encodeParts(domain, actions, <strong class="jxr_keyword">null</strong>);
<a name="53" href="#53">53</a> }
<a name="54" href="#54">54</a>
<a name="55" href="#55">55</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/shiro/authz/permission/DomainPermission.html">DomainPermission</a>(String actions, String targets) {
<a name="56" href="#56">56</a> <strong class="jxr_keyword">this</strong>.domain = getDomain(getClass());
<a name="57" href="#57">57</a> <strong class="jxr_keyword">this</strong>.actions = StringUtils.splitToSet(actions, SUBPART_DIVIDER_TOKEN);
<a name="58" href="#58">58</a> <strong class="jxr_keyword">this</strong>.targets = StringUtils.splitToSet(targets, SUBPART_DIVIDER_TOKEN);
<a name="59" href="#59">59</a> encodeParts(<strong class="jxr_keyword">this</strong>.domain, actions, targets);
<a name="60" href="#60">60</a> }
<a name="61" href="#61">61</a>
<a name="62" href="#62">62</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../org/apache/shiro/authz/permission/DomainPermission.html">DomainPermission</a>(Set&lt;String&gt; actions, Set&lt;String&gt; targets) {
<a name="63" href="#63">63</a> <strong class="jxr_keyword">this</strong>.domain = getDomain(getClass());
<a name="64" href="#64">64</a> setParts(domain, actions, targets);
<a name="65" href="#65">65</a> }
<a name="66" href="#66">66</a>
<a name="67" href="#67">67</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> encodeParts(String domain, String actions, String targets) {
<a name="68" href="#68">68</a> <strong class="jxr_keyword">if</strong> (!StringUtils.hasText(domain)) {
<a name="69" href="#69">69</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"domain argument cannot be null or empty."</span>);
<a name="70" href="#70">70</a> }
<a name="71" href="#71">71</a> StringBuilder sb = <strong class="jxr_keyword">new</strong> StringBuilder(domain);
<a name="72" href="#72">72</a>
<a name="73" href="#73">73</a> <strong class="jxr_keyword">if</strong> (!StringUtils.hasText(actions)) {
<a name="74" href="#74">74</a> <strong class="jxr_keyword">if</strong> (StringUtils.hasText(targets)) {
<a name="75" href="#75">75</a> sb.append(PART_DIVIDER_TOKEN).append(WILDCARD_TOKEN);
<a name="76" href="#76">76</a> }
<a name="77" href="#77">77</a> } <strong class="jxr_keyword">else</strong> {
<a name="78" href="#78">78</a> sb.append(PART_DIVIDER_TOKEN).append(actions);
<a name="79" href="#79">79</a> }
<a name="80" href="#80">80</a> <strong class="jxr_keyword">if</strong> (StringUtils.hasText(targets)) {
<a name="81" href="#81">81</a> sb.append(PART_DIVIDER_TOKEN).append(targets);
<a name="82" href="#82">82</a> }
<a name="83" href="#83">83</a> setParts(sb.toString());
<a name="84" href="#84">84</a> }
<a name="85" href="#85">85</a>
<a name="86" href="#86">86</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> setParts(String domain, Set&lt;String&gt; actions, Set&lt;String&gt; targets) {
<a name="87" href="#87">87</a> String actionsString = StringUtils.toDelimitedString(actions, SUBPART_DIVIDER_TOKEN);
<a name="88" href="#88">88</a> String targetsString = StringUtils.toDelimitedString(targets, SUBPART_DIVIDER_TOKEN);
<a name="89" href="#89">89</a> encodeParts(domain, actionsString, targetsString);
<a name="90" href="#90">90</a> <strong class="jxr_keyword">this</strong>.domain = domain;
<a name="91" href="#91">91</a> <strong class="jxr_keyword">this</strong>.actions = actions;
<a name="92" href="#92">92</a> <strong class="jxr_keyword">this</strong>.targets = targets;
<a name="93" href="#93">93</a> }
<a name="94" href="#94">94</a>
<a name="95" href="#95">95</a> <strong class="jxr_keyword">protected</strong> String getDomain(Class&lt;? <strong class="jxr_keyword">extends</strong> DomainPermission&gt; clazz) {
<a name="96" href="#96">96</a> String domain = clazz.getSimpleName().toLowerCase();
<a name="97" href="#97">97</a> <em class="jxr_comment">//strip any trailing 'permission' text from the name (as all subclasses should have been named):</em>
<a name="98" href="#98">98</a> <strong class="jxr_keyword">int</strong> index = domain.lastIndexOf(<span class="jxr_string">"permission"</span>);
<a name="99" href="#99">99</a> <strong class="jxr_keyword">if</strong> (index != -1) {
<a name="100" href="#100">100</a> domain = domain.substring(0, index);
<a name="101" href="#101">101</a> }
<a name="102" href="#102">102</a> <strong class="jxr_keyword">return</strong> domain;
<a name="103" href="#103">103</a> }
<a name="104" href="#104">104</a>
<a name="105" href="#105">105</a> <strong class="jxr_keyword">public</strong> String getDomain() {
<a name="106" href="#106">106</a> <strong class="jxr_keyword">return</strong> domain;
<a name="107" href="#107">107</a> }
<a name="108" href="#108">108</a>
<a name="109" href="#109">109</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> setDomain(String domain) {
<a name="110" href="#110">110</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.domain != <strong class="jxr_keyword">null</strong> &amp;&amp; <strong class="jxr_keyword">this</strong>.domain.equals(domain)) {
<a name="111" href="#111">111</a> <strong class="jxr_keyword">return</strong>;
<a name="112" href="#112">112</a> }
<a name="113" href="#113">113</a> <strong class="jxr_keyword">this</strong>.domain = domain;
<a name="114" href="#114">114</a> setParts(domain, actions, targets);
<a name="115" href="#115">115</a> }
<a name="116" href="#116">116</a>
<a name="117" href="#117">117</a> <strong class="jxr_keyword">public</strong> Set&lt;String&gt; getActions() {
<a name="118" href="#118">118</a> <strong class="jxr_keyword">return</strong> actions;
<a name="119" href="#119">119</a> }
<a name="120" href="#120">120</a>
<a name="121" href="#121">121</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> setActions(Set&lt;String&gt; actions) {
<a name="122" href="#122">122</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.actions != <strong class="jxr_keyword">null</strong> &amp;&amp; <strong class="jxr_keyword">this</strong>.actions.equals(actions)) {
<a name="123" href="#123">123</a> <strong class="jxr_keyword">return</strong>;
<a name="124" href="#124">124</a> }
<a name="125" href="#125">125</a> <strong class="jxr_keyword">this</strong>.actions = actions;
<a name="126" href="#126">126</a> setParts(domain, actions, targets);
<a name="127" href="#127">127</a> }
<a name="128" href="#128">128</a>
<a name="129" href="#129">129</a> <strong class="jxr_keyword">public</strong> Set&lt;String&gt; getTargets() {
<a name="130" href="#130">130</a> <strong class="jxr_keyword">return</strong> targets;
<a name="131" href="#131">131</a> }
<a name="132" href="#132">132</a>
<a name="133" href="#133">133</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> setTargets(Set&lt;String&gt; targets) {
<a name="134" href="#134">134</a> <strong class="jxr_keyword">this</strong>.targets = targets;
<a name="135" href="#135">135</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.targets != <strong class="jxr_keyword">null</strong> &amp;&amp; <strong class="jxr_keyword">this</strong>.targets.equals(targets)) {
<a name="136" href="#136">136</a> <strong class="jxr_keyword">return</strong>;
<a name="137" href="#137">137</a> }
<a name="138" href="#138">138</a> <strong class="jxr_keyword">this</strong>.targets = targets;
<a name="139" href="#139">139</a> setParts(domain, actions, targets);
<a name="140" href="#140">140</a> }
<a name="141" href="#141">141</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>