Google Git
Sign in
apache / shiro-site / 01016f43374d9b054f3ea1e568b015d5d69428f9 / . / src / site / assets / static / 1.2.1 / xref / org / apache / shiro / realm / jndi / JndiRealmFactory.html
blob: 29146f6b87a862e59fce4f78fcc9825c3cc688fd [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
<title>JndiRealmFactory xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../apidocs/org/apache/shiro/realm/jndi/JndiRealmFactory.html">View Javadoc</a></div><pre>
<a name="1" href="#1">1</a> <em class="jxr_comment">/*</em>
<a name="2" href="#2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
<a name="3" href="#3">3</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em>
<a name="4" href="#4">4</a> <em class="jxr_comment"> * distributed with this work for additional information</em>
<a name="5" href="#5">5</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em>
<a name="6" href="#6">6</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em>
<a name="7" href="#7">7</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em>
<a name="8" href="#8">8</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em>
<a name="9" href="#9">9</a> <em class="jxr_comment"> *</em>
<a name="10" href="#10">10</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a name="11" href="#11">11</a> <em class="jxr_comment"> *</em>
<a name="12" href="#12">12</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em>
<a name="13" href="#13">13</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em>
<a name="14" href="#14">14</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em>
<a name="15" href="#15">15</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em>
<a name="16" href="#16">16</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em>
<a name="17" href="#17">17</a> <em class="jxr_comment"> * under the License.</em>
<a name="18" href="#18">18</a> <em class="jxr_comment"> */</em>
<a name="19" href="#19">19</a> <strong class="jxr_keyword">package</strong> org.apache.shiro.realm.jndi;
<a name="20" href="#20">20</a>
<a name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> java.util.ArrayList;
<a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> java.util.Arrays;
<a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> java.util.Collection;
<a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> java.util.List;
<a name="25" href="#25">25</a>
<a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.jndi.JndiLocator;
<a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.realm.Realm;
<a name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.realm.RealmFactory;
<a name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.util.StringUtils;
<a name="30" href="#30">30</a>
<a name="31" href="#31">31</a>
<a name="32" href="#32">32</a> <em class="jxr_javadoccomment">/**</em>
<a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * Looks up one or more Realm instances from JNDI using specified {@link #setJndiNames jndiNames}.</em>
<a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> *</em>
<a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * &lt;p&gt;This is primarily provided to support Realm instances configured in JEE and EJB environments, but will</em>
<a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * work in any environment where {@link Realm Realm} instances are bound in JNDI instead of using</em>
<a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * programmatic or text-based configuration.</em>
<a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> *</em>
<a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * @since 0.9</em>
<a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> */</em>
<a name="41" href="#41">41</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/shiro/realm/jndi/JndiRealmFactory.html">JndiRealmFactory</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../org/apache/shiro/jndi/JndiLocator.html">JndiLocator</a> implements <a href="../../../../../org/apache/shiro/realm/RealmFactory.html">RealmFactory</a> {
<a name="42" href="#42">42</a>
<a name="43" href="#43">43</a> Collection&lt;String&gt; jndiNames = <strong class="jxr_keyword">null</strong>;
<a name="44" href="#44">44</a>
<a name="45" href="#45">45</a> <em class="jxr_javadoccomment">/**</em>
<a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * Returns the JNDI names that will be used to look up Realm(s) from JNDI.</em>
<a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> *</em>
<a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * @return the JNDI names that will be used to look up Realm(s) from JNDI.</em>
<a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * @see #setJndiNames(String)</em>
<a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * @see #setJndiNames(Collection)</em>
<a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> */</em>
<a name="52" href="#52">52</a> <strong class="jxr_keyword">public</strong> Collection&lt;String&gt; getJndiNames() {
<a name="53" href="#53">53</a> <strong class="jxr_keyword">return</strong> jndiNames;
<a name="54" href="#54">54</a> }
<a name="55" href="#55">55</a>
<a name="56" href="#56">56</a> <em class="jxr_javadoccomment">/**</em>
<a name="57" href="#57">57</a> <em class="jxr_javadoccomment"> * Sets the JNDI names that will be used to look up Realm(s) from JNDI.</em>
<a name="58" href="#58">58</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a name="59" href="#59">59</a> <em class="jxr_javadoccomment"> * The order of the collection determines the order that the Realms will be returned to the SecurityManager.</em>
<a name="60" href="#60">60</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * If you find it easier to specify these names as a comma-delmited string, you may use the</em>
<a name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * {@link #setJndiNames(String)} method instead.</em>
<a name="63" href="#63">63</a> <em class="jxr_javadoccomment"> *</em>
<a name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * @param jndiNames the JNDI names that will be used to look up Realm(s) from JNDI.</em>
<a name="65" href="#65">65</a> <em class="jxr_javadoccomment"> * @see #setJndiNames(String)</em>
<a name="66" href="#66">66</a> <em class="jxr_javadoccomment"> */</em>
<a name="67" href="#67">67</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setJndiNames(Collection&lt;String&gt; jndiNames) {
<a name="68" href="#68">68</a> <strong class="jxr_keyword">this</strong>.jndiNames = jndiNames;
<a name="69" href="#69">69</a> }
<a name="70" href="#70">70</a>
<a name="71" href="#71">71</a> <em class="jxr_javadoccomment">/**</em>
<a name="72" href="#72">72</a> <em class="jxr_javadoccomment"> * Specifies a comma-delimited list of JNDI names to lookup, each one corresponding to a jndi-bound</em>
<a name="73" href="#73">73</a> <em class="jxr_javadoccomment"> * {@link Realm Realm}. The Realms will be made available to the SecurityManager in the order</em>
<a name="74" href="#74">74</a> <em class="jxr_javadoccomment"> * they are defined.</em>
<a name="75" href="#75">75</a> <em class="jxr_javadoccomment"> *</em>
<a name="76" href="#76">76</a> <em class="jxr_javadoccomment"> * @param commaDelimited a comma-delimited list of JNDI names, each representing the JNDI name used to</em>
<a name="77" href="#77">77</a> <em class="jxr_javadoccomment"> * look up a corresponding jndi-bound Realm.</em>
<a name="78" href="#78">78</a> <em class="jxr_javadoccomment"> * @throws IllegalStateException if the specified argument is null or the empty string.</em>
<a name="79" href="#79">79</a> <em class="jxr_javadoccomment"> */</em>
<a name="80" href="#80">80</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setJndiNames(String commaDelimited) <strong class="jxr_keyword">throws</strong> IllegalStateException {
<a name="81" href="#81">81</a> String arg = StringUtils.clean(commaDelimited);
<a name="82" href="#82">82</a> <strong class="jxr_keyword">if</strong> (arg == <strong class="jxr_keyword">null</strong>) {
<a name="83" href="#83">83</a> String msg = <span class="jxr_string">"One or more comma-delimited jndi names must be specified for the "</span> +
<a name="84" href="#84">84</a> getClass().getName() + <span class="jxr_string">" to locate Realms."</span>;
<a name="85" href="#85">85</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalStateException(msg);
<a name="86" href="#86">86</a> }
<a name="87" href="#87">87</a> String[] names = StringUtils.tokenizeToStringArray(arg, <span class="jxr_string">","</span>);
<a name="88" href="#88">88</a> setJndiNames(Arrays.asList(names));
<a name="89" href="#89">89</a> }
<a name="90" href="#90">90</a>
<a name="91" href="#91">91</a> <em class="jxr_javadoccomment">/**</em>
<a name="92" href="#92">92</a> <em class="jxr_javadoccomment"> * Performs the JNDI lookups for each specified {@link #getJndiNames() JNDI name} and returns all</em>
<a name="93" href="#93">93</a> <em class="jxr_javadoccomment"> * discovered Realms in an ordered collection.</em>
<a name="94" href="#94">94</a> <em class="jxr_javadoccomment"> *</em>
<a name="95" href="#95">95</a> <em class="jxr_javadoccomment"> * &lt;p&gt;The returned Collection is in the same order as the specified</em>
<a name="96" href="#96">96</a> <em class="jxr_javadoccomment"> * {@link #setJndiNames(java.util.Collection) jndiNames}</em>
<a name="97" href="#97">97</a> <em class="jxr_javadoccomment"> *</em>
<a name="98" href="#98">98</a> <em class="jxr_javadoccomment"> * @return an ordered collection of the {@link #setJndiNames(java.util.Collection) specified Realms} found in JNDI.</em>
<a name="99" href="#99">99</a> <em class="jxr_javadoccomment"> * @throws IllegalStateException if any of the JNDI names fails to successfully look up a Realm instance.</em>
<a name="100" href="#100">100</a> <em class="jxr_javadoccomment"> */</em>
<a name="101" href="#101">101</a> <strong class="jxr_keyword">public</strong> Collection&lt;Realm&gt; getRealms() <strong class="jxr_keyword">throws</strong> IllegalStateException {
<a name="102" href="#102">102</a> Collection&lt;String&gt; jndiNames = getJndiNames();
<a name="103" href="#103">103</a> <strong class="jxr_keyword">if</strong> (jndiNames == <strong class="jxr_keyword">null</strong> || jndiNames.isEmpty()) {
<a name="104" href="#104">104</a> String msg = <span class="jxr_string">"One or more jndi names must be specified for the "</span> +
<a name="105" href="#105">105</a> getClass().getName() + <span class="jxr_string">" to locate Realms."</span>;
<a name="106" href="#106">106</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalStateException(msg);
<a name="107" href="#107">107</a> }
<a name="108" href="#108">108</a> List&lt;Realm&gt; realms = <strong class="jxr_keyword">new</strong> ArrayList&lt;Realm&gt;(jndiNames.size());
<a name="109" href="#109">109</a> <strong class="jxr_keyword">for</strong> (String name : jndiNames) {
<a name="110" href="#110">110</a> <strong class="jxr_keyword">try</strong> {
<a name="111" href="#111">111</a> <a href="../../../../../org/apache/shiro/realm/Realm.html">Realm</a> realm = (Realm) lookup(name, Realm.<strong class="jxr_keyword">class</strong>);
<a name="112" href="#112">112</a> realms.add(realm);
<a name="113" href="#113">113</a> } <strong class="jxr_keyword">catch</strong> (Exception e) {
<a name="114" href="#114">114</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalStateException(<span class="jxr_string">"Unable to look up realm with jndi name '"</span> + name + <span class="jxr_string">"'."</span>, e);
<a name="115" href="#115">115</a> }
<a name="116" href="#116">116</a> }
<a name="117" href="#117">117</a> <strong class="jxr_keyword">return</strong> realms.isEmpty() ? <strong class="jxr_keyword">null</strong> : realms;
<a name="118" href="#118">118</a> }
<a name="119" href="#119">119</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>