blob: d51fd791bbcd344784230f1833191c14de285c27 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="fr">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a>
<span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a>
<span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a>
<span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a>
<span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a>
<span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a>
<span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a>
<span class="sourceLineNo">009</span> *<a name="line.9"></a>
<span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<span class="sourceLineNo">011</span> *<a name="line.11"></a>
<span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing,<a name="line.12"></a>
<span class="sourceLineNo">013</span> * software distributed under the License is distributed on an<a name="line.13"></a>
<span class="sourceLineNo">014</span> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.14"></a>
<span class="sourceLineNo">015</span> * KIND, either express or implied. See the License for the<a name="line.15"></a>
<span class="sourceLineNo">016</span> * specific language governing permissions and limitations<a name="line.16"></a>
<span class="sourceLineNo">017</span> * under the License.<a name="line.17"></a>
<span class="sourceLineNo">018</span> */<a name="line.18"></a>
<span class="sourceLineNo">019</span>package org.apache.shiro.mgt;<a name="line.19"></a>
<span class="sourceLineNo">020</span><a name="line.20"></a>
<span class="sourceLineNo">021</span>import org.apache.shiro.authz.AuthorizationException;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import org.apache.shiro.authz.Authorizer;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.apache.shiro.authz.ModularRealmAuthorizer;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.apache.shiro.authz.Permission;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.apache.shiro.subject.PrincipalCollection;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.apache.shiro.util.LifecycleUtils;<a name="line.26"></a>
<span class="sourceLineNo">027</span><a name="line.27"></a>
<span class="sourceLineNo">028</span>import java.util.Collection;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import java.util.List;<a name="line.29"></a>
<span class="sourceLineNo">030</span><a name="line.30"></a>
<span class="sourceLineNo">031</span><a name="line.31"></a>
<span class="sourceLineNo">032</span>/**<a name="line.32"></a>
<span class="sourceLineNo">033</span> * Shiro support of a {@link SecurityManager} class hierarchy that delegates all<a name="line.33"></a>
<span class="sourceLineNo">034</span> * authorization (access control) operations to a wrapped {@link Authorizer Authorizer} instance. That is,<a name="line.34"></a>
<span class="sourceLineNo">035</span> * this class implements all the &lt;tt&gt;Authorizer&lt;/tt&gt; methods in the {@link SecurityManager SecurityManager}<a name="line.35"></a>
<span class="sourceLineNo">036</span> * interface, but in reality, those methods are merely passthrough calls to the underlying 'real'<a name="line.36"></a>
<span class="sourceLineNo">037</span> * &lt;tt&gt;Authorizer&lt;/tt&gt; instance.<a name="line.37"></a>
<span class="sourceLineNo">038</span> *<a name="line.38"></a>
<span class="sourceLineNo">039</span> * &lt;p&gt;All remaining &lt;tt&gt;SecurityManager&lt;/tt&gt; methods not covered by this class or its parents (mostly Session support)<a name="line.39"></a>
<span class="sourceLineNo">040</span> * are left to be implemented by subclasses.<a name="line.40"></a>
<span class="sourceLineNo">041</span> *<a name="line.41"></a>
<span class="sourceLineNo">042</span> * &lt;p&gt;In keeping with the other classes in this hierarchy and Shiro's desire to minimize configuration whenever<a name="line.42"></a>
<span class="sourceLineNo">043</span> * possible, suitable default instances for all dependencies will be created upon instantiation.<a name="line.43"></a>
<span class="sourceLineNo">044</span> *<a name="line.44"></a>
<span class="sourceLineNo">045</span> * @since 0.9<a name="line.45"></a>
<span class="sourceLineNo">046</span> */<a name="line.46"></a>
<span class="sourceLineNo">047</span>public abstract class AuthorizingSecurityManager extends AuthenticatingSecurityManager {<a name="line.47"></a>
<span class="sourceLineNo">048</span><a name="line.48"></a>
<span class="sourceLineNo">049</span> /**<a name="line.49"></a>
<span class="sourceLineNo">050</span> * The wrapped instance to which all of this &lt;tt&gt;SecurityManager&lt;/tt&gt; authorization calls are delegated.<a name="line.50"></a>
<span class="sourceLineNo">051</span> */<a name="line.51"></a>
<span class="sourceLineNo">052</span> private Authorizer authorizer;<a name="line.52"></a>
<span class="sourceLineNo">053</span><a name="line.53"></a>
<span class="sourceLineNo">054</span> /**<a name="line.54"></a>
<span class="sourceLineNo">055</span> * Default no-arg constructor that initializes an internal default<a name="line.55"></a>
<span class="sourceLineNo">056</span> * {@link org.apache.shiro.authz.ModularRealmAuthorizer ModularRealmAuthorizer}.<a name="line.56"></a>
<span class="sourceLineNo">057</span> */<a name="line.57"></a>
<span class="sourceLineNo">058</span> public AuthorizingSecurityManager() {<a name="line.58"></a>
<span class="sourceLineNo">059</span> super();<a name="line.59"></a>
<span class="sourceLineNo">060</span> this.authorizer = new ModularRealmAuthorizer();<a name="line.60"></a>
<span class="sourceLineNo">061</span> }<a name="line.61"></a>
<span class="sourceLineNo">062</span><a name="line.62"></a>
<span class="sourceLineNo">063</span> /**<a name="line.63"></a>
<span class="sourceLineNo">064</span> * Returns the underlying wrapped &lt;tt&gt;Authorizer&lt;/tt&gt; instance to which this &lt;tt&gt;SecurityManager&lt;/tt&gt;<a name="line.64"></a>
<span class="sourceLineNo">065</span> * implementation delegates all of its authorization calls.<a name="line.65"></a>
<span class="sourceLineNo">066</span> *<a name="line.66"></a>
<span class="sourceLineNo">067</span> * @return the wrapped &lt;tt&gt;Authorizer&lt;/tt&gt; used by this &lt;tt&gt;SecurityManager&lt;/tt&gt; implementation.<a name="line.67"></a>
<span class="sourceLineNo">068</span> */<a name="line.68"></a>
<span class="sourceLineNo">069</span> public Authorizer getAuthorizer() {<a name="line.69"></a>
<span class="sourceLineNo">070</span> return authorizer;<a name="line.70"></a>
<span class="sourceLineNo">071</span> }<a name="line.71"></a>
<span class="sourceLineNo">072</span><a name="line.72"></a>
<span class="sourceLineNo">073</span> /**<a name="line.73"></a>
<span class="sourceLineNo">074</span> * Sets the underlying &lt;tt&gt;Authorizer&lt;/tt&gt; instance to which this &lt;tt&gt;SecurityManager&lt;/tt&gt; implementation will<a name="line.74"></a>
<span class="sourceLineNo">075</span> * delegate all of its authorization calls.<a name="line.75"></a>
<span class="sourceLineNo">076</span> *<a name="line.76"></a>
<span class="sourceLineNo">077</span> * @param authorizer the &lt;tt&gt;Authorizer&lt;/tt&gt; this &lt;tt&gt;SecurityManager&lt;/tt&gt; should wrap and delegate all of its<a name="line.77"></a>
<span class="sourceLineNo">078</span> * authorization calls to.<a name="line.78"></a>
<span class="sourceLineNo">079</span> */<a name="line.79"></a>
<span class="sourceLineNo">080</span> public void setAuthorizer(Authorizer authorizer) {<a name="line.80"></a>
<span class="sourceLineNo">081</span> if (authorizer == null) {<a name="line.81"></a>
<span class="sourceLineNo">082</span> String msg = "Authorizer argument cannot be null.";<a name="line.82"></a>
<span class="sourceLineNo">083</span> throw new IllegalArgumentException(msg);<a name="line.83"></a>
<span class="sourceLineNo">084</span> }<a name="line.84"></a>
<span class="sourceLineNo">085</span> this.authorizer = authorizer;<a name="line.85"></a>
<span class="sourceLineNo">086</span> }<a name="line.86"></a>
<span class="sourceLineNo">087</span><a name="line.87"></a>
<span class="sourceLineNo">088</span> /**<a name="line.88"></a>
<span class="sourceLineNo">089</span> * First calls &lt;code&gt;super.afterRealmsSet()&lt;/code&gt; and then sets these same &lt;code&gt;Realm&lt;/code&gt; objects on this<a name="line.89"></a>
<span class="sourceLineNo">090</span> * instance's wrapped {@link Authorizer Authorizer}.<a name="line.90"></a>
<span class="sourceLineNo">091</span> * &lt;p/&gt;<a name="line.91"></a>
<span class="sourceLineNo">092</span> * The setting of realms the Authorizer will only occur if it is an instance of<a name="line.92"></a>
<span class="sourceLineNo">093</span> * {@link org.apache.shiro.authz.ModularRealmAuthorizer ModularRealmAuthorizer}, that is:<a name="line.93"></a>
<span class="sourceLineNo">094</span> * &lt;pre&gt;<a name="line.94"></a>
<span class="sourceLineNo">095</span> * if ( this.authorizer instanceof ModularRealmAuthorizer ) {<a name="line.95"></a>
<span class="sourceLineNo">096</span> * ((ModularRealmAuthorizer)this.authorizer).setRealms(realms);<a name="line.96"></a>
<span class="sourceLineNo">097</span> * }&lt;/pre&gt;<a name="line.97"></a>
<span class="sourceLineNo">098</span> */<a name="line.98"></a>
<span class="sourceLineNo">099</span> protected void afterRealmsSet() {<a name="line.99"></a>
<span class="sourceLineNo">100</span> super.afterRealmsSet();<a name="line.100"></a>
<span class="sourceLineNo">101</span> if (this.authorizer instanceof ModularRealmAuthorizer) {<a name="line.101"></a>
<span class="sourceLineNo">102</span> ((ModularRealmAuthorizer) this.authorizer).setRealms(getRealms());<a name="line.102"></a>
<span class="sourceLineNo">103</span> }<a name="line.103"></a>
<span class="sourceLineNo">104</span> }<a name="line.104"></a>
<span class="sourceLineNo">105</span><a name="line.105"></a>
<span class="sourceLineNo">106</span> public void destroy() {<a name="line.106"></a>
<span class="sourceLineNo">107</span> LifecycleUtils.destroy(getAuthorizer());<a name="line.107"></a>
<span class="sourceLineNo">108</span> this.authorizer = null;<a name="line.108"></a>
<span class="sourceLineNo">109</span> super.destroy();<a name="line.109"></a>
<span class="sourceLineNo">110</span> }<a name="line.110"></a>
<span class="sourceLineNo">111</span><a name="line.111"></a>
<span class="sourceLineNo">112</span> public boolean isPermitted(PrincipalCollection principals, String permissionString) {<a name="line.112"></a>
<span class="sourceLineNo">113</span> return this.authorizer.isPermitted(principals, permissionString);<a name="line.113"></a>
<span class="sourceLineNo">114</span> }<a name="line.114"></a>
<span class="sourceLineNo">115</span><a name="line.115"></a>
<span class="sourceLineNo">116</span> public boolean isPermitted(PrincipalCollection principals, Permission permission) {<a name="line.116"></a>
<span class="sourceLineNo">117</span> return this.authorizer.isPermitted(principals, permission);<a name="line.117"></a>
<span class="sourceLineNo">118</span> }<a name="line.118"></a>
<span class="sourceLineNo">119</span><a name="line.119"></a>
<span class="sourceLineNo">120</span> public boolean[] isPermitted(PrincipalCollection principals, String... permissions) {<a name="line.120"></a>
<span class="sourceLineNo">121</span> return this.authorizer.isPermitted(principals, permissions);<a name="line.121"></a>
<span class="sourceLineNo">122</span> }<a name="line.122"></a>
<span class="sourceLineNo">123</span><a name="line.123"></a>
<span class="sourceLineNo">124</span> public boolean[] isPermitted(PrincipalCollection principals, List&lt;Permission&gt; permissions) {<a name="line.124"></a>
<span class="sourceLineNo">125</span> return this.authorizer.isPermitted(principals, permissions);<a name="line.125"></a>
<span class="sourceLineNo">126</span> }<a name="line.126"></a>
<span class="sourceLineNo">127</span><a name="line.127"></a>
<span class="sourceLineNo">128</span> public boolean isPermittedAll(PrincipalCollection principals, String... permissions) {<a name="line.128"></a>
<span class="sourceLineNo">129</span> return this.authorizer.isPermittedAll(principals, permissions);<a name="line.129"></a>
<span class="sourceLineNo">130</span> }<a name="line.130"></a>
<span class="sourceLineNo">131</span><a name="line.131"></a>
<span class="sourceLineNo">132</span> public boolean isPermittedAll(PrincipalCollection principals, Collection&lt;Permission&gt; permissions) {<a name="line.132"></a>
<span class="sourceLineNo">133</span> return this.authorizer.isPermittedAll(principals, permissions);<a name="line.133"></a>
<span class="sourceLineNo">134</span> }<a name="line.134"></a>
<span class="sourceLineNo">135</span><a name="line.135"></a>
<span class="sourceLineNo">136</span> public void checkPermission(PrincipalCollection principals, String permission) throws AuthorizationException {<a name="line.136"></a>
<span class="sourceLineNo">137</span> this.authorizer.checkPermission(principals, permission);<a name="line.137"></a>
<span class="sourceLineNo">138</span> }<a name="line.138"></a>
<span class="sourceLineNo">139</span><a name="line.139"></a>
<span class="sourceLineNo">140</span> public void checkPermission(PrincipalCollection principals, Permission permission) throws AuthorizationException {<a name="line.140"></a>
<span class="sourceLineNo">141</span> this.authorizer.checkPermission(principals, permission);<a name="line.141"></a>
<span class="sourceLineNo">142</span> }<a name="line.142"></a>
<span class="sourceLineNo">143</span><a name="line.143"></a>
<span class="sourceLineNo">144</span> public void checkPermissions(PrincipalCollection principals, String... permissions) throws AuthorizationException {<a name="line.144"></a>
<span class="sourceLineNo">145</span> this.authorizer.checkPermissions(principals, permissions);<a name="line.145"></a>
<span class="sourceLineNo">146</span> }<a name="line.146"></a>
<span class="sourceLineNo">147</span><a name="line.147"></a>
<span class="sourceLineNo">148</span> public void checkPermissions(PrincipalCollection principals, Collection&lt;Permission&gt; permissions) throws AuthorizationException {<a name="line.148"></a>
<span class="sourceLineNo">149</span> this.authorizer.checkPermissions(principals, permissions);<a name="line.149"></a>
<span class="sourceLineNo">150</span> }<a name="line.150"></a>
<span class="sourceLineNo">151</span><a name="line.151"></a>
<span class="sourceLineNo">152</span> public boolean hasRole(PrincipalCollection principals, String roleIdentifier) {<a name="line.152"></a>
<span class="sourceLineNo">153</span> return this.authorizer.hasRole(principals, roleIdentifier);<a name="line.153"></a>
<span class="sourceLineNo">154</span> }<a name="line.154"></a>
<span class="sourceLineNo">155</span><a name="line.155"></a>
<span class="sourceLineNo">156</span> public boolean[] hasRoles(PrincipalCollection principals, List&lt;String&gt; roleIdentifiers) {<a name="line.156"></a>
<span class="sourceLineNo">157</span> return this.authorizer.hasRoles(principals, roleIdentifiers);<a name="line.157"></a>
<span class="sourceLineNo">158</span> }<a name="line.158"></a>
<span class="sourceLineNo">159</span><a name="line.159"></a>
<span class="sourceLineNo">160</span> public boolean hasAllRoles(PrincipalCollection principals, Collection&lt;String&gt; roleIdentifiers) {<a name="line.160"></a>
<span class="sourceLineNo">161</span> return this.authorizer.hasAllRoles(principals, roleIdentifiers);<a name="line.161"></a>
<span class="sourceLineNo">162</span> }<a name="line.162"></a>
<span class="sourceLineNo">163</span><a name="line.163"></a>
<span class="sourceLineNo">164</span> public void checkRole(PrincipalCollection principals, String role) throws AuthorizationException {<a name="line.164"></a>
<span class="sourceLineNo">165</span> this.authorizer.checkRole(principals, role);<a name="line.165"></a>
<span class="sourceLineNo">166</span> }<a name="line.166"></a>
<span class="sourceLineNo">167</span><a name="line.167"></a>
<span class="sourceLineNo">168</span> public void checkRoles(PrincipalCollection principals, Collection&lt;String&gt; roles) throws AuthorizationException {<a name="line.168"></a>
<span class="sourceLineNo">169</span> this.authorizer.checkRoles(principals, roles);<a name="line.169"></a>
<span class="sourceLineNo">170</span> }<a name="line.170"></a>
<span class="sourceLineNo">171</span> <a name="line.171"></a>
<span class="sourceLineNo">172</span> public void checkRoles(PrincipalCollection principals, String... roles) throws AuthorizationException {<a name="line.172"></a>
<span class="sourceLineNo">173</span> this.authorizer.checkRoles(principals, roles);<a name="line.173"></a>
<span class="sourceLineNo">174</span> } <a name="line.174"></a>
<span class="sourceLineNo">175</span>}<a name="line.175"></a>
</pre>
</div>
</body>
</html>