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