| <!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 (1.8.0_40) on Thu Jul 20 13:15:16 PDT 2017 --> |
| <title>SharedResourceFactory (gobblin-api 0.11.0 API)</title> |
| <meta name="date" content="2017-07-20"> |
| <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="SharedResourceFactory (gobblin-api 0.11.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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="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="../../../gobblin/broker/iface/ScopeType.html" title="interface in gobblin.broker.iface"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../gobblin/broker/iface/SharedResourceFactoryResponse.html" title="interface in gobblin.broker.iface"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?gobblin/broker/iface/SharedResourceFactory.html" target="_top">Frames</a></li> |
| <li><a href="SharedResourceFactory.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>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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">gobblin.broker.iface</div> |
| <h2 title="Interface SharedResourceFactory" class="title">Interface SharedResourceFactory<T,K extends <a href="../../../gobblin/broker/iface/SharedResourceKey.html" title="interface in gobblin.broker.iface">SharedResourceKey</a>,S extends <a href="../../../gobblin/broker/iface/ScopeType.html" title="interface in gobblin.broker.iface">ScopeType</a><S>></h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - type of objects this factory creates.</dd> |
| <dd><code>K</code> - type of <a href="../../../gobblin/broker/iface/SharedResourceKey.html" title="interface in gobblin.broker.iface"><code>SharedResourceKey</code></a> this factory uses.</dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">SharedResourceFactory<T,K extends <a href="../../../gobblin/broker/iface/SharedResourceKey.html" title="interface in gobblin.broker.iface">SharedResourceKey</a>,S extends <a href="../../../gobblin/broker/iface/ScopeType.html" title="interface in gobblin.broker.iface">ScopeType</a><S>></span></pre> |
| <div class="block">A factory that creates <a href="../../../gobblin/broker/iface/ScopeInstance.html" title="interface in gobblin.broker.iface"><code>ScopeInstance</code></a> specific objects.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== 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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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="../../../gobblin/broker/iface/SharedResourceFactoryResponse.html" title="interface in gobblin.broker.iface">SharedResourceFactoryResponse</a><<a href="../../../gobblin/broker/iface/SharedResourceFactory.html" title="type parameter in SharedResourceFactory">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/broker/iface/SharedResourceFactory.html#createResource-gobblin.broker.iface.SharedResourcesBroker-gobblin.broker.iface.ScopedConfigView-">createResource</a></span>(<a href="../../../gobblin/broker/iface/SharedResourcesBroker.html" title="interface in gobblin.broker.iface">SharedResourcesBroker</a><<a href="../../../gobblin/broker/iface/SharedResourceFactory.html" title="type parameter in SharedResourceFactory">S</a>> broker, |
| <a href="../../../gobblin/broker/iface/ScopedConfigView.html" title="interface in gobblin.broker.iface">ScopedConfigView</a><<a href="../../../gobblin/broker/iface/SharedResourceFactory.html" title="type parameter in SharedResourceFactory">S</a>,<a href="../../../gobblin/broker/iface/SharedResourceFactory.html" title="type parameter in SharedResourceFactory">K</a>> config)</code> |
| <div class="block">Requests an object for the provided <a href="../../../gobblin/broker/iface/SharedResourceKey.html" title="interface in gobblin.broker.iface"><code>SharedResourceKey</code></a>, with the provided configuration.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../gobblin/broker/iface/SharedResourceFactory.html" title="type parameter in SharedResourceFactory">S</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/broker/iface/SharedResourceFactory.html#getAutoScope-gobblin.broker.iface.SharedResourcesBroker-gobblin.broker.iface.ConfigView-">getAutoScope</a></span>(<a href="../../../gobblin/broker/iface/SharedResourcesBroker.html" title="interface in gobblin.broker.iface">SharedResourcesBroker</a><<a href="../../../gobblin/broker/iface/SharedResourceFactory.html" title="type parameter in SharedResourceFactory">S</a>> broker, |
| <a href="../../../gobblin/broker/iface/ConfigView.html" title="interface in gobblin.broker.iface">ConfigView</a><<a href="../../../gobblin/broker/iface/SharedResourceFactory.html" title="type parameter in SharedResourceFactory">S</a>,<a href="../../../gobblin/broker/iface/SharedResourceFactory.html" title="type parameter in SharedResourceFactory">K</a>> config)</code> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/broker/iface/SharedResourceFactory.html#getName--">getName</a></span>()</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getName</h4> |
| <pre><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getName()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>An identifier for this factory. Users will configure shared resources using this name.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createResource-gobblin.broker.iface.SharedResourcesBroker-gobblin.broker.iface.ScopedConfigView-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createResource</h4> |
| <pre><a href="../../../gobblin/broker/iface/SharedResourceFactoryResponse.html" title="interface in gobblin.broker.iface">SharedResourceFactoryResponse</a><<a href="../../../gobblin/broker/iface/SharedResourceFactory.html" title="type parameter in SharedResourceFactory">T</a>> createResource(<a href="../../../gobblin/broker/iface/SharedResourcesBroker.html" title="interface in gobblin.broker.iface">SharedResourcesBroker</a><<a href="../../../gobblin/broker/iface/SharedResourceFactory.html" title="type parameter in SharedResourceFactory">S</a>> broker, |
| <a href="../../../gobblin/broker/iface/ScopedConfigView.html" title="interface in gobblin.broker.iface">ScopedConfigView</a><<a href="../../../gobblin/broker/iface/SharedResourceFactory.html" title="type parameter in SharedResourceFactory">S</a>,<a href="../../../gobblin/broker/iface/SharedResourceFactory.html" title="type parameter in SharedResourceFactory">K</a>> config) |
| throws <a href="../../../gobblin/broker/iface/NotConfiguredException.html" title="class in gobblin.broker.iface">NotConfiguredException</a></pre> |
| <div class="block">Requests an object for the provided <a href="../../../gobblin/broker/iface/SharedResourceKey.html" title="interface in gobblin.broker.iface"><code>SharedResourceKey</code></a>, with the provided configuration. |
| The factory can return a variety of responses: |
| * <a href="../../../gobblin/broker/ResourceEntry.html" title="interface in gobblin.broker"><code>ResourceEntry</code></a>: a newly built resource of type T for the input key and scope. |
| * <a href="../../../gobblin/broker/ResourceCoordinate.html" title="class in gobblin.broker"><code>ResourceCoordinate</code></a>: the coordinates (factory, key, scope) of another resource of type T that |
| should be used instead (this allows, for example, to use a different factory, or always return a global scoped object.)</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../gobblin/broker/iface/NotConfiguredException.html" title="class in gobblin.broker.iface">NotConfiguredException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAutoScope-gobblin.broker.iface.SharedResourcesBroker-gobblin.broker.iface.ConfigView-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getAutoScope</h4> |
| <pre><a href="../../../gobblin/broker/iface/SharedResourceFactory.html" title="type parameter in SharedResourceFactory">S</a> getAutoScope(<a href="../../../gobblin/broker/iface/SharedResourcesBroker.html" title="interface in gobblin.broker.iface">SharedResourcesBroker</a><<a href="../../../gobblin/broker/iface/SharedResourceFactory.html" title="type parameter in SharedResourceFactory">S</a>> broker, |
| <a href="../../../gobblin/broker/iface/ConfigView.html" title="interface in gobblin.broker.iface">ConfigView</a><<a href="../../../gobblin/broker/iface/SharedResourceFactory.html" title="type parameter in SharedResourceFactory">S</a>,<a href="../../../gobblin/broker/iface/SharedResourceFactory.html" title="type parameter in SharedResourceFactory">K</a>> config)</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The <a href="../../../gobblin/broker/iface/ScopeType.html" title="interface in gobblin.broker.iface"><code>ScopeType</code></a> at which an auto scoped resource should be created. A good default is to return |
| broker.selfScope()</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="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="../../../gobblin/broker/iface/ScopeType.html" title="interface in gobblin.broker.iface"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../gobblin/broker/iface/SharedResourceFactoryResponse.html" title="interface in gobblin.broker.iface"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?gobblin/broker/iface/SharedResourceFactory.html" target="_top">Frames</a></li> |
| <li><a href="SharedResourceFactory.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>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
