| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (version 1.7.0_21) on Thu May 30 14:51:25 PDT 2013 --> |
| <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> |
| <title>JndiLocator (Apache Shiro 1.2.1 API)</title> |
| <meta name="date" content="2013-05-30"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="JndiLocator (Apache Shiro 1.2.1 API)"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/JndiLocator.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/shiro/jndi/JndiCallback.html" title="interface in org.apache.shiro.jndi"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/shiro/jndi/JndiObjectFactory.html" title="class in org.apache.shiro.jndi"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/shiro/jndi/JndiLocator.html" target="_top">Frames</a></li> |
| <li><a href="JndiLocator.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field_summary">Field</a> | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field_detail">Field</a> | </li> |
| <li><a href="#constructor_detail">Constr</a> | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.shiro.jndi</div> |
| <h2 title="Class JndiLocator" class="title">Class JndiLocator</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.shiro.jndi.JndiLocator</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../../org/apache/shiro/jndi/JndiObjectFactory.html" title="class in org.apache.shiro.jndi">JndiObjectFactory</a>, <a href="../../../../org/apache/shiro/realm/jndi/JndiRealmFactory.html" title="class in org.apache.shiro.realm.jndi">JndiRealmFactory</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <a href="../../../../src-html/org/apache/shiro/jndi/JndiLocator.html#line.42">JndiLocator</a> |
| extends <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre> |
| <div class="block">Convenient superclass for JNDI accessors, providing "jndiTemplate" |
| and "jndiEnvironment" bean properties. |
| |
| <p>Note that this implementation is an almost exact combined copy of the Spring Framework's 'JndiAccessor' and |
| 'JndiLocatorSupport' classes from their 2.5.4 distribution - we didn't want to re-invent the wheel, but not require |
| a full dependency on the Spring framework, nor does Spring make available only its JNDI classes in a small jar, or |
| we would have used that. Since Shiro is also Apache 2.0 licensed, all regular licenses and conditions and |
| authors have remained in tact.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>1.1</dd> |
| <dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/shiro/jndi/JndiLocator.html#setJndiTemplate(org.apache.shiro.jndi.JndiTemplate)"><code>setJndiTemplate(org.apache.shiro.jndi.JndiTemplate)</code></a>, |
| <a href="../../../../org/apache/shiro/jndi/JndiLocator.html#setJndiEnvironment(java.util.Properties)"><code>setJndiEnvironment(java.util.Properties)</code></a>, |
| <a href="../../../../org/apache/shiro/jndi/JndiLocator.html#setResourceRef(boolean)"><code>setResourceRef(boolean)</code></a></dd></dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field_summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/shiro/jndi/JndiLocator.html#CONTAINER_PREFIX">CONTAINER_PREFIX</a></strong></code> |
| <div class="block">JNDI prefix used in a J2EE container</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><strong><a href="../../../../org/apache/shiro/jndi/JndiLocator.html#JndiLocator()">JndiLocator</a></strong>()</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/shiro/jndi/JndiLocator.html#convertJndiName(java.lang.String)">convertJndiName</a></strong>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> jndiName)</code> |
| <div class="block">Convert the given JNDI name into the actual JNDI name to use.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://java.sun.com/javase/6/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/shiro/jndi/JndiLocator.html#getJndiEnvironment()">getJndiEnvironment</a></strong>()</code> |
| <div class="block">Return the JNDI environment to use for JNDI lookups.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/shiro/jndi/JndiTemplate.html" title="class in org.apache.shiro.jndi">JndiTemplate</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/shiro/jndi/JndiLocator.html#getJndiTemplate()">getJndiTemplate</a></strong>()</code> |
| <div class="block">Return the JNDI template to use for JNDI lookups.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/shiro/jndi/JndiLocator.html#isResourceRef()">isResourceRef</a></strong>()</code> |
| <div class="block">Return whether the lookup occurs in a J2EE container.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/shiro/jndi/JndiLocator.html#lookup(java.lang.String)">lookup</a></strong>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> jndiName)</code> |
| <div class="block">Perform an actual JNDI lookup for the given name via the JndiTemplate.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/shiro/jndi/JndiLocator.html#lookup(java.lang.String, java.lang.Class)">lookup</a></strong>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> jndiName, |
| <a href="http://java.sun.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a> requiredType)</code> |
| <div class="block">Perform an actual JNDI lookup for the given name via the JndiTemplate.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/shiro/jndi/JndiLocator.html#setJndiEnvironment(java.util.Properties)">setJndiEnvironment</a></strong>(<a href="http://java.sun.com/javase/6/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a> jndiEnvironment)</code> |
| <div class="block">Set the JNDI environment to use for JNDI lookups.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/shiro/jndi/JndiLocator.html#setJndiTemplate(org.apache.shiro.jndi.JndiTemplate)">setJndiTemplate</a></strong>(<a href="../../../../org/apache/shiro/jndi/JndiTemplate.html" title="class in org.apache.shiro.jndi">JndiTemplate</a> jndiTemplate)</code> |
| <div class="block">Set the JNDI template to use for JNDI lookups.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/shiro/jndi/JndiLocator.html#setResourceRef(boolean)">setResourceRef</a></strong>(boolean resourceRef)</code> |
| <div class="block">Set whether the lookup occurs in a J2EE container, i.e.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field_detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="CONTAINER_PREFIX"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>CONTAINER_PREFIX</h4> |
| <pre>public static final <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/shiro/jndi/JndiLocator.html#line.52">CONTAINER_PREFIX</a></pre> |
| <div class="block">JNDI prefix used in a J2EE container</div> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.shiro.jndi.JndiLocator.CONTAINER_PREFIX">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="JndiLocator()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>JndiLocator</h4> |
| <pre>public <a href="../../../../src-html/org/apache/shiro/jndi/JndiLocator.html#line.42">JndiLocator</a>()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="setJndiTemplate(org.apache.shiro.jndi.JndiTemplate)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setJndiTemplate</h4> |
| <pre>public void <a href="../../../../src-html/org/apache/shiro/jndi/JndiLocator.html#line.65">setJndiTemplate</a>(<a href="../../../../org/apache/shiro/jndi/JndiTemplate.html" title="class in org.apache.shiro.jndi">JndiTemplate</a> jndiTemplate)</pre> |
| <div class="block">Set the JNDI template to use for JNDI lookups. |
| <p>You can also specify JNDI environment settings via "jndiEnvironment".</div> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/shiro/jndi/JndiLocator.html#setJndiEnvironment(java.util.Properties)"><code>setJndiEnvironment(java.util.Properties)</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="getJndiTemplate()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getJndiTemplate</h4> |
| <pre>public <a href="../../../../org/apache/shiro/jndi/JndiTemplate.html" title="class in org.apache.shiro.jndi">JndiTemplate</a> <a href="../../../../src-html/org/apache/shiro/jndi/JndiLocator.html#line.72">getJndiTemplate</a>()</pre> |
| <div class="block">Return the JNDI template to use for JNDI lookups.</div> |
| </li> |
| </ul> |
| <a name="setJndiEnvironment(java.util.Properties)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setJndiEnvironment</h4> |
| <pre>public void <a href="../../../../src-html/org/apache/shiro/jndi/JndiLocator.html#line.82">setJndiEnvironment</a>(<a href="http://java.sun.com/javase/6/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a> jndiEnvironment)</pre> |
| <div class="block">Set the JNDI environment to use for JNDI lookups. |
| <p>Creates a JndiTemplate with the given environment settings.</div> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/shiro/jndi/JndiLocator.html#setJndiTemplate(org.apache.shiro.jndi.JndiTemplate)"><code>setJndiTemplate(org.apache.shiro.jndi.JndiTemplate)</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="getJndiEnvironment()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getJndiEnvironment</h4> |
| <pre>public <a href="http://java.sun.com/javase/6/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a> <a href="../../../../src-html/org/apache/shiro/jndi/JndiLocator.html#line.89">getJndiEnvironment</a>()</pre> |
| <div class="block">Return the JNDI environment to use for JNDI lookups.</div> |
| </li> |
| </ul> |
| <a name="setResourceRef(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setResourceRef</h4> |
| <pre>public void <a href="../../../../src-html/org/apache/shiro/jndi/JndiLocator.html#line.99">setResourceRef</a>(boolean resourceRef)</pre> |
| <div class="block">Set whether the lookup occurs in a J2EE container, i.e. if the prefix |
| "java:comp/env/" needs to be added if the JNDI name doesn't already |
| contain it. Default is "false". |
| <p>Note: Will only get applied if no other scheme (e.g. "java:") is given.</div> |
| </li> |
| </ul> |
| <a name="isResourceRef()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isResourceRef</h4> |
| <pre>public boolean <a href="../../../../src-html/org/apache/shiro/jndi/JndiLocator.html#line.106">isResourceRef</a>()</pre> |
| <div class="block">Return whether the lookup occurs in a J2EE container.</div> |
| </li> |
| </ul> |
| <a name="lookup(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>lookup</h4> |
| <pre>protected <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> <a href="../../../../src-html/org/apache/shiro/jndi/JndiLocator.html#line.121">lookup</a>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> jndiName) |
| throws <a href="http://java.sun.com/javase/6/docs/api/javax/naming/NamingException.html?is-external=true" title="class or interface in javax.naming">NamingException</a></pre> |
| <div class="block">Perform an actual JNDI lookup for the given name via the JndiTemplate. |
| <p>If the name doesn't begin with "java:comp/env/", this prefix is added |
| if "resourceRef" is set to "true".</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>jndiName</code> - the JNDI name to look up</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the obtained object</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://java.sun.com/javase/6/docs/api/javax/naming/NamingException.html?is-external=true" title="class or interface in javax.naming">NamingException</a></code> - if the JNDI lookup failed</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/shiro/jndi/JndiLocator.html#setResourceRef(boolean)"><code>setResourceRef(boolean)</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="lookup(java.lang.String, java.lang.Class)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>lookup</h4> |
| <pre>protected <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> <a href="../../../../src-html/org/apache/shiro/jndi/JndiLocator.html#line.136">lookup</a>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> jndiName, |
| <a href="http://java.sun.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a> requiredType) |
| throws <a href="http://java.sun.com/javase/6/docs/api/javax/naming/NamingException.html?is-external=true" title="class or interface in javax.naming">NamingException</a></pre> |
| <div class="block">Perform an actual JNDI lookup for the given name via the JndiTemplate. |
| <p>If the name doesn't begin with "java:comp/env/", this prefix is added |
| if "resourceRef" is set to "true".</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>jndiName</code> - the JNDI name to look up</dd><dd><code>requiredType</code> - the required type of the object</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the obtained object</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://java.sun.com/javase/6/docs/api/javax/naming/NamingException.html?is-external=true" title="class or interface in javax.naming">NamingException</a></code> - if the JNDI lookup failed</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/shiro/jndi/JndiLocator.html#setResourceRef(boolean)"><code>setResourceRef(boolean)</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="convertJndiName(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>convertJndiName</h4> |
| <pre>protected <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/shiro/jndi/JndiLocator.html#line.171">convertJndiName</a>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> jndiName)</pre> |
| <div class="block">Convert the given JNDI name into the actual JNDI name to use. |
| <p>The default implementation applies the "java:comp/env/" prefix if |
| "resourceRef" is "true" and no other scheme (e.g. "java:") is given.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>jndiName</code> - the original JNDI name</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the JNDI name to use</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/shiro/jndi/JndiLocator.html#CONTAINER_PREFIX"><code>CONTAINER_PREFIX</code></a>, |
| <a href="../../../../org/apache/shiro/jndi/JndiLocator.html#setResourceRef(boolean)"><code>setResourceRef(boolean)</code></a></dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar_bottom"> |
| <!-- --> |
| </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/JndiLocator.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/shiro/jndi/JndiCallback.html" title="interface in org.apache.shiro.jndi"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/shiro/jndi/JndiObjectFactory.html" title="class in org.apache.shiro.jndi"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/shiro/jndi/JndiLocator.html" target="_top">Frames</a></li> |
| <li><a href="JndiLocator.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field_summary">Field</a> | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field_detail">Field</a> | </li> |
| <li><a href="#constructor_detail">Constr</a> | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2004-2013 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p> |
| </body> |
| </html> |
| |