| <!DOCTYPE HTML> |
| <html lang="en"> |
| <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 javax.naming.Context;</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">/**</a> |
| <span class="sourceLineNo">025</span><a id="line.25"> * Callback interface to be implemented by classes that need to perform an</a> |
| <span class="sourceLineNo">026</span><a id="line.26"> * operation (such as a lookup) in a JNDI context. This callback approach</a> |
| <span class="sourceLineNo">027</span><a id="line.27"> * is valuable in simplifying error handling, which is performed by the</a> |
| <span class="sourceLineNo">028</span><a id="line.28"> * JndiTemplate class. This is a similar to JdbcTemplate's approach.</a> |
| <span class="sourceLineNo">029</span><a id="line.29"> *</a> |
| <span class="sourceLineNo">030</span><a id="line.30"> * <p>Note that there is hardly any need to implement this callback</a> |
| <span class="sourceLineNo">031</span><a id="line.31"> * interface, as JndiTemplate provides all usual JNDI operations via</a> |
| <span class="sourceLineNo">032</span><a id="line.32"> * convenience methods.</a> |
| <span class="sourceLineNo">033</span><a id="line.33"> *</a> |
| <span class="sourceLineNo">034</span><a id="line.34"> * <p>Note that this interface is an exact copy of the Spring Framework's identically named interface from</a> |
| <span class="sourceLineNo">035</span><a id="line.35"> * their 2.5.4 distribution - we didn't want to re-invent the wheel, but not require a full dependency on the</a> |
| <span class="sourceLineNo">036</span><a id="line.36"> * Spring framework, nor does Spring make available only its JNDI classes in a small jar, or we would have used that.</a> |
| <span class="sourceLineNo">037</span><a id="line.37"> * Since Shiro is also Apache 2.0 licensed, all regular licenses and conditions and authors have remained in tact.</a> |
| <span class="sourceLineNo">038</span><a id="line.38"> *</a> |
| <span class="sourceLineNo">039</span><a id="line.39"> * @see JndiTemplate</a> |
| <span class="sourceLineNo">040</span><a id="line.40"> */</a> |
| <span class="sourceLineNo">041</span><a id="line.41">public interface JndiCallback {</a> |
| <span class="sourceLineNo">042</span><a id="line.42"></a> |
| <span class="sourceLineNo">043</span><a id="line.43"> /**</a> |
| <span class="sourceLineNo">044</span><a id="line.44"> * Do something with the given JNDI context.</a> |
| <span class="sourceLineNo">045</span><a id="line.45"> * Implementations don't need to worry about error handling</a> |
| <span class="sourceLineNo">046</span><a id="line.46"> * or cleanup, as the JndiTemplate class will handle this.</a> |
| <span class="sourceLineNo">047</span><a id="line.47"> *</a> |
| <span class="sourceLineNo">048</span><a id="line.48"> * @param ctx the current JNDI context</a> |
| <span class="sourceLineNo">049</span><a id="line.49"> * @return a result object, or <code>null</code></a> |
| <span class="sourceLineNo">050</span><a id="line.50"> * @throws NamingException if thrown by JNDI methods</a> |
| <span class="sourceLineNo">051</span><a id="line.51"> */</a> |
| <span class="sourceLineNo">052</span><a id="line.52"> Object doInContext(Context ctx) throws NamingException;</a> |
| <span class="sourceLineNo">053</span><a id="line.53"></a> |
| <span class="sourceLineNo">054</span><a id="line.54">}</a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
