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