| <!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 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>BasePluginRegistryTest.LocatorFixture (Drill : 1.20.0 API)</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="BasePluginRegistryTest.LocatorFixture (Drill : 1.20.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <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/BasePluginRegistryTest.LocatorFixture.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/drill/exec/store/BasePluginRegistryTest.html" title="class in org.apache.drill.exec.store"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/drill/exec/store/BasePluginRegistryTest.PluginRegistryContextFixture.html" title="class in org.apache.drill.exec.store"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/drill/exec/store/BasePluginRegistryTest.LocatorFixture.html" target="_top">Frames</a></li> |
| <li><a href="BasePluginRegistryTest.LocatorFixture.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>Field | </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>Field | </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.drill.exec.store</div> |
| <h2 title="Class BasePluginRegistryTest.LocatorFixture" class="title">Class BasePluginRegistryTest.LocatorFixture</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/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.drill.exec.store.BasePluginRegistryTest.LocatorFixture</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../../../org/apache/drill/exec/store/ConnectorLocator.html" title="interface in org.apache.drill.exec.store">ConnectorLocator</a></dd> |
| </dl> |
| <dl> |
| <dt>Enclosing class:</dt> |
| <dd><a href="../../../../../org/apache/drill/exec/store/BasePluginRegistryTest.html" title="class in org.apache.drill.exec.store">BasePluginRegistryTest</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>protected static class <span class="typeNameLabel">BasePluginRegistryTest.LocatorFixture</span> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> |
| implements <a href="../../../../../org/apache/drill/exec/store/ConnectorLocator.html" title="interface in org.apache.drill.exec.store">ConnectorLocator</a></pre> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" 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><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/store/BasePluginRegistryTest.LocatorFixture.html#LocatorFixture--">LocatorFixture</a></span>()</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/drill/exec/planner/logical/StoragePlugins.html" title="class in org.apache.drill.exec.planner.logical">StoragePlugins</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/store/BasePluginRegistryTest.LocatorFixture.html#bootstrapPlugins--">bootstrapPlugins</a></span>()</code> |
| <div class="block">When starting a new installation, called to load bootstrap |
| plugins (configurations) that come "out-of-the-box."</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/store/BasePluginRegistryTest.LocatorFixture.html#close--">close</a></span>()</code> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/drill/common/logical/StoragePluginConfig.html" title="class in org.apache.drill.common.logical">StoragePluginConfig</a>>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/store/BasePluginRegistryTest.LocatorFixture.html#configClasses--">configClasses</a></span>()</code> |
| <div class="block">Return the set of known storage plugin configuration classes for which |
| the user can create configs.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/drill/exec/store/StoragePlugin.html" title="interface in org.apache.drill.exec.store">StoragePlugin</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/store/BasePluginRegistryTest.LocatorFixture.html#connectorClassFor-java.lang.Class-">connectorClassFor</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/drill/common/logical/StoragePluginConfig.html" title="class in org.apache.drill.common.logical">StoragePluginConfig</a>> configClass)</code> |
| <div class="block">Given a configuration class, return the corresponding connector |
| (plugin) class.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/drill/exec/store/StoragePlugin.html" title="interface in org.apache.drill.exec.store">StoragePlugin</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/store/BasePluginRegistryTest.LocatorFixture.html#create-java.lang.String-org.apache.drill.common.logical.StoragePluginConfig-">create</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| <a href="../../../../../org/apache/drill/common/logical/StoragePluginConfig.html" title="class in org.apache.drill.common.logical">StoragePluginConfig</a> config)</code> |
| <div class="block">Create a connector instance given a named configuration.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/drill/exec/store/StoragePlugin.html" title="interface in org.apache.drill.exec.store">StoragePlugin</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/store/BasePluginRegistryTest.LocatorFixture.html#get-java.lang.String-">get</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> |
| <div class="block">Retrieve an instance of the named connector with default configuration.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/store/BasePluginRegistryTest.LocatorFixture.html#init--">init</a></span>()</code> |
| <div class="block">Initialize the locator.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../../org/apache/drill/exec/store/StoragePlugin.html" title="interface in org.apache.drill.exec.store">StoragePlugin</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/store/BasePluginRegistryTest.LocatorFixture.html#intrinsicPlugins--">intrinsicPlugins</a></span>()</code> |
| <div class="block">Enumerate the intrinsic plugins.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/store/BasePluginRegistryTest.LocatorFixture.html#onUpgrade--">onUpgrade</a></span>()</code> |
| <div class="block">If <code>updatedPlugins()</code> returned non-null, then the |
| registry will call this method after successful update of |
| the persistent store.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/store/BasePluginRegistryTest.LocatorFixture.html#storable--">storable</a></span>()</code> </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/drill/exec/planner/logical/StoragePlugins.html" title="class in org.apache.drill.exec.planner.logical">StoragePlugins</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/store/BasePluginRegistryTest.LocatorFixture.html#updatedPlugins--">updatedPlugins</a></span>()</code> |
| <div class="block">Identify plugins to be added to an existing system, typically |
| on the first run after an upgrade.</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="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/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"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="LocatorFixture--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>LocatorFixture</h4> |
| <pre>public LocatorFixture()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="init--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>init</h4> |
| <pre>public void init()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/drill/exec/store/ConnectorLocator.html#init--">ConnectorLocator</a></code></span></div> |
| <div class="block">Initialize the locator. Must be called before the locator is used.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/drill/exec/store/ConnectorLocator.html#init--">init</a></code> in interface <code><a href="../../../../../org/apache/drill/exec/store/ConnectorLocator.html" title="interface in org.apache.drill.exec.store">ConnectorLocator</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="bootstrapPlugins--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>bootstrapPlugins</h4> |
| <pre>public <a href="../../../../../org/apache/drill/exec/planner/logical/StoragePlugins.html" title="class in org.apache.drill.exec.planner.logical">StoragePlugins</a> bootstrapPlugins()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/drill/exec/store/ConnectorLocator.html#bootstrapPlugins--">ConnectorLocator</a></code></span></div> |
| <div class="block">When starting a new installation, called to load bootstrap |
| plugins (configurations) that come "out-of-the-box."</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/drill/exec/store/ConnectorLocator.html#bootstrapPlugins--">bootstrapPlugins</a></code> in interface <code><a href="../../../../../org/apache/drill/exec/store/ConnectorLocator.html" title="interface in org.apache.drill.exec.store">ConnectorLocator</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the set of bootstrap plugins, or <code>null</code> if this locator |
| does not provide bootstrap plugins</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="updatedPlugins--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>updatedPlugins</h4> |
| <pre>public <a href="../../../../../org/apache/drill/exec/planner/logical/StoragePlugins.html" title="class in org.apache.drill.exec.planner.logical">StoragePlugins</a> updatedPlugins()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/drill/exec/store/ConnectorLocator.html#updatedPlugins--">ConnectorLocator</a></code></span></div> |
| <div class="block">Identify plugins to be added to an existing system, typically |
| on the first run after an upgrade. |
| <p> |
| TODO: The current mechanism depends on deleting a file after the |
| first run, which is unreliable. It won't, for example, correctly |
| handle a restored ZK. A better mechanism would store a version |
| number in the persistent store, and pass that version number into |
| this method.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/drill/exec/store/ConnectorLocator.html#updatedPlugins--">updatedPlugins</a></code> in interface <code><a href="../../../../../org/apache/drill/exec/store/ConnectorLocator.html" title="interface in org.apache.drill.exec.store">ConnectorLocator</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the set of plugin configurations to refresh in the |
| persistent store, or null if none to update</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="onUpgrade--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onUpgrade</h4> |
| <pre>public void onUpgrade()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/drill/exec/store/ConnectorLocator.html#onUpgrade--">ConnectorLocator</a></code></span></div> |
| <div class="block">If <code>updatedPlugins()</code> returned non-null, then the |
| registry will call this method after successful update of |
| the persistent store. This method can do any post-update |
| cleanup, such as deleting the file mentioned above.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/drill/exec/store/ConnectorLocator.html#onUpgrade--">onUpgrade</a></code> in interface <code><a href="../../../../../org/apache/drill/exec/store/ConnectorLocator.html" title="interface in org.apache.drill.exec.store">ConnectorLocator</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="intrinsicPlugins--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>intrinsicPlugins</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../../org/apache/drill/exec/store/StoragePlugin.html" title="interface in org.apache.drill.exec.store">StoragePlugin</a>> intrinsicPlugins()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/drill/exec/store/ConnectorLocator.html#intrinsicPlugins--">ConnectorLocator</a></code></span></div> |
| <div class="block">Enumerate the intrinsic plugins. An intrinsic plugin is one |
| which takes no configuration and which therefore cannot be |
| disabled, and thus is always available. Example: Drill's |
| system plugins. For an intrinsic plugin, the plugin name is |
| also the name of the configuration.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/drill/exec/store/ConnectorLocator.html#intrinsicPlugins--">intrinsicPlugins</a></code> in interface <code><a href="../../../../../org/apache/drill/exec/store/ConnectorLocator.html" title="interface in org.apache.drill.exec.store">ConnectorLocator</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>map of intrinsic plugins which require no configuration</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="get-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>get</h4> |
| <pre>public <a href="../../../../../org/apache/drill/exec/store/StoragePlugin.html" title="interface in org.apache.drill.exec.store">StoragePlugin</a> get(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/drill/exec/store/ConnectorLocator.html#get-java.lang.String-">ConnectorLocator</a></code></span></div> |
| <div class="block">Retrieve an instance of the named connector with default configuration. |
| Typically used for connectors with no configuration, such as system |
| storage plugins.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/drill/exec/store/ConnectorLocator.html#get-java.lang.String-">get</a></code> in interface <code><a href="../../../../../org/apache/drill/exec/store/ConnectorLocator.html" title="interface in org.apache.drill.exec.store">ConnectorLocator</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the name of a <i>connector class</i> (not the name of |
| a plugin (configuration)</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a plugin with default configuration, or null if this locator does |
| not support such plugins</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="configClasses--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>configClasses</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/drill/common/logical/StoragePluginConfig.html" title="class in org.apache.drill.common.logical">StoragePluginConfig</a>>> configClasses()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/drill/exec/store/ConnectorLocator.html#configClasses--">ConnectorLocator</a></code></span></div> |
| <div class="block">Return the set of known storage plugin configuration classes for which |
| the user can create configs. Excludes system plugin configs. Used |
| to map config classes to this locator to create plugin instances.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/drill/exec/store/ConnectorLocator.html#configClasses--">configClasses</a></code> in interface <code><a href="../../../../../org/apache/drill/exec/store/ConnectorLocator.html" title="interface in org.apache.drill.exec.store">ConnectorLocator</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the unuordered set of storage plugin configuration classes |
| available from this locator. Can be null if this locator offers |
| only system plugins</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="create-java.lang.String-org.apache.drill.common.logical.StoragePluginConfig-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>create</h4> |
| <pre>public <a href="../../../../../org/apache/drill/exec/store/StoragePlugin.html" title="interface in org.apache.drill.exec.store">StoragePlugin</a> create(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| <a href="../../../../../org/apache/drill/common/logical/StoragePluginConfig.html" title="class in org.apache.drill.common.logical">StoragePluginConfig</a> config) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/drill/exec/store/ConnectorLocator.html#create-java.lang.String-org.apache.drill.common.logical.StoragePluginConfig-">ConnectorLocator</a></code></span></div> |
| <div class="block">Create a connector instance given a named configuration. The configuration |
| and/or name is used to locate the connector class.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/drill/exec/store/ConnectorLocator.html#create-java.lang.String-org.apache.drill.common.logical.StoragePluginConfig-">create</a></code> in interface <code><a href="../../../../../org/apache/drill/exec/store/ConnectorLocator.html" title="interface in org.apache.drill.exec.store">ConnectorLocator</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - name of the storage plugin (configuration).</dd> |
| <dd><code>config</code> - the deserialized Java configuration object.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a connector of the proper class that matches the configuration or |
| name, initialized with the configuration</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/apache/drill/common/exceptions/ExecutionSetupException.html" title="class in org.apache.drill.common.exceptions">ExecutionSetupException</a></code> - for all errors</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="storable--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>storable</h4> |
| <pre>public boolean storable()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/drill/exec/store/ConnectorLocator.html#storable--">storable</a></code> in interface <code><a href="../../../../../org/apache/drill/exec/store/ConnectorLocator.html" title="interface in org.apache.drill.exec.store">ConnectorLocator</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if configs for this locator should be persisted, false if |
| these are ad-hoc or otherwise per-run connectors</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="connectorClassFor-java.lang.Class-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>connectorClassFor</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/drill/exec/store/StoragePlugin.html" title="interface in org.apache.drill.exec.store">StoragePlugin</a>> connectorClassFor(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/drill/common/logical/StoragePluginConfig.html" title="class in org.apache.drill.common.logical">StoragePluginConfig</a>> configClass)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/drill/exec/store/ConnectorLocator.html#connectorClassFor-java.lang.Class-">ConnectorLocator</a></code></span></div> |
| <div class="block">Given a configuration class, return the corresponding connector |
| (plugin) class.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/drill/exec/store/ConnectorLocator.html#connectorClassFor-java.lang.Class-">connectorClassFor</a></code> in interface <code><a href="../../../../../org/apache/drill/exec/store/ConnectorLocator.html" title="interface in org.apache.drill.exec.store">ConnectorLocator</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="close--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre>public void close()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/drill/exec/store/ConnectorLocator.html#close--">close</a></code> in interface <code><a href="../../../../../org/apache/drill/exec/store/ConnectorLocator.html" title="interface in org.apache.drill.exec.store">ConnectorLocator</a></code></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> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <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/BasePluginRegistryTest.LocatorFixture.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/drill/exec/store/BasePluginRegistryTest.html" title="class in org.apache.drill.exec.store"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/drill/exec/store/BasePluginRegistryTest.PluginRegistryContextFixture.html" title="class in org.apache.drill.exec.store"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/drill/exec/store/BasePluginRegistryTest.LocatorFixture.html" target="_top">Frames</a></li> |
| <li><a href="BasePluginRegistryTest.LocatorFixture.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>Field | </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>Field | </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 © 2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
