blob: 0294b10fc3ca87978690e557b9d60a0ad4d7bf76 [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.mgt;<a name="line.19"></a>
<FONT color="green">020</FONT> <a name="line.20"></a>
<FONT color="green">021</FONT> import org.apache.shiro.authc.AuthenticationException;<a name="line.21"></a>
<FONT color="green">022</FONT> import org.apache.shiro.authc.AuthenticationInfo;<a name="line.22"></a>
<FONT color="green">023</FONT> import org.apache.shiro.authc.AuthenticationToken;<a name="line.23"></a>
<FONT color="green">024</FONT> import org.apache.shiro.authc.Authenticator;<a name="line.24"></a>
<FONT color="green">025</FONT> import org.apache.shiro.authc.pam.ModularRealmAuthenticator;<a name="line.25"></a>
<FONT color="green">026</FONT> import org.apache.shiro.util.LifecycleUtils;<a name="line.26"></a>
<FONT color="green">027</FONT> <a name="line.27"></a>
<FONT color="green">028</FONT> <a name="line.28"></a>
<FONT color="green">029</FONT> /**<a name="line.29"></a>
<FONT color="green">030</FONT> * Shiro support of a {@link SecurityManager} class hierarchy that delegates all<a name="line.30"></a>
<FONT color="green">031</FONT> * authentication operations to a wrapped {@link Authenticator Authenticator} instance. That is, this class<a name="line.31"></a>
<FONT color="green">032</FONT> * implements all the &lt;tt&gt;Authenticator&lt;/tt&gt; methods in the {@link SecurityManager SecurityManager}<a name="line.32"></a>
<FONT color="green">033</FONT> * interface, but in reality, those methods are merely passthrough calls to the underlying 'real'<a name="line.33"></a>
<FONT color="green">034</FONT> * &lt;tt&gt;Authenticator&lt;/tt&gt; instance.<a name="line.34"></a>
<FONT color="green">035</FONT> *<a name="line.35"></a>
<FONT color="green">036</FONT> * &lt;p&gt;All other &lt;tt&gt;SecurityManager&lt;/tt&gt; (authorization, session, etc) methods are left to be implemented by subclasses.<a name="line.36"></a>
<FONT color="green">037</FONT> *<a name="line.37"></a>
<FONT color="green">038</FONT> * &lt;p&gt;In keeping with the other classes in this hierarchy and Shiro's desire to minimize configuration whenever<a name="line.38"></a>
<FONT color="green">039</FONT> * possible, suitable default instances for all dependencies are created upon instantiation.<a name="line.39"></a>
<FONT color="green">040</FONT> *<a name="line.40"></a>
<FONT color="green">041</FONT> * @since 0.9<a name="line.41"></a>
<FONT color="green">042</FONT> */<a name="line.42"></a>
<FONT color="green">043</FONT> public abstract class AuthenticatingSecurityManager extends RealmSecurityManager {<a name="line.43"></a>
<FONT color="green">044</FONT> <a name="line.44"></a>
<FONT color="green">045</FONT> /**<a name="line.45"></a>
<FONT color="green">046</FONT> * The internal &lt;code&gt;Authenticator&lt;/code&gt; delegate instance that this SecurityManager instance will use<a name="line.46"></a>
<FONT color="green">047</FONT> * to perform all authentication operations.<a name="line.47"></a>
<FONT color="green">048</FONT> */<a name="line.48"></a>
<FONT color="green">049</FONT> private Authenticator authenticator;<a name="line.49"></a>
<FONT color="green">050</FONT> <a name="line.50"></a>
<FONT color="green">051</FONT> /**<a name="line.51"></a>
<FONT color="green">052</FONT> * Default no-arg constructor that initializes its internal<a name="line.52"></a>
<FONT color="green">053</FONT> * &lt;code&gt;authenticator&lt;/code&gt; instance to a<a name="line.53"></a>
<FONT color="green">054</FONT> * {@link org.apache.shiro.authc.pam.ModularRealmAuthenticator ModularRealmAuthenticator}.<a name="line.54"></a>
<FONT color="green">055</FONT> */<a name="line.55"></a>
<FONT color="green">056</FONT> public AuthenticatingSecurityManager() {<a name="line.56"></a>
<FONT color="green">057</FONT> super();<a name="line.57"></a>
<FONT color="green">058</FONT> this.authenticator = new ModularRealmAuthenticator();<a name="line.58"></a>
<FONT color="green">059</FONT> }<a name="line.59"></a>
<FONT color="green">060</FONT> <a name="line.60"></a>
<FONT color="green">061</FONT> /**<a name="line.61"></a>
<FONT color="green">062</FONT> * Returns the delegate &lt;code&gt;Authenticator&lt;/code&gt; instance that this SecurityManager uses to perform all<a name="line.62"></a>
<FONT color="green">063</FONT> * authentication operations. Unless overridden by the<a name="line.63"></a>
<FONT color="green">064</FONT> * {@link #setAuthenticator(org.apache.shiro.authc.Authenticator) setAuthenticator}, the default instance is a<a name="line.64"></a>
<FONT color="green">065</FONT> * {@link org.apache.shiro.authc.pam.ModularRealmAuthenticator ModularRealmAuthenticator}.<a name="line.65"></a>
<FONT color="green">066</FONT> *<a name="line.66"></a>
<FONT color="green">067</FONT> * @return the delegate &lt;code&gt;Authenticator&lt;/code&gt; instance that this SecurityManager uses to perform all<a name="line.67"></a>
<FONT color="green">068</FONT> * authentication operations.<a name="line.68"></a>
<FONT color="green">069</FONT> */<a name="line.69"></a>
<FONT color="green">070</FONT> public Authenticator getAuthenticator() {<a name="line.70"></a>
<FONT color="green">071</FONT> return authenticator;<a name="line.71"></a>
<FONT color="green">072</FONT> }<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> * Sets the delegate &lt;code&gt;Authenticator&lt;/code&gt; instance that this SecurityManager uses to perform all<a name="line.75"></a>
<FONT color="green">076</FONT> * authentication operations. Unless overridden by this method, the default instance is a<a name="line.76"></a>
<FONT color="green">077</FONT> * {@link org.apache.shiro.authc.pam.ModularRealmAuthenticator ModularRealmAuthenticator}.<a name="line.77"></a>
<FONT color="green">078</FONT> *<a name="line.78"></a>
<FONT color="green">079</FONT> * @param authenticator the delegate &lt;code&gt;Authenticator&lt;/code&gt; instance that this SecurityManager will use to<a name="line.79"></a>
<FONT color="green">080</FONT> * perform all authentication operations.<a name="line.80"></a>
<FONT color="green">081</FONT> * @throws IllegalArgumentException if the argument is &lt;code&gt;null&lt;/code&gt;.<a name="line.81"></a>
<FONT color="green">082</FONT> */<a name="line.82"></a>
<FONT color="green">083</FONT> public void setAuthenticator(Authenticator authenticator) throws IllegalArgumentException {<a name="line.83"></a>
<FONT color="green">084</FONT> if (authenticator == null) {<a name="line.84"></a>
<FONT color="green">085</FONT> String msg = "Authenticator argument cannot be null.";<a name="line.85"></a>
<FONT color="green">086</FONT> throw new IllegalArgumentException(msg);<a name="line.86"></a>
<FONT color="green">087</FONT> }<a name="line.87"></a>
<FONT color="green">088</FONT> this.authenticator = authenticator;<a name="line.88"></a>
<FONT color="green">089</FONT> }<a name="line.89"></a>
<FONT color="green">090</FONT> <a name="line.90"></a>
<FONT color="green">091</FONT> /**<a name="line.91"></a>
<FONT color="green">092</FONT> * Passes on the {@link #getRealms() realms} to the internal delegate &lt;code&gt;Authenticator&lt;/code&gt; instance so<a name="line.92"></a>
<FONT color="green">093</FONT> * that it may use them during authentication attempts.<a name="line.93"></a>
<FONT color="green">094</FONT> */<a name="line.94"></a>
<FONT color="green">095</FONT> protected void afterRealmsSet() {<a name="line.95"></a>
<FONT color="green">096</FONT> super.afterRealmsSet();<a name="line.96"></a>
<FONT color="green">097</FONT> if (this.authenticator instanceof ModularRealmAuthenticator) {<a name="line.97"></a>
<FONT color="green">098</FONT> ((ModularRealmAuthenticator) this.authenticator).setRealms(getRealms());<a name="line.98"></a>
<FONT color="green">099</FONT> }<a name="line.99"></a>
<FONT color="green">100</FONT> }<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> * Delegates to the wrapped {@link org.apache.shiro.authc.Authenticator Authenticator} for authentication.<a name="line.103"></a>
<FONT color="green">104</FONT> */<a name="line.104"></a>
<FONT color="green">105</FONT> public AuthenticationInfo authenticate(AuthenticationToken token) throws AuthenticationException {<a name="line.105"></a>
<FONT color="green">106</FONT> return this.authenticator.authenticate(token);<a name="line.106"></a>
<FONT color="green">107</FONT> }<a name="line.107"></a>
<FONT color="green">108</FONT> <a name="line.108"></a>
<FONT color="green">109</FONT> public void destroy() {<a name="line.109"></a>
<FONT color="green">110</FONT> LifecycleUtils.destroy(getAuthenticator());<a name="line.110"></a>
<FONT color="green">111</FONT> this.authenticator = null;<a name="line.111"></a>
<FONT color="green">112</FONT> super.destroy();<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>
</PRE>
</BODY>
</HTML>