| <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.realm.jndi;<a name="line.19"></a> |
| <FONT color="green">020</FONT> <a name="line.20"></a> |
| <FONT color="green">021</FONT> import java.util.ArrayList;<a name="line.21"></a> |
| <FONT color="green">022</FONT> import java.util.Arrays;<a name="line.22"></a> |
| <FONT color="green">023</FONT> import java.util.Collection;<a name="line.23"></a> |
| <FONT color="green">024</FONT> import java.util.List;<a name="line.24"></a> |
| <FONT color="green">025</FONT> <a name="line.25"></a> |
| <FONT color="green">026</FONT> import org.apache.shiro.jndi.JndiLocator;<a name="line.26"></a> |
| <FONT color="green">027</FONT> import org.apache.shiro.realm.Realm;<a name="line.27"></a> |
| <FONT color="green">028</FONT> import org.apache.shiro.realm.RealmFactory;<a name="line.28"></a> |
| <FONT color="green">029</FONT> import org.apache.shiro.util.StringUtils;<a name="line.29"></a> |
| <FONT color="green">030</FONT> <a name="line.30"></a> |
| <FONT color="green">031</FONT> <a name="line.31"></a> |
| <FONT color="green">032</FONT> /**<a name="line.32"></a> |
| <FONT color="green">033</FONT> * Looks up one or more Realm instances from JNDI using specified {@link #setJndiNames jndiNames}.<a name="line.33"></a> |
| <FONT color="green">034</FONT> *<a name="line.34"></a> |
| <FONT color="green">035</FONT> * <p>This is primarily provided to support Realm instances configured in JEE and EJB environments, but will<a name="line.35"></a> |
| <FONT color="green">036</FONT> * work in any environment where {@link Realm Realm} instances are bound in JNDI instead of using<a name="line.36"></a> |
| <FONT color="green">037</FONT> * programmatic or text-based configuration.<a name="line.37"></a> |
| <FONT color="green">038</FONT> *<a name="line.38"></a> |
| <FONT color="green">039</FONT> * @since 0.9<a name="line.39"></a> |
| <FONT color="green">040</FONT> */<a name="line.40"></a> |
| <FONT color="green">041</FONT> public class JndiRealmFactory extends JndiLocator implements RealmFactory {<a name="line.41"></a> |
| <FONT color="green">042</FONT> <a name="line.42"></a> |
| <FONT color="green">043</FONT> Collection<String> jndiNames = null;<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> * Returns the JNDI names that will be used to look up Realm(s) from JNDI.<a name="line.46"></a> |
| <FONT color="green">047</FONT> *<a name="line.47"></a> |
| <FONT color="green">048</FONT> * @return the JNDI names that will be used to look up Realm(s) from JNDI.<a name="line.48"></a> |
| <FONT color="green">049</FONT> * @see #setJndiNames(String)<a name="line.49"></a> |
| <FONT color="green">050</FONT> * @see #setJndiNames(Collection)<a name="line.50"></a> |
| <FONT color="green">051</FONT> */<a name="line.51"></a> |
| <FONT color="green">052</FONT> public Collection<String> getJndiNames() {<a name="line.52"></a> |
| <FONT color="green">053</FONT> return jndiNames;<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> /**<a name="line.56"></a> |
| <FONT color="green">057</FONT> * Sets the JNDI names that will be used to look up Realm(s) from JNDI.<a name="line.57"></a> |
| <FONT color="green">058</FONT> * <p/><a name="line.58"></a> |
| <FONT color="green">059</FONT> * The order of the collection determines the order that the Realms will be returned to the SecurityManager.<a name="line.59"></a> |
| <FONT color="green">060</FONT> * <p/><a name="line.60"></a> |
| <FONT color="green">061</FONT> * If you find it easier to specify these names as a comma-delmited string, you may use the<a name="line.61"></a> |
| <FONT color="green">062</FONT> * {@link #setJndiNames(String)} method instead.<a name="line.62"></a> |
| <FONT color="green">063</FONT> *<a name="line.63"></a> |
| <FONT color="green">064</FONT> * @param jndiNames the JNDI names that will be used to look up Realm(s) from JNDI.<a name="line.64"></a> |
| <FONT color="green">065</FONT> * @see #setJndiNames(String)<a name="line.65"></a> |
| <FONT color="green">066</FONT> */<a name="line.66"></a> |
| <FONT color="green">067</FONT> public void setJndiNames(Collection<String> jndiNames) {<a name="line.67"></a> |
| <FONT color="green">068</FONT> this.jndiNames = jndiNames;<a name="line.68"></a> |
| <FONT color="green">069</FONT> }<a name="line.69"></a> |
| <FONT color="green">070</FONT> <a name="line.70"></a> |
| <FONT color="green">071</FONT> /**<a name="line.71"></a> |
| <FONT color="green">072</FONT> * Specifies a comma-delimited list of JNDI names to lookup, each one corresponding to a jndi-bound<a name="line.72"></a> |
| <FONT color="green">073</FONT> * {@link Realm Realm}. The Realms will be made available to the SecurityManager in the order<a name="line.73"></a> |
| <FONT color="green">074</FONT> * they are defined.<a name="line.74"></a> |
| <FONT color="green">075</FONT> *<a name="line.75"></a> |
| <FONT color="green">076</FONT> * @param commaDelimited a comma-delimited list of JNDI names, each representing the JNDI name used to<a name="line.76"></a> |
| <FONT color="green">077</FONT> * look up a corresponding jndi-bound Realm.<a name="line.77"></a> |
| <FONT color="green">078</FONT> * @throws IllegalStateException if the specified argument is null or the empty string.<a name="line.78"></a> |
| <FONT color="green">079</FONT> */<a name="line.79"></a> |
| <FONT color="green">080</FONT> public void setJndiNames(String commaDelimited) throws IllegalStateException {<a name="line.80"></a> |
| <FONT color="green">081</FONT> String arg = StringUtils.clean(commaDelimited);<a name="line.81"></a> |
| <FONT color="green">082</FONT> if (arg == null) {<a name="line.82"></a> |
| <FONT color="green">083</FONT> String msg = "One or more comma-delimited jndi names must be specified for the " +<a name="line.83"></a> |
| <FONT color="green">084</FONT> getClass().getName() + " to locate Realms.";<a name="line.84"></a> |
| <FONT color="green">085</FONT> throw new IllegalStateException(msg);<a name="line.85"></a> |
| <FONT color="green">086</FONT> }<a name="line.86"></a> |
| <FONT color="green">087</FONT> String[] names = StringUtils.tokenizeToStringArray(arg, ",");<a name="line.87"></a> |
| <FONT color="green">088</FONT> setJndiNames(Arrays.asList(names));<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> * Performs the JNDI lookups for each specified {@link #getJndiNames() JNDI name} and returns all<a name="line.92"></a> |
| <FONT color="green">093</FONT> * discovered Realms in an ordered collection.<a name="line.93"></a> |
| <FONT color="green">094</FONT> *<a name="line.94"></a> |
| <FONT color="green">095</FONT> * <p>The returned Collection is in the same order as the specified<a name="line.95"></a> |
| <FONT color="green">096</FONT> * {@link #setJndiNames(java.util.Collection) jndiNames}<a name="line.96"></a> |
| <FONT color="green">097</FONT> *<a name="line.97"></a> |
| <FONT color="green">098</FONT> * @return an ordered collection of the {@link #setJndiNames(java.util.Collection) specified Realms} found in JNDI.<a name="line.98"></a> |
| <FONT color="green">099</FONT> * @throws IllegalStateException if any of the JNDI names fails to successfully look up a Realm instance.<a name="line.99"></a> |
| <FONT color="green">100</FONT> */<a name="line.100"></a> |
| <FONT color="green">101</FONT> public Collection<Realm> getRealms() throws IllegalStateException {<a name="line.101"></a> |
| <FONT color="green">102</FONT> Collection<String> jndiNames = getJndiNames();<a name="line.102"></a> |
| <FONT color="green">103</FONT> if (jndiNames == null || jndiNames.isEmpty()) {<a name="line.103"></a> |
| <FONT color="green">104</FONT> String msg = "One or more jndi names must be specified for the " +<a name="line.104"></a> |
| <FONT color="green">105</FONT> getClass().getName() + " to locate Realms.";<a name="line.105"></a> |
| <FONT color="green">106</FONT> throw new IllegalStateException(msg);<a name="line.106"></a> |
| <FONT color="green">107</FONT> }<a name="line.107"></a> |
| <FONT color="green">108</FONT> List<Realm> realms = new ArrayList<Realm>(jndiNames.size());<a name="line.108"></a> |
| <FONT color="green">109</FONT> for (String name : jndiNames) {<a name="line.109"></a> |
| <FONT color="green">110</FONT> try {<a name="line.110"></a> |
| <FONT color="green">111</FONT> Realm realm = (Realm) lookup(name, Realm.class);<a name="line.111"></a> |
| <FONT color="green">112</FONT> realms.add(realm);<a name="line.112"></a> |
| <FONT color="green">113</FONT> } catch (Exception e) {<a name="line.113"></a> |
| <FONT color="green">114</FONT> throw new IllegalStateException("Unable to look up realm with jndi name '" + name + "'.", e);<a name="line.114"></a> |
| <FONT color="green">115</FONT> }<a name="line.115"></a> |
| <FONT color="green">116</FONT> }<a name="line.116"></a> |
| <FONT color="green">117</FONT> return realms.isEmpty() ? null : realms;<a name="line.117"></a> |
| <FONT color="green">118</FONT> }<a name="line.118"></a> |
| <FONT color="green">119</FONT> }<a name="line.119"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </PRE> |
| </BODY> |
| </HTML> |
