blob: 64263c3d840a960662b77dbb64f0f289667a7f1a [file] [log] [blame]
<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT> /*<a name="line.1"></a>
<FONT color="green">002</FONT> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a>
<FONT color="green">003</FONT> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a>
<FONT color="green">004</FONT> * distributed with this work for additional information<a name="line.4"></a>
<FONT color="green">005</FONT> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a>
<FONT color="green">006</FONT> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a>
<FONT color="green">007</FONT> * "License"); you may not use this file except in compliance<a name="line.7"></a>
<FONT color="green">008</FONT> * with the License. You may obtain a copy of the License at<a name="line.8"></a>
<FONT color="green">009</FONT> *<a name="line.9"></a>
<FONT color="green">010</FONT> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<FONT color="green">011</FONT> *<a name="line.11"></a>
<FONT color="green">012</FONT> * Unless required by applicable law or agreed to in writing,<a name="line.12"></a>
<FONT color="green">013</FONT> * software distributed under the License is distributed on an<a name="line.13"></a>
<FONT color="green">014</FONT> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.14"></a>
<FONT color="green">015</FONT> * KIND, either express or implied. See the License for the<a name="line.15"></a>
<FONT color="green">016</FONT> * specific language governing permissions and limitations<a name="line.16"></a>
<FONT color="green">017</FONT> * under the License.<a name="line.17"></a>
<FONT color="green">018</FONT> */<a name="line.18"></a>
<FONT color="green">019</FONT> package org.apache.shiro.authz;<a name="line.19"></a>
<FONT color="green">020</FONT> <a name="line.20"></a>
<FONT color="green">021</FONT> import java.util.Collection;<a name="line.21"></a>
<FONT color="green">022</FONT> import java.util.HashSet;<a name="line.22"></a>
<FONT color="green">023</FONT> import java.util.Set;<a name="line.23"></a>
<FONT color="green">024</FONT> <a name="line.24"></a>
<FONT color="green">025</FONT> /**<a name="line.25"></a>
<FONT color="green">026</FONT> * Simple POJO implementation of the {@link AuthorizationInfo} interface that stores roles and permissions as internal<a name="line.26"></a>
<FONT color="green">027</FONT> * attributes.<a name="line.27"></a>
<FONT color="green">028</FONT> *<a name="line.28"></a>
<FONT color="green">029</FONT> * @see org.apache.shiro.realm.AuthorizingRealm<a name="line.29"></a>
<FONT color="green">030</FONT> * @since 0.9<a name="line.30"></a>
<FONT color="green">031</FONT> */<a name="line.31"></a>
<FONT color="green">032</FONT> public class SimpleAuthorizationInfo implements AuthorizationInfo {<a name="line.32"></a>
<FONT color="green">033</FONT> <a name="line.33"></a>
<FONT color="green">034</FONT> /**<a name="line.34"></a>
<FONT color="green">035</FONT> * The internal roles collection.<a name="line.35"></a>
<FONT color="green">036</FONT> */<a name="line.36"></a>
<FONT color="green">037</FONT> protected Set&lt;String&gt; roles;<a name="line.37"></a>
<FONT color="green">038</FONT> <a name="line.38"></a>
<FONT color="green">039</FONT> /**<a name="line.39"></a>
<FONT color="green">040</FONT> * Collection of all string-based permissions associated with the account.<a name="line.40"></a>
<FONT color="green">041</FONT> */<a name="line.41"></a>
<FONT color="green">042</FONT> protected Set&lt;String&gt; stringPermissions;<a name="line.42"></a>
<FONT color="green">043</FONT> <a name="line.43"></a>
<FONT color="green">044</FONT> /**<a name="line.44"></a>
<FONT color="green">045</FONT> * Collection of all object-based permissions associaed with the account.<a name="line.45"></a>
<FONT color="green">046</FONT> */<a name="line.46"></a>
<FONT color="green">047</FONT> protected Set&lt;Permission&gt; objectPermissions;<a name="line.47"></a>
<FONT color="green">048</FONT> <a name="line.48"></a>
<FONT color="green">049</FONT> /**<a name="line.49"></a>
<FONT color="green">050</FONT> * Default no-argument constructor.<a name="line.50"></a>
<FONT color="green">051</FONT> */<a name="line.51"></a>
<FONT color="green">052</FONT> public SimpleAuthorizationInfo() {<a name="line.52"></a>
<FONT color="green">053</FONT> }<a name="line.53"></a>
<FONT color="green">054</FONT> <a name="line.54"></a>
<FONT color="green">055</FONT> /**<a name="line.55"></a>
<FONT color="green">056</FONT> * Creates a new instance with the specified roles and no permissions.<a name="line.56"></a>
<FONT color="green">057</FONT> * @param roles the roles assigned to the realm account.<a name="line.57"></a>
<FONT color="green">058</FONT> */<a name="line.58"></a>
<FONT color="green">059</FONT> public SimpleAuthorizationInfo(Set&lt;String&gt; roles) {<a name="line.59"></a>
<FONT color="green">060</FONT> this.roles = roles;<a name="line.60"></a>
<FONT color="green">061</FONT> }<a name="line.61"></a>
<FONT color="green">062</FONT> <a name="line.62"></a>
<FONT color="green">063</FONT> public Set&lt;String&gt; getRoles() {<a name="line.63"></a>
<FONT color="green">064</FONT> return roles;<a name="line.64"></a>
<FONT color="green">065</FONT> }<a name="line.65"></a>
<FONT color="green">066</FONT> <a name="line.66"></a>
<FONT color="green">067</FONT> /**<a name="line.67"></a>
<FONT color="green">068</FONT> * Sets the roles assigned to the account.<a name="line.68"></a>
<FONT color="green">069</FONT> * @param roles the roles assigned to the account.<a name="line.69"></a>
<FONT color="green">070</FONT> */<a name="line.70"></a>
<FONT color="green">071</FONT> public void setRoles(Set&lt;String&gt; roles) {<a name="line.71"></a>
<FONT color="green">072</FONT> this.roles = roles;<a name="line.72"></a>
<FONT color="green">073</FONT> }<a name="line.73"></a>
<FONT color="green">074</FONT> <a name="line.74"></a>
<FONT color="green">075</FONT> /**<a name="line.75"></a>
<FONT color="green">076</FONT> * Adds (assigns) a role to those associated with the account. If the account doesn't yet have any roles, a<a name="line.76"></a>
<FONT color="green">077</FONT> * new roles collection (a Set) will be created automatically.<a name="line.77"></a>
<FONT color="green">078</FONT> * @param role the role to add to those associated with the account.<a name="line.78"></a>
<FONT color="green">079</FONT> */<a name="line.79"></a>
<FONT color="green">080</FONT> public void addRole(String role) {<a name="line.80"></a>
<FONT color="green">081</FONT> if (this.roles == null) {<a name="line.81"></a>
<FONT color="green">082</FONT> this.roles = new HashSet&lt;String&gt;();<a name="line.82"></a>
<FONT color="green">083</FONT> }<a name="line.83"></a>
<FONT color="green">084</FONT> this.roles.add(role);<a name="line.84"></a>
<FONT color="green">085</FONT> }<a name="line.85"></a>
<FONT color="green">086</FONT> <a name="line.86"></a>
<FONT color="green">087</FONT> /**<a name="line.87"></a>
<FONT color="green">088</FONT> * Adds (assigns) multiple roles to those associated with the account. If the account doesn't yet have any roles, a<a name="line.88"></a>
<FONT color="green">089</FONT> * new roles collection (a Set) will be created automatically.<a name="line.89"></a>
<FONT color="green">090</FONT> * @param roles the roles to add to those associated with the account.<a name="line.90"></a>
<FONT color="green">091</FONT> */<a name="line.91"></a>
<FONT color="green">092</FONT> public void addRoles(Collection&lt;String&gt; roles) {<a name="line.92"></a>
<FONT color="green">093</FONT> if (this.roles == null) {<a name="line.93"></a>
<FONT color="green">094</FONT> this.roles = new HashSet&lt;String&gt;();<a name="line.94"></a>
<FONT color="green">095</FONT> }<a name="line.95"></a>
<FONT color="green">096</FONT> this.roles.addAll(roles);<a name="line.96"></a>
<FONT color="green">097</FONT> }<a name="line.97"></a>
<FONT color="green">098</FONT> <a name="line.98"></a>
<FONT color="green">099</FONT> public Set&lt;String&gt; getStringPermissions() {<a name="line.99"></a>
<FONT color="green">100</FONT> return stringPermissions;<a name="line.100"></a>
<FONT color="green">101</FONT> }<a name="line.101"></a>
<FONT color="green">102</FONT> <a name="line.102"></a>
<FONT color="green">103</FONT> /**<a name="line.103"></a>
<FONT color="green">104</FONT> * Sets the string-based permissions assigned directly to the account. The permissions set here, in addition to any<a name="line.104"></a>
<FONT color="green">105</FONT> * {@link #getObjectPermissions() object permissions} constitute the total permissions assigned directly to the<a name="line.105"></a>
<FONT color="green">106</FONT> * account.<a name="line.106"></a>
<FONT color="green">107</FONT> *<a name="line.107"></a>
<FONT color="green">108</FONT> * @param stringPermissions the string-based permissions assigned directly to the account.<a name="line.108"></a>
<FONT color="green">109</FONT> */<a name="line.109"></a>
<FONT color="green">110</FONT> public void setStringPermissions(Set&lt;String&gt; stringPermissions) {<a name="line.110"></a>
<FONT color="green">111</FONT> this.stringPermissions = stringPermissions;<a name="line.111"></a>
<FONT color="green">112</FONT> }<a name="line.112"></a>
<FONT color="green">113</FONT> <a name="line.113"></a>
<FONT color="green">114</FONT> /**<a name="line.114"></a>
<FONT color="green">115</FONT> * Adds (assigns) a permission to those directly associated with the account. If the account doesn't yet have any<a name="line.115"></a>
<FONT color="green">116</FONT> * direct permissions, a new permission collection (a Set&amp;lt;String&amp;gt;) will be created automatically.<a name="line.116"></a>
<FONT color="green">117</FONT> * @param permission the permission to add to those directly assigned to the account.<a name="line.117"></a>
<FONT color="green">118</FONT> */<a name="line.118"></a>
<FONT color="green">119</FONT> public void addStringPermission(String permission) {<a name="line.119"></a>
<FONT color="green">120</FONT> if (this.stringPermissions == null) {<a name="line.120"></a>
<FONT color="green">121</FONT> this.stringPermissions = new HashSet&lt;String&gt;();<a name="line.121"></a>
<FONT color="green">122</FONT> }<a name="line.122"></a>
<FONT color="green">123</FONT> this.stringPermissions.add(permission);<a name="line.123"></a>
<FONT color="green">124</FONT> }<a name="line.124"></a>
<FONT color="green">125</FONT> <a name="line.125"></a>
<FONT color="green">126</FONT> /**<a name="line.126"></a>
<FONT color="green">127</FONT> * Adds (assigns) multiple permissions to those associated directly with the account. If the account doesn't yet<a name="line.127"></a>
<FONT color="green">128</FONT> * have any string-based permissions, a new permissions collection (a Set&amp;lt;String&amp;gt;) will be created automatically.<a name="line.128"></a>
<FONT color="green">129</FONT> * @param permissions the permissions to add to those associated directly with the account.<a name="line.129"></a>
<FONT color="green">130</FONT> */<a name="line.130"></a>
<FONT color="green">131</FONT> public void addStringPermissions(Collection&lt;String&gt; permissions) {<a name="line.131"></a>
<FONT color="green">132</FONT> if (this.stringPermissions == null) {<a name="line.132"></a>
<FONT color="green">133</FONT> this.stringPermissions = new HashSet&lt;String&gt;();<a name="line.133"></a>
<FONT color="green">134</FONT> }<a name="line.134"></a>
<FONT color="green">135</FONT> this.stringPermissions.addAll(permissions);<a name="line.135"></a>
<FONT color="green">136</FONT> }<a name="line.136"></a>
<FONT color="green">137</FONT> <a name="line.137"></a>
<FONT color="green">138</FONT> public Set&lt;Permission&gt; getObjectPermissions() {<a name="line.138"></a>
<FONT color="green">139</FONT> return objectPermissions;<a name="line.139"></a>
<FONT color="green">140</FONT> }<a name="line.140"></a>
<FONT color="green">141</FONT> <a name="line.141"></a>
<FONT color="green">142</FONT> /**<a name="line.142"></a>
<FONT color="green">143</FONT> * Sets the object-based permissions assigned directly to the account. The permissions set here, in addition to any<a name="line.143"></a>
<FONT color="green">144</FONT> * {@link #getStringPermissions() string permissions} constitute the total permissions assigned directly to the<a name="line.144"></a>
<FONT color="green">145</FONT> * account.<a name="line.145"></a>
<FONT color="green">146</FONT> *<a name="line.146"></a>
<FONT color="green">147</FONT> * @param objectPermissions the object-based permissions assigned directly to the account.<a name="line.147"></a>
<FONT color="green">148</FONT> */<a name="line.148"></a>
<FONT color="green">149</FONT> public void setObjectPermissions(Set&lt;Permission&gt; objectPermissions) {<a name="line.149"></a>
<FONT color="green">150</FONT> this.objectPermissions = objectPermissions;<a name="line.150"></a>
<FONT color="green">151</FONT> }<a name="line.151"></a>
<FONT color="green">152</FONT> <a name="line.152"></a>
<FONT color="green">153</FONT> /**<a name="line.153"></a>
<FONT color="green">154</FONT> * Adds (assigns) a permission to those directly associated with the account. If the account doesn't yet have any<a name="line.154"></a>
<FONT color="green">155</FONT> * direct permissions, a new permission collection (a Set&amp;lt;{@link Permission Permission}&amp;gt;) will be created automatically.<a name="line.155"></a>
<FONT color="green">156</FONT> * @param permission the permission to add to those directly assigned to the account.<a name="line.156"></a>
<FONT color="green">157</FONT> */<a name="line.157"></a>
<FONT color="green">158</FONT> public void addObjectPermission(Permission permission) {<a name="line.158"></a>
<FONT color="green">159</FONT> if (this.objectPermissions == null) {<a name="line.159"></a>
<FONT color="green">160</FONT> this.objectPermissions = new HashSet&lt;Permission&gt;();<a name="line.160"></a>
<FONT color="green">161</FONT> }<a name="line.161"></a>
<FONT color="green">162</FONT> this.objectPermissions.add(permission);<a name="line.162"></a>
<FONT color="green">163</FONT> }<a name="line.163"></a>
<FONT color="green">164</FONT> <a name="line.164"></a>
<FONT color="green">165</FONT> /**<a name="line.165"></a>
<FONT color="green">166</FONT> * Adds (assigns) multiple permissions to those associated directly with the account. If the account doesn't yet<a name="line.166"></a>
<FONT color="green">167</FONT> * have any object-based permissions, a new permissions collection (a Set&amp;lt;{@link Permission Permission}&amp;gt;)<a name="line.167"></a>
<FONT color="green">168</FONT> * will be created automatically.<a name="line.168"></a>
<FONT color="green">169</FONT> * @param permissions the permissions to add to those associated directly with the account.<a name="line.169"></a>
<FONT color="green">170</FONT> */<a name="line.170"></a>
<FONT color="green">171</FONT> public void addObjectPermissions(Collection&lt;Permission&gt; permissions) {<a name="line.171"></a>
<FONT color="green">172</FONT> if (this.objectPermissions == null) {<a name="line.172"></a>
<FONT color="green">173</FONT> this.objectPermissions = new HashSet&lt;Permission&gt;();<a name="line.173"></a>
<FONT color="green">174</FONT> }<a name="line.174"></a>
<FONT color="green">175</FONT> this.objectPermissions.addAll(permissions);<a name="line.175"></a>
<FONT color="green">176</FONT> }<a name="line.176"></a>
<FONT color="green">177</FONT> }<a name="line.177"></a>
</PRE>
</BODY>
</HTML>