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