| <HTML> |
| <BODY BGCOLOR="white"> |
| <PRE> |
| <FONT color="green">001</FONT> /*<a name="line.1"></a> |
| <FONT color="green">002</FONT> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a> |
| <FONT color="green">003</FONT> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a> |
| <FONT color="green">004</FONT> * distributed with this work for additional information<a name="line.4"></a> |
| <FONT color="green">005</FONT> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a> |
| <FONT color="green">006</FONT> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a> |
| <FONT color="green">007</FONT> * "License"); you may not use this file except in compliance<a name="line.7"></a> |
| <FONT color="green">008</FONT> * with the License. You may obtain a copy of the License at<a name="line.8"></a> |
| <FONT color="green">009</FONT> *<a name="line.9"></a> |
| <FONT color="green">010</FONT> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a> |
| <FONT color="green">011</FONT> *<a name="line.11"></a> |
| <FONT color="green">012</FONT> * Unless required by applicable law or agreed to in writing,<a name="line.12"></a> |
| <FONT color="green">013</FONT> * software distributed under the License is distributed on an<a name="line.13"></a> |
| <FONT color="green">014</FONT> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.14"></a> |
| <FONT color="green">015</FONT> * KIND, either express or implied. See the License for the<a name="line.15"></a> |
| <FONT color="green">016</FONT> * specific language governing permissions and limitations<a name="line.16"></a> |
| <FONT color="green">017</FONT> * under the License.<a name="line.17"></a> |
| <FONT color="green">018</FONT> */<a name="line.18"></a> |
| <FONT color="green">019</FONT> package org.apache.shiro.jndi;<a name="line.19"></a> |
| <FONT color="green">020</FONT> <a name="line.20"></a> |
| <FONT color="green">021</FONT> import java.util.Properties;<a name="line.21"></a> |
| <FONT color="green">022</FONT> import javax.naming.NamingException;<a name="line.22"></a> |
| <FONT color="green">023</FONT> <a name="line.23"></a> |
| <FONT color="green">024</FONT> import org.slf4j.Logger;<a name="line.24"></a> |
| <FONT color="green">025</FONT> import org.slf4j.LoggerFactory;<a name="line.25"></a> |
| <FONT color="green">026</FONT> <a name="line.26"></a> |
| <FONT color="green">027</FONT> /**<a name="line.27"></a> |
| <FONT color="green">028</FONT> * Convenient superclass for JNDI accessors, providing "jndiTemplate"<a name="line.28"></a> |
| <FONT color="green">029</FONT> * and "jndiEnvironment" bean properties.<a name="line.29"></a> |
| <FONT color="green">030</FONT> *<a name="line.30"></a> |
| <FONT color="green">031</FONT> * <p>Note that this implementation is an almost exact combined copy of the Spring Framework's 'JndiAccessor' and<a name="line.31"></a> |
| <FONT color="green">032</FONT> * '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> |
| <FONT color="green">033</FONT> * 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> |
| <FONT color="green">034</FONT> * we would have used that. Since Shiro is also Apache 2.0 licensed, all regular licenses and conditions and<a name="line.34"></a> |
| <FONT color="green">035</FONT> * authors have remained in tact.<a name="line.35"></a> |
| <FONT color="green">036</FONT> *<a name="line.36"></a> |
| <FONT color="green">037</FONT> * @see #setJndiTemplate<a name="line.37"></a> |
| <FONT color="green">038</FONT> * @see #setJndiEnvironment<a name="line.38"></a> |
| <FONT color="green">039</FONT> * @see #setResourceRef<a name="line.39"></a> |
| <FONT color="green">040</FONT> * @since 1.1<a name="line.40"></a> |
| <FONT color="green">041</FONT> */<a name="line.41"></a> |
| <FONT color="green">042</FONT> public class JndiLocator {<a name="line.42"></a> |
| <FONT color="green">043</FONT> <a name="line.43"></a> |
| <FONT color="green">044</FONT> /**<a name="line.44"></a> |
| <FONT color="green">045</FONT> * Private class log.<a name="line.45"></a> |
| <FONT color="green">046</FONT> */<a name="line.46"></a> |
| <FONT color="green">047</FONT> private static final Logger log = LoggerFactory.getLogger(JndiLocator.class);<a name="line.47"></a> |
| <FONT color="green">048</FONT> <a name="line.48"></a> |
| <FONT color="green">049</FONT> /**<a name="line.49"></a> |
| <FONT color="green">050</FONT> * JNDI prefix used in a J2EE container<a name="line.50"></a> |
| <FONT color="green">051</FONT> */<a name="line.51"></a> |
| <FONT color="green">052</FONT> public static final String CONTAINER_PREFIX = "java:comp/env/";<a name="line.52"></a> |
| <FONT color="green">053</FONT> <a name="line.53"></a> |
| <FONT color="green">054</FONT> private boolean resourceRef = false;<a name="line.54"></a> |
| <FONT color="green">055</FONT> <a name="line.55"></a> |
| <FONT color="green">056</FONT> private JndiTemplate jndiTemplate = new JndiTemplate();<a name="line.56"></a> |
| <FONT color="green">057</FONT> <a name="line.57"></a> |
| <FONT color="green">058</FONT> <a name="line.58"></a> |
| <FONT color="green">059</FONT> /**<a name="line.59"></a> |
| <FONT color="green">060</FONT> * Set the JNDI template to use for JNDI lookups.<a name="line.60"></a> |
| <FONT color="green">061</FONT> * <p>You can also specify JNDI environment settings via "jndiEnvironment".<a name="line.61"></a> |
| <FONT color="green">062</FONT> *<a name="line.62"></a> |
| <FONT color="green">063</FONT> * @see #setJndiEnvironment<a name="line.63"></a> |
| <FONT color="green">064</FONT> */<a name="line.64"></a> |
| <FONT color="green">065</FONT> public void setJndiTemplate(JndiTemplate jndiTemplate) {<a name="line.65"></a> |
| <FONT color="green">066</FONT> this.jndiTemplate = (jndiTemplate != null ? jndiTemplate : new JndiTemplate());<a name="line.66"></a> |
| <FONT color="green">067</FONT> }<a name="line.67"></a> |
| <FONT color="green">068</FONT> <a name="line.68"></a> |
| <FONT color="green">069</FONT> /**<a name="line.69"></a> |
| <FONT color="green">070</FONT> * Return the JNDI template to use for JNDI lookups.<a name="line.70"></a> |
| <FONT color="green">071</FONT> */<a name="line.71"></a> |
| <FONT color="green">072</FONT> public JndiTemplate getJndiTemplate() {<a name="line.72"></a> |
| <FONT color="green">073</FONT> return this.jndiTemplate;<a name="line.73"></a> |
| <FONT color="green">074</FONT> }<a name="line.74"></a> |
| <FONT color="green">075</FONT> <a name="line.75"></a> |
| <FONT color="green">076</FONT> /**<a name="line.76"></a> |
| <FONT color="green">077</FONT> * Set the JNDI environment to use for JNDI lookups.<a name="line.77"></a> |
| <FONT color="green">078</FONT> * <p>Creates a JndiTemplate with the given environment settings.<a name="line.78"></a> |
| <FONT color="green">079</FONT> *<a name="line.79"></a> |
| <FONT color="green">080</FONT> * @see #setJndiTemplate<a name="line.80"></a> |
| <FONT color="green">081</FONT> */<a name="line.81"></a> |
| <FONT color="green">082</FONT> public void setJndiEnvironment(Properties jndiEnvironment) {<a name="line.82"></a> |
| <FONT color="green">083</FONT> this.jndiTemplate = new JndiTemplate(jndiEnvironment);<a name="line.83"></a> |
| <FONT color="green">084</FONT> }<a name="line.84"></a> |
| <FONT color="green">085</FONT> <a name="line.85"></a> |
| <FONT color="green">086</FONT> /**<a name="line.86"></a> |
| <FONT color="green">087</FONT> * Return the JNDI environment to use for JNDI lookups.<a name="line.87"></a> |
| <FONT color="green">088</FONT> */<a name="line.88"></a> |
| <FONT color="green">089</FONT> public Properties getJndiEnvironment() {<a name="line.89"></a> |
| <FONT color="green">090</FONT> return this.jndiTemplate.getEnvironment();<a name="line.90"></a> |
| <FONT color="green">091</FONT> }<a name="line.91"></a> |
| <FONT color="green">092</FONT> <a name="line.92"></a> |
| <FONT color="green">093</FONT> /**<a name="line.93"></a> |
| <FONT color="green">094</FONT> * Set whether the lookup occurs in a J2EE container, i.e. if the prefix<a name="line.94"></a> |
| <FONT color="green">095</FONT> * "java:comp/env/" needs to be added if the JNDI name doesn't already<a name="line.95"></a> |
| <FONT color="green">096</FONT> * contain it. Default is "false".<a name="line.96"></a> |
| <FONT color="green">097</FONT> * <p>Note: Will only get applied if no other scheme (e.g. "java:") is given.<a name="line.97"></a> |
| <FONT color="green">098</FONT> */<a name="line.98"></a> |
| <FONT color="green">099</FONT> public void setResourceRef(boolean resourceRef) {<a name="line.99"></a> |
| <FONT color="green">100</FONT> this.resourceRef = resourceRef;<a name="line.100"></a> |
| <FONT color="green">101</FONT> }<a name="line.101"></a> |
| <FONT color="green">102</FONT> <a name="line.102"></a> |
| <FONT color="green">103</FONT> /**<a name="line.103"></a> |
| <FONT color="green">104</FONT> * Return whether the lookup occurs in a J2EE container.<a name="line.104"></a> |
| <FONT color="green">105</FONT> */<a name="line.105"></a> |
| <FONT color="green">106</FONT> public boolean isResourceRef() {<a name="line.106"></a> |
| <FONT color="green">107</FONT> return this.resourceRef;<a name="line.107"></a> |
| <FONT color="green">108</FONT> }<a name="line.108"></a> |
| <FONT color="green">109</FONT> <a name="line.109"></a> |
| <FONT color="green">110</FONT> <a name="line.110"></a> |
| <FONT color="green">111</FONT> /**<a name="line.111"></a> |
| <FONT color="green">112</FONT> * Perform an actual JNDI lookup for the given name via the JndiTemplate.<a name="line.112"></a> |
| <FONT color="green">113</FONT> * <p>If the name doesn't begin with "java:comp/env/", this prefix is added<a name="line.113"></a> |
| <FONT color="green">114</FONT> * if "resourceRef" is set to "true".<a name="line.114"></a> |
| <FONT color="green">115</FONT> *<a name="line.115"></a> |
| <FONT color="green">116</FONT> * @param jndiName the JNDI name to look up<a name="line.116"></a> |
| <FONT color="green">117</FONT> * @return the obtained object<a name="line.117"></a> |
| <FONT color="green">118</FONT> * @throws javax.naming.NamingException if the JNDI lookup failed<a name="line.118"></a> |
| <FONT color="green">119</FONT> * @see #setResourceRef<a name="line.119"></a> |
| <FONT color="green">120</FONT> */<a name="line.120"></a> |
| <FONT color="green">121</FONT> protected Object lookup(String jndiName) throws NamingException {<a name="line.121"></a> |
| <FONT color="green">122</FONT> return lookup(jndiName, null);<a name="line.122"></a> |
| <FONT color="green">123</FONT> }<a name="line.123"></a> |
| <FONT color="green">124</FONT> <a name="line.124"></a> |
| <FONT color="green">125</FONT> /**<a name="line.125"></a> |
| <FONT color="green">126</FONT> * Perform an actual JNDI lookup for the given name via the JndiTemplate.<a name="line.126"></a> |
| <FONT color="green">127</FONT> * <p>If the name doesn't begin with "java:comp/env/", this prefix is added<a name="line.127"></a> |
| <FONT color="green">128</FONT> * if "resourceRef" is set to "true".<a name="line.128"></a> |
| <FONT color="green">129</FONT> *<a name="line.129"></a> |
| <FONT color="green">130</FONT> * @param jndiName the JNDI name to look up<a name="line.130"></a> |
| <FONT color="green">131</FONT> * @param requiredType the required type of the object<a name="line.131"></a> |
| <FONT color="green">132</FONT> * @return the obtained object<a name="line.132"></a> |
| <FONT color="green">133</FONT> * @throws NamingException if the JNDI lookup failed<a name="line.133"></a> |
| <FONT color="green">134</FONT> * @see #setResourceRef<a name="line.134"></a> |
| <FONT color="green">135</FONT> */<a name="line.135"></a> |
| <FONT color="green">136</FONT> protected Object lookup(String jndiName, Class requiredType) throws NamingException {<a name="line.136"></a> |
| <FONT color="green">137</FONT> if (jndiName == null) {<a name="line.137"></a> |
| <FONT color="green">138</FONT> throw new IllegalArgumentException("jndiName argument must not be null");<a name="line.138"></a> |
| <FONT color="green">139</FONT> }<a name="line.139"></a> |
| <FONT color="green">140</FONT> String convertedName = convertJndiName(jndiName);<a name="line.140"></a> |
| <FONT color="green">141</FONT> Object jndiObject;<a name="line.141"></a> |
| <FONT color="green">142</FONT> try {<a name="line.142"></a> |
| <FONT color="green">143</FONT> jndiObject = getJndiTemplate().lookup(convertedName, requiredType);<a name="line.143"></a> |
| <FONT color="green">144</FONT> }<a name="line.144"></a> |
| <FONT color="green">145</FONT> catch (NamingException ex) {<a name="line.145"></a> |
| <FONT color="green">146</FONT> if (!convertedName.equals(jndiName)) {<a name="line.146"></a> |
| <FONT color="green">147</FONT> // Try fallback to originally specified name...<a name="line.147"></a> |
| <FONT color="green">148</FONT> if (log.isDebugEnabled()) {<a name="line.148"></a> |
| <FONT color="green">149</FONT> log.debug("Converted JNDI name [" + convertedName +<a name="line.149"></a> |
| <FONT color="green">150</FONT> "] not found - trying original name [" + jndiName + "]. " + ex);<a name="line.150"></a> |
| <FONT color="green">151</FONT> }<a name="line.151"></a> |
| <FONT color="green">152</FONT> jndiObject = getJndiTemplate().lookup(jndiName, requiredType);<a name="line.152"></a> |
| <FONT color="green">153</FONT> } else {<a name="line.153"></a> |
| <FONT color="green">154</FONT> throw ex;<a name="line.154"></a> |
| <FONT color="green">155</FONT> }<a name="line.155"></a> |
| <FONT color="green">156</FONT> }<a name="line.156"></a> |
| <FONT color="green">157</FONT> log.debug("Located object with JNDI name '{}'", convertedName);<a name="line.157"></a> |
| <FONT color="green">158</FONT> return jndiObject;<a name="line.158"></a> |
| <FONT color="green">159</FONT> }<a name="line.159"></a> |
| <FONT color="green">160</FONT> <a name="line.160"></a> |
| <FONT color="green">161</FONT> /**<a name="line.161"></a> |
| <FONT color="green">162</FONT> * Convert the given JNDI name into the actual JNDI name to use.<a name="line.162"></a> |
| <FONT color="green">163</FONT> * <p>The default implementation applies the "java:comp/env/" prefix if<a name="line.163"></a> |
| <FONT color="green">164</FONT> * "resourceRef" is "true" and no other scheme (e.g. "java:") is given.<a name="line.164"></a> |
| <FONT color="green">165</FONT> *<a name="line.165"></a> |
| <FONT color="green">166</FONT> * @param jndiName the original JNDI name<a name="line.166"></a> |
| <FONT color="green">167</FONT> * @return the JNDI name to use<a name="line.167"></a> |
| <FONT color="green">168</FONT> * @see #CONTAINER_PREFIX<a name="line.168"></a> |
| <FONT color="green">169</FONT> * @see #setResourceRef<a name="line.169"></a> |
| <FONT color="green">170</FONT> */<a name="line.170"></a> |
| <FONT color="green">171</FONT> protected String convertJndiName(String jndiName) {<a name="line.171"></a> |
| <FONT color="green">172</FONT> // Prepend container prefix if not already specified and no other scheme given.<a name="line.172"></a> |
| <FONT color="green">173</FONT> if (isResourceRef() && !jndiName.startsWith(CONTAINER_PREFIX) && jndiName.indexOf(':') == -1) {<a name="line.173"></a> |
| <FONT color="green">174</FONT> jndiName = CONTAINER_PREFIX + jndiName;<a name="line.174"></a> |
| <FONT color="green">175</FONT> }<a name="line.175"></a> |
| <FONT color="green">176</FONT> return jndiName;<a name="line.176"></a> |
| <FONT color="green">177</FONT> }<a name="line.177"></a> |
| <FONT color="green">178</FONT> <a name="line.178"></a> |
| <FONT color="green">179</FONT> }<a name="line.179"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </PRE> |
| </BODY> |
| </HTML> |
