blob: 76c2fa6d76b65c51b198960c2d223894090a2269 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<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.mgt;</a>
<span class="sourceLineNo">020</span><a id="line.20"></a>
<span class="sourceLineNo">021</span><a id="line.21">import org.apache.shiro.authz.AuthorizationException;</a>
<span class="sourceLineNo">022</span><a id="line.22">import org.apache.shiro.authz.Authorizer;</a>
<span class="sourceLineNo">023</span><a id="line.23">import org.apache.shiro.authz.ModularRealmAuthorizer;</a>
<span class="sourceLineNo">024</span><a id="line.24">import org.apache.shiro.authz.Permission;</a>
<span class="sourceLineNo">025</span><a id="line.25">import org.apache.shiro.subject.PrincipalCollection;</a>
<span class="sourceLineNo">026</span><a id="line.26">import org.apache.shiro.util.LifecycleUtils;</a>
<span class="sourceLineNo">027</span><a id="line.27"></a>
<span class="sourceLineNo">028</span><a id="line.28">import java.util.Collection;</a>
<span class="sourceLineNo">029</span><a id="line.29">import java.util.List;</a>
<span class="sourceLineNo">030</span><a id="line.30"></a>
<span class="sourceLineNo">031</span><a id="line.31"></a>
<span class="sourceLineNo">032</span><a id="line.32">/**</a>
<span class="sourceLineNo">033</span><a id="line.33"> * Shiro support of a {@link SecurityManager} class hierarchy that delegates all</a>
<span class="sourceLineNo">034</span><a id="line.34"> * authorization (access control) operations to a wrapped {@link Authorizer Authorizer} instance. That is,</a>
<span class="sourceLineNo">035</span><a id="line.35"> * this class implements all the &lt;tt&gt;Authorizer&lt;/tt&gt; methods in the {@link SecurityManager SecurityManager}</a>
<span class="sourceLineNo">036</span><a id="line.36"> * interface, but in reality, those methods are merely passthrough calls to the underlying 'real'</a>
<span class="sourceLineNo">037</span><a id="line.37"> * &lt;tt&gt;Authorizer&lt;/tt&gt; instance.</a>
<span class="sourceLineNo">038</span><a id="line.38"> *</a>
<span class="sourceLineNo">039</span><a id="line.39"> * &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>
<span class="sourceLineNo">040</span><a id="line.40"> * are left to be implemented by subclasses.</a>
<span class="sourceLineNo">041</span><a id="line.41"> *</a>
<span class="sourceLineNo">042</span><a id="line.42"> * &lt;p&gt;In keeping with the other classes in this hierarchy and Shiro's desire to minimize configuration whenever</a>
<span class="sourceLineNo">043</span><a id="line.43"> * possible, suitable default instances for all dependencies will be created upon instantiation.</a>
<span class="sourceLineNo">044</span><a id="line.44"> *</a>
<span class="sourceLineNo">045</span><a id="line.45"> * @since 0.9</a>
<span class="sourceLineNo">046</span><a id="line.46"> */</a>
<span class="sourceLineNo">047</span><a id="line.47">public abstract class AuthorizingSecurityManager extends AuthenticatingSecurityManager {</a>
<span class="sourceLineNo">048</span><a id="line.48"></a>
<span class="sourceLineNo">049</span><a id="line.49"> /**</a>
<span class="sourceLineNo">050</span><a id="line.50"> * The wrapped instance to which all of this &lt;tt&gt;SecurityManager&lt;/tt&gt; authorization calls are delegated.</a>
<span class="sourceLineNo">051</span><a id="line.51"> */</a>
<span class="sourceLineNo">052</span><a id="line.52"> private Authorizer authorizer;</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"> * Default no-arg constructor that initializes an internal default</a>
<span class="sourceLineNo">056</span><a id="line.56"> * {@link org.apache.shiro.authz.ModularRealmAuthorizer ModularRealmAuthorizer}.</a>
<span class="sourceLineNo">057</span><a id="line.57"> */</a>
<span class="sourceLineNo">058</span><a id="line.58"> public AuthorizingSecurityManager() {</a>
<span class="sourceLineNo">059</span><a id="line.59"> super();</a>
<span class="sourceLineNo">060</span><a id="line.60"> this.authorizer = new ModularRealmAuthorizer();</a>
<span class="sourceLineNo">061</span><a id="line.61"> }</a>
<span class="sourceLineNo">062</span><a id="line.62"></a>
<span class="sourceLineNo">063</span><a id="line.63"> /**</a>
<span class="sourceLineNo">064</span><a id="line.64"> * Returns the underlying wrapped &lt;tt&gt;Authorizer&lt;/tt&gt; instance to which this &lt;tt&gt;SecurityManager&lt;/tt&gt;</a>
<span class="sourceLineNo">065</span><a id="line.65"> * implementation delegates all of its authorization calls.</a>
<span class="sourceLineNo">066</span><a id="line.66"> *</a>
<span class="sourceLineNo">067</span><a id="line.67"> * @return the wrapped &lt;tt&gt;Authorizer&lt;/tt&gt; used by this &lt;tt&gt;SecurityManager&lt;/tt&gt; implementation.</a>
<span class="sourceLineNo">068</span><a id="line.68"> */</a>
<span class="sourceLineNo">069</span><a id="line.69"> public Authorizer getAuthorizer() {</a>
<span class="sourceLineNo">070</span><a id="line.70"> return authorizer;</a>
<span class="sourceLineNo">071</span><a id="line.71"> }</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"> * Sets the underlying &lt;tt&gt;Authorizer&lt;/tt&gt; instance to which this &lt;tt&gt;SecurityManager&lt;/tt&gt; implementation will</a>
<span class="sourceLineNo">075</span><a id="line.75"> * delegate all of its authorization calls.</a>
<span class="sourceLineNo">076</span><a id="line.76"> *</a>
<span class="sourceLineNo">077</span><a id="line.77"> * @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>
<span class="sourceLineNo">078</span><a id="line.78"> * authorization calls to.</a>
<span class="sourceLineNo">079</span><a id="line.79"> */</a>
<span class="sourceLineNo">080</span><a id="line.80"> public void setAuthorizer(Authorizer authorizer) {</a>
<span class="sourceLineNo">081</span><a id="line.81"> if (authorizer == null) {</a>
<span class="sourceLineNo">082</span><a id="line.82"> String msg = "Authorizer argument cannot be null.";</a>
<span class="sourceLineNo">083</span><a id="line.83"> throw new IllegalArgumentException(msg);</a>
<span class="sourceLineNo">084</span><a id="line.84"> }</a>
<span class="sourceLineNo">085</span><a id="line.85"> this.authorizer = authorizer;</a>
<span class="sourceLineNo">086</span><a id="line.86"> }</a>
<span class="sourceLineNo">087</span><a id="line.87"></a>
<span class="sourceLineNo">088</span><a id="line.88"> /**</a>
<span class="sourceLineNo">089</span><a id="line.89"> * 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>
<span class="sourceLineNo">090</span><a id="line.90"> * instance's wrapped {@link Authorizer Authorizer}.</a>
<span class="sourceLineNo">091</span><a id="line.91"> * &lt;p/&gt;</a>
<span class="sourceLineNo">092</span><a id="line.92"> * The setting of realms the Authorizer will only occur if it is an instance of</a>
<span class="sourceLineNo">093</span><a id="line.93"> * {@link org.apache.shiro.authz.ModularRealmAuthorizer ModularRealmAuthorizer}, that is:</a>
<span class="sourceLineNo">094</span><a id="line.94"> * &lt;pre&gt;</a>
<span class="sourceLineNo">095</span><a id="line.95"> * if ( this.authorizer instanceof ModularRealmAuthorizer ) {</a>
<span class="sourceLineNo">096</span><a id="line.96"> * ((ModularRealmAuthorizer)this.authorizer).setRealms(realms);</a>
<span class="sourceLineNo">097</span><a id="line.97"> * }&lt;/pre&gt;</a>
<span class="sourceLineNo">098</span><a id="line.98"> */</a>
<span class="sourceLineNo">099</span><a id="line.99"> protected void afterRealmsSet() {</a>
<span class="sourceLineNo">100</span><a id="line.100"> super.afterRealmsSet();</a>
<span class="sourceLineNo">101</span><a id="line.101"> if (this.authorizer instanceof ModularRealmAuthorizer) {</a>
<span class="sourceLineNo">102</span><a id="line.102"> ((ModularRealmAuthorizer) this.authorizer).setRealms(getRealms());</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"></a>
<span class="sourceLineNo">106</span><a id="line.106"> public void destroy() {</a>
<span class="sourceLineNo">107</span><a id="line.107"> LifecycleUtils.destroy(getAuthorizer());</a>
<span class="sourceLineNo">108</span><a id="line.108"> this.authorizer = null;</a>
<span class="sourceLineNo">109</span><a id="line.109"> super.destroy();</a>
<span class="sourceLineNo">110</span><a id="line.110"> }</a>
<span class="sourceLineNo">111</span><a id="line.111"></a>
<span class="sourceLineNo">112</span><a id="line.112"> public boolean isPermitted(PrincipalCollection principals, String permissionString) {</a>
<span class="sourceLineNo">113</span><a id="line.113"> return this.authorizer.isPermitted(principals, permissionString);</a>
<span class="sourceLineNo">114</span><a id="line.114"> }</a>
<span class="sourceLineNo">115</span><a id="line.115"></a>
<span class="sourceLineNo">116</span><a id="line.116"> public boolean isPermitted(PrincipalCollection principals, Permission permission) {</a>
<span class="sourceLineNo">117</span><a id="line.117"> return this.authorizer.isPermitted(principals, permission);</a>
<span class="sourceLineNo">118</span><a id="line.118"> }</a>
<span class="sourceLineNo">119</span><a id="line.119"></a>
<span class="sourceLineNo">120</span><a id="line.120"> public boolean[] isPermitted(PrincipalCollection principals, String... permissions) {</a>
<span class="sourceLineNo">121</span><a id="line.121"> return this.authorizer.isPermitted(principals, permissions);</a>
<span class="sourceLineNo">122</span><a id="line.122"> }</a>
<span class="sourceLineNo">123</span><a id="line.123"></a>
<span class="sourceLineNo">124</span><a id="line.124"> public boolean[] isPermitted(PrincipalCollection principals, List&lt;Permission&gt; permissions) {</a>
<span class="sourceLineNo">125</span><a id="line.125"> return this.authorizer.isPermitted(principals, permissions);</a>
<span class="sourceLineNo">126</span><a id="line.126"> }</a>
<span class="sourceLineNo">127</span><a id="line.127"></a>
<span class="sourceLineNo">128</span><a id="line.128"> public boolean isPermittedAll(PrincipalCollection principals, String... permissions) {</a>
<span class="sourceLineNo">129</span><a id="line.129"> return this.authorizer.isPermittedAll(principals, permissions);</a>
<span class="sourceLineNo">130</span><a id="line.130"> }</a>
<span class="sourceLineNo">131</span><a id="line.131"></a>
<span class="sourceLineNo">132</span><a id="line.132"> public boolean isPermittedAll(PrincipalCollection principals, Collection&lt;Permission&gt; permissions) {</a>
<span class="sourceLineNo">133</span><a id="line.133"> return this.authorizer.isPermittedAll(principals, permissions);</a>
<span class="sourceLineNo">134</span><a id="line.134"> }</a>
<span class="sourceLineNo">135</span><a id="line.135"></a>
<span class="sourceLineNo">136</span><a id="line.136"> public void checkPermission(PrincipalCollection principals, String permission) throws AuthorizationException {</a>
<span class="sourceLineNo">137</span><a id="line.137"> this.authorizer.checkPermission(principals, permission);</a>
<span class="sourceLineNo">138</span><a id="line.138"> }</a>
<span class="sourceLineNo">139</span><a id="line.139"></a>
<span class="sourceLineNo">140</span><a id="line.140"> public void checkPermission(PrincipalCollection principals, Permission permission) throws AuthorizationException {</a>
<span class="sourceLineNo">141</span><a id="line.141"> this.authorizer.checkPermission(principals, permission);</a>
<span class="sourceLineNo">142</span><a id="line.142"> }</a>
<span class="sourceLineNo">143</span><a id="line.143"></a>
<span class="sourceLineNo">144</span><a id="line.144"> public void checkPermissions(PrincipalCollection principals, String... permissions) throws AuthorizationException {</a>
<span class="sourceLineNo">145</span><a id="line.145"> this.authorizer.checkPermissions(principals, permissions);</a>
<span class="sourceLineNo">146</span><a id="line.146"> }</a>
<span class="sourceLineNo">147</span><a id="line.147"></a>
<span class="sourceLineNo">148</span><a id="line.148"> public void checkPermissions(PrincipalCollection principals, Collection&lt;Permission&gt; permissions) throws AuthorizationException {</a>
<span class="sourceLineNo">149</span><a id="line.149"> this.authorizer.checkPermissions(principals, permissions);</a>
<span class="sourceLineNo">150</span><a id="line.150"> }</a>
<span class="sourceLineNo">151</span><a id="line.151"></a>
<span class="sourceLineNo">152</span><a id="line.152"> public boolean hasRole(PrincipalCollection principals, String roleIdentifier) {</a>
<span class="sourceLineNo">153</span><a id="line.153"> return this.authorizer.hasRole(principals, roleIdentifier);</a>
<span class="sourceLineNo">154</span><a id="line.154"> }</a>
<span class="sourceLineNo">155</span><a id="line.155"></a>
<span class="sourceLineNo">156</span><a id="line.156"> public boolean[] hasRoles(PrincipalCollection principals, List&lt;String&gt; roleIdentifiers) {</a>
<span class="sourceLineNo">157</span><a id="line.157"> return this.authorizer.hasRoles(principals, roleIdentifiers);</a>
<span class="sourceLineNo">158</span><a id="line.158"> }</a>
<span class="sourceLineNo">159</span><a id="line.159"></a>
<span class="sourceLineNo">160</span><a id="line.160"> public boolean hasAllRoles(PrincipalCollection principals, Collection&lt;String&gt; roleIdentifiers) {</a>
<span class="sourceLineNo">161</span><a id="line.161"> return this.authorizer.hasAllRoles(principals, roleIdentifiers);</a>
<span class="sourceLineNo">162</span><a id="line.162"> }</a>
<span class="sourceLineNo">163</span><a id="line.163"></a>
<span class="sourceLineNo">164</span><a id="line.164"> public void checkRole(PrincipalCollection principals, String role) throws AuthorizationException {</a>
<span class="sourceLineNo">165</span><a id="line.165"> this.authorizer.checkRole(principals, role);</a>
<span class="sourceLineNo">166</span><a id="line.166"> }</a>
<span class="sourceLineNo">167</span><a id="line.167"></a>
<span class="sourceLineNo">168</span><a id="line.168"> public void checkRoles(PrincipalCollection principals, Collection&lt;String&gt; roles) throws AuthorizationException {</a>
<span class="sourceLineNo">169</span><a id="line.169"> this.authorizer.checkRoles(principals, roles);</a>
<span class="sourceLineNo">170</span><a id="line.170"> }</a>
<span class="sourceLineNo">171</span><a id="line.171"> </a>
<span class="sourceLineNo">172</span><a id="line.172"> public void checkRoles(PrincipalCollection principals, String... roles) throws AuthorizationException {</a>
<span class="sourceLineNo">173</span><a id="line.173"> this.authorizer.checkRoles(principals, roles);</a>
<span class="sourceLineNo">174</span><a id="line.174"> } </a>
<span class="sourceLineNo">175</span><a id="line.175">}</a>
</pre>
</div>
</main>
</body>
</html>