| <!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.jndi;</a> |
| <span class="sourceLineNo">020</span><a id="line.20"></a> |
| <span class="sourceLineNo">021</span><a id="line.21">import java.util.Properties;</a> |
| <span class="sourceLineNo">022</span><a id="line.22">import javax.naming.NamingException;</a> |
| <span class="sourceLineNo">023</span><a id="line.23"></a> |
| <span class="sourceLineNo">024</span><a id="line.24">import org.slf4j.Logger;</a> |
| <span class="sourceLineNo">025</span><a id="line.25">import org.slf4j.LoggerFactory;</a> |
| <span class="sourceLineNo">026</span><a id="line.26"></a> |
| <span class="sourceLineNo">027</span><a id="line.27">/**</a> |
| <span class="sourceLineNo">028</span><a id="line.28"> * Convenient superclass for JNDI accessors, providing "jndiTemplate"</a> |
| <span class="sourceLineNo">029</span><a id="line.29"> * and "jndiEnvironment" bean properties.</a> |
| <span class="sourceLineNo">030</span><a id="line.30"> *</a> |
| <span class="sourceLineNo">031</span><a id="line.31"> * <p>Note that this implementation is an almost exact combined copy of the Spring Framework's 'JndiAccessor' and</a> |
| <span class="sourceLineNo">032</span><a id="line.32"> * 'JndiLocatorSupport' classes from their 2.5.4 distribution - we didn't want to re-invent the wheel, but not require</a> |
| <span class="sourceLineNo">033</span><a id="line.33"> * a full dependency on the Spring framework, nor does Spring make available only its JNDI classes in a small jar, or</a> |
| <span class="sourceLineNo">034</span><a id="line.34"> * we would have used that. Since Shiro is also Apache 2.0 licensed, all regular licenses and conditions and</a> |
| <span class="sourceLineNo">035</span><a id="line.35"> * authors have remained in tact.</a> |
| <span class="sourceLineNo">036</span><a id="line.36"> *</a> |
| <span class="sourceLineNo">037</span><a id="line.37"> * @see #setJndiTemplate</a> |
| <span class="sourceLineNo">038</span><a id="line.38"> * @see #setJndiEnvironment</a> |
| <span class="sourceLineNo">039</span><a id="line.39"> * @see #setResourceRef</a> |
| <span class="sourceLineNo">040</span><a id="line.40"> * @since 1.1</a> |
| <span class="sourceLineNo">041</span><a id="line.41"> */</a> |
| <span class="sourceLineNo">042</span><a id="line.42">public class JndiLocator {</a> |
| <span class="sourceLineNo">043</span><a id="line.43"></a> |
| <span class="sourceLineNo">044</span><a id="line.44"> /**</a> |
| <span class="sourceLineNo">045</span><a id="line.45"> * Private class log.</a> |
| <span class="sourceLineNo">046</span><a id="line.46"> */</a> |
| <span class="sourceLineNo">047</span><a id="line.47"> private static final Logger log = LoggerFactory.getLogger(JndiLocator.class);</a> |
| <span class="sourceLineNo">048</span><a id="line.48"></a> |
| <span class="sourceLineNo">049</span><a id="line.49"> /**</a> |
| <span class="sourceLineNo">050</span><a id="line.50"> * JNDI prefix used in a J2EE container</a> |
| <span class="sourceLineNo">051</span><a id="line.51"> */</a> |
| <span class="sourceLineNo">052</span><a id="line.52"> public static final String CONTAINER_PREFIX = "java:comp/env/";</a> |
| <span class="sourceLineNo">053</span><a id="line.53"></a> |
| <span class="sourceLineNo">054</span><a id="line.54"> private boolean resourceRef = false;</a> |
| <span class="sourceLineNo">055</span><a id="line.55"></a> |
| <span class="sourceLineNo">056</span><a id="line.56"> private JndiTemplate jndiTemplate = new JndiTemplate();</a> |
| <span class="sourceLineNo">057</span><a id="line.57"></a> |
| <span class="sourceLineNo">058</span><a id="line.58"></a> |
| <span class="sourceLineNo">059</span><a id="line.59"> /**</a> |
| <span class="sourceLineNo">060</span><a id="line.60"> * Set the JNDI template to use for JNDI lookups.</a> |
| <span class="sourceLineNo">061</span><a id="line.61"> * <p>You can also specify JNDI environment settings via "jndiEnvironment".</a> |
| <span class="sourceLineNo">062</span><a id="line.62"> *</a> |
| <span class="sourceLineNo">063</span><a id="line.63"> * @see #setJndiEnvironment</a> |
| <span class="sourceLineNo">064</span><a id="line.64"> */</a> |
| <span class="sourceLineNo">065</span><a id="line.65"> public void setJndiTemplate(JndiTemplate jndiTemplate) {</a> |
| <span class="sourceLineNo">066</span><a id="line.66"> this.jndiTemplate = (jndiTemplate != null ? jndiTemplate : new JndiTemplate());</a> |
| <span class="sourceLineNo">067</span><a id="line.67"> }</a> |
| <span class="sourceLineNo">068</span><a id="line.68"></a> |
| <span class="sourceLineNo">069</span><a id="line.69"> /**</a> |
| <span class="sourceLineNo">070</span><a id="line.70"> * Return the JNDI template to use for JNDI lookups.</a> |
| <span class="sourceLineNo">071</span><a id="line.71"> */</a> |
| <span class="sourceLineNo">072</span><a id="line.72"> public JndiTemplate getJndiTemplate() {</a> |
| <span class="sourceLineNo">073</span><a id="line.73"> return this.jndiTemplate;</a> |
| <span class="sourceLineNo">074</span><a id="line.74"> }</a> |
| <span class="sourceLineNo">075</span><a id="line.75"></a> |
| <span class="sourceLineNo">076</span><a id="line.76"> /**</a> |
| <span class="sourceLineNo">077</span><a id="line.77"> * Set the JNDI environment to use for JNDI lookups.</a> |
| <span class="sourceLineNo">078</span><a id="line.78"> * <p>Creates a JndiTemplate with the given environment settings.</a> |
| <span class="sourceLineNo">079</span><a id="line.79"> *</a> |
| <span class="sourceLineNo">080</span><a id="line.80"> * @see #setJndiTemplate</a> |
| <span class="sourceLineNo">081</span><a id="line.81"> */</a> |
| <span class="sourceLineNo">082</span><a id="line.82"> public void setJndiEnvironment(Properties jndiEnvironment) {</a> |
| <span class="sourceLineNo">083</span><a id="line.83"> this.jndiTemplate = new JndiTemplate(jndiEnvironment);</a> |
| <span class="sourceLineNo">084</span><a id="line.84"> }</a> |
| <span class="sourceLineNo">085</span><a id="line.85"></a> |
| <span class="sourceLineNo">086</span><a id="line.86"> /**</a> |
| <span class="sourceLineNo">087</span><a id="line.87"> * Return the JNDI environment to use for JNDI lookups.</a> |
| <span class="sourceLineNo">088</span><a id="line.88"> */</a> |
| <span class="sourceLineNo">089</span><a id="line.89"> public Properties getJndiEnvironment() {</a> |
| <span class="sourceLineNo">090</span><a id="line.90"> return this.jndiTemplate.getEnvironment();</a> |
| <span class="sourceLineNo">091</span><a id="line.91"> }</a> |
| <span class="sourceLineNo">092</span><a id="line.92"></a> |
| <span class="sourceLineNo">093</span><a id="line.93"> /**</a> |
| <span class="sourceLineNo">094</span><a id="line.94"> * Set whether the lookup occurs in a J2EE container, i.e. if the prefix</a> |
| <span class="sourceLineNo">095</span><a id="line.95"> * "java:comp/env/" needs to be added if the JNDI name doesn't already</a> |
| <span class="sourceLineNo">096</span><a id="line.96"> * contain it. Default is "false".</a> |
| <span class="sourceLineNo">097</span><a id="line.97"> * <p>Note: Will only get applied if no other scheme (e.g. "java:") is given.</a> |
| <span class="sourceLineNo">098</span><a id="line.98"> */</a> |
| <span class="sourceLineNo">099</span><a id="line.99"> public void setResourceRef(boolean resourceRef) {</a> |
| <span class="sourceLineNo">100</span><a id="line.100"> this.resourceRef = resourceRef;</a> |
| <span class="sourceLineNo">101</span><a id="line.101"> }</a> |
| <span class="sourceLineNo">102</span><a id="line.102"></a> |
| <span class="sourceLineNo">103</span><a id="line.103"> /**</a> |
| <span class="sourceLineNo">104</span><a id="line.104"> * Return whether the lookup occurs in a J2EE container.</a> |
| <span class="sourceLineNo">105</span><a id="line.105"> */</a> |
| <span class="sourceLineNo">106</span><a id="line.106"> public boolean isResourceRef() {</a> |
| <span class="sourceLineNo">107</span><a id="line.107"> return this.resourceRef;</a> |
| <span class="sourceLineNo">108</span><a id="line.108"> }</a> |
| <span class="sourceLineNo">109</span><a id="line.109"></a> |
| <span class="sourceLineNo">110</span><a id="line.110"></a> |
| <span class="sourceLineNo">111</span><a id="line.111"> /**</a> |
| <span class="sourceLineNo">112</span><a id="line.112"> * Perform an actual JNDI lookup for the given name via the JndiTemplate.</a> |
| <span class="sourceLineNo">113</span><a id="line.113"> * <p>If the name doesn't begin with "java:comp/env/", this prefix is added</a> |
| <span class="sourceLineNo">114</span><a id="line.114"> * if "resourceRef" is set to "true".</a> |
| <span class="sourceLineNo">115</span><a id="line.115"> *</a> |
| <span class="sourceLineNo">116</span><a id="line.116"> * @param jndiName the JNDI name to look up</a> |
| <span class="sourceLineNo">117</span><a id="line.117"> * @return the obtained object</a> |
| <span class="sourceLineNo">118</span><a id="line.118"> * @throws javax.naming.NamingException if the JNDI lookup failed</a> |
| <span class="sourceLineNo">119</span><a id="line.119"> * @see #setResourceRef</a> |
| <span class="sourceLineNo">120</span><a id="line.120"> */</a> |
| <span class="sourceLineNo">121</span><a id="line.121"> protected Object lookup(String jndiName) throws NamingException {</a> |
| <span class="sourceLineNo">122</span><a id="line.122"> return lookup(jndiName, null);</a> |
| <span class="sourceLineNo">123</span><a id="line.123"> }</a> |
| <span class="sourceLineNo">124</span><a id="line.124"></a> |
| <span class="sourceLineNo">125</span><a id="line.125"> /**</a> |
| <span class="sourceLineNo">126</span><a id="line.126"> * Perform an actual JNDI lookup for the given name via the JndiTemplate.</a> |
| <span class="sourceLineNo">127</span><a id="line.127"> * <p>If the name doesn't begin with "java:comp/env/", this prefix is added</a> |
| <span class="sourceLineNo">128</span><a id="line.128"> * if "resourceRef" is set to "true".</a> |
| <span class="sourceLineNo">129</span><a id="line.129"> *</a> |
| <span class="sourceLineNo">130</span><a id="line.130"> * @param jndiName the JNDI name to look up</a> |
| <span class="sourceLineNo">131</span><a id="line.131"> * @param requiredType the required type of the object</a> |
| <span class="sourceLineNo">132</span><a id="line.132"> * @return the obtained object</a> |
| <span class="sourceLineNo">133</span><a id="line.133"> * @throws NamingException if the JNDI lookup failed</a> |
| <span class="sourceLineNo">134</span><a id="line.134"> * @see #setResourceRef</a> |
| <span class="sourceLineNo">135</span><a id="line.135"> */</a> |
| <span class="sourceLineNo">136</span><a id="line.136"> protected Object lookup(String jndiName, Class requiredType) throws NamingException {</a> |
| <span class="sourceLineNo">137</span><a id="line.137"> if (jndiName == null) {</a> |
| <span class="sourceLineNo">138</span><a id="line.138"> throw new IllegalArgumentException("jndiName argument must not be null");</a> |
| <span class="sourceLineNo">139</span><a id="line.139"> }</a> |
| <span class="sourceLineNo">140</span><a id="line.140"> String convertedName = convertJndiName(jndiName);</a> |
| <span class="sourceLineNo">141</span><a id="line.141"> Object jndiObject;</a> |
| <span class="sourceLineNo">142</span><a id="line.142"> try {</a> |
| <span class="sourceLineNo">143</span><a id="line.143"> jndiObject = getJndiTemplate().lookup(convertedName, requiredType);</a> |
| <span class="sourceLineNo">144</span><a id="line.144"> }</a> |
| <span class="sourceLineNo">145</span><a id="line.145"> catch (NamingException ex) {</a> |
| <span class="sourceLineNo">146</span><a id="line.146"> if (!convertedName.equals(jndiName)) {</a> |
| <span class="sourceLineNo">147</span><a id="line.147"> // Try fallback to originally specified name...</a> |
| <span class="sourceLineNo">148</span><a id="line.148"> if (log.isDebugEnabled()) {</a> |
| <span class="sourceLineNo">149</span><a id="line.149"> log.debug("Converted JNDI name [" + convertedName +</a> |
| <span class="sourceLineNo">150</span><a id="line.150"> "] not found - trying original name [" + jndiName + "]. " + ex);</a> |
| <span class="sourceLineNo">151</span><a id="line.151"> }</a> |
| <span class="sourceLineNo">152</span><a id="line.152"> jndiObject = getJndiTemplate().lookup(jndiName, requiredType);</a> |
| <span class="sourceLineNo">153</span><a id="line.153"> } else {</a> |
| <span class="sourceLineNo">154</span><a id="line.154"> throw ex;</a> |
| <span class="sourceLineNo">155</span><a id="line.155"> }</a> |
| <span class="sourceLineNo">156</span><a id="line.156"> }</a> |
| <span class="sourceLineNo">157</span><a id="line.157"> log.debug("Located object with JNDI name '{}'", convertedName);</a> |
| <span class="sourceLineNo">158</span><a id="line.158"> return jndiObject;</a> |
| <span class="sourceLineNo">159</span><a id="line.159"> }</a> |
| <span class="sourceLineNo">160</span><a id="line.160"></a> |
| <span class="sourceLineNo">161</span><a id="line.161"> /**</a> |
| <span class="sourceLineNo">162</span><a id="line.162"> * Convert the given JNDI name into the actual JNDI name to use.</a> |
| <span class="sourceLineNo">163</span><a id="line.163"> * <p>The default implementation applies the "java:comp/env/" prefix if</a> |
| <span class="sourceLineNo">164</span><a id="line.164"> * "resourceRef" is "true" and no other scheme (e.g. "java:") is given.</a> |
| <span class="sourceLineNo">165</span><a id="line.165"> *</a> |
| <span class="sourceLineNo">166</span><a id="line.166"> * @param jndiName the original JNDI name</a> |
| <span class="sourceLineNo">167</span><a id="line.167"> * @return the JNDI name to use</a> |
| <span class="sourceLineNo">168</span><a id="line.168"> * @see #CONTAINER_PREFIX</a> |
| <span class="sourceLineNo">169</span><a id="line.169"> * @see #setResourceRef</a> |
| <span class="sourceLineNo">170</span><a id="line.170"> */</a> |
| <span class="sourceLineNo">171</span><a id="line.171"> protected String convertJndiName(String jndiName) {</a> |
| <span class="sourceLineNo">172</span><a id="line.172"> // Prepend container prefix if not already specified and no other scheme given.</a> |
| <span class="sourceLineNo">173</span><a id="line.173"> if (isResourceRef() && !jndiName.startsWith(CONTAINER_PREFIX) && jndiName.indexOf(':') == -1) {</a> |
| <span class="sourceLineNo">174</span><a id="line.174"> jndiName = CONTAINER_PREFIX + jndiName;</a> |
| <span class="sourceLineNo">175</span><a id="line.175"> }</a> |
| <span class="sourceLineNo">176</span><a id="line.176"> return jndiName;</a> |
| <span class="sourceLineNo">177</span><a id="line.177"> }</a> |
| <span class="sourceLineNo">178</span><a id="line.178"></a> |
| <span class="sourceLineNo">179</span><a id="line.179">}</a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
