| <!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_151) on Thu Jan 04 11:28:38 GMT 2018 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>RunStore (Apache Taverna Server 3.1.0-incubating-SNAPSHOT API)</title> |
| <meta name="date" content="2018-01-04"> |
| <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="RunStore (Apache Taverna Server 3.1.0-incubating-SNAPSHOT API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":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="class-use/RunStore.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/taverna/server/master/interfaces/Policy.html" title="interface in org.taverna.server.master.interfaces"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/taverna/server/master/interfaces/SecurityContextFactory.html" title="interface in org.taverna.server.master.interfaces"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/taverna/server/master/interfaces/RunStore.html" target="_top">Frames</a></li> |
| <li><a href="RunStore.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">org.taverna.server.master.interfaces</div> |
| <h2 title="Interface RunStore" class="title">Interface RunStore</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../org/taverna/server/master/worker/RunDatabase.html" title="class in org.taverna.server.master.worker">RunDatabase</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">RunStore</span></pre> |
| <div class="block">Interface to the mechanism that looks after the mapping of names to runs. |
| Instances of this class may also be responsible for enforcing timely cleanup |
| of expired workflows.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Author:</span></dt> |
| <dd>Donal Fellows.</dd> |
| </dl> |
| </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="../../../../../org/taverna/server/master/interfaces/TavernaRun.html" title="interface in org.taverna.server.master.interfaces">TavernaRun</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/taverna/server/master/interfaces/RunStore.html#getRun-java.lang.String-">getRun</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> uuid)</code> |
| <div class="block">Obtain the named workflow run.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/taverna/server/master/interfaces/TavernaRun.html" title="interface in org.taverna.server.master.interfaces">TavernaRun</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/taverna/server/master/interfaces/RunStore.html#getRun-org.taverna.server.master.utils.UsernamePrincipal-org.taverna.server.master.interfaces.Policy-java.lang.String-">getRun</a></span>(<a href="../../../../../org/taverna/server/master/utils/UsernamePrincipal.html" title="class in org.taverna.server.master.utils">UsernamePrincipal</a> user, |
| <a href="../../../../../org/taverna/server/master/interfaces/Policy.html" title="interface in org.taverna.server.master.interfaces">Policy</a> p, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> uuid)</code> |
| <div class="block">Obtain the workflow run for a given user and name.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="../../../../../org/taverna/server/master/interfaces/TavernaRun.html" title="interface in org.taverna.server.master.interfaces">TavernaRun</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/taverna/server/master/interfaces/RunStore.html#listRuns-org.taverna.server.master.utils.UsernamePrincipal-org.taverna.server.master.interfaces.Policy-">listRuns</a></span>(<a href="../../../../../org/taverna/server/master/utils/UsernamePrincipal.html" title="class in org.taverna.server.master.utils">UsernamePrincipal</a> user, |
| <a href="../../../../../org/taverna/server/master/interfaces/Policy.html" title="interface in org.taverna.server.master.interfaces">Policy</a> p)</code> |
| <div class="block">List the runs that a particular user may access.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="http://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="../../../../../org/taverna/server/master/interfaces/RunStore.html#registerRun-org.taverna.server.master.interfaces.TavernaRun-">registerRun</a></span>(<a href="../../../../../org/taverna/server/master/interfaces/TavernaRun.html" title="interface in org.taverna.server.master.interfaces">TavernaRun</a> run)</code> |
| <div class="block">Adds a workflow instance run to the store.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/taverna/server/master/interfaces/RunStore.html#unregisterRun-java.lang.String-">unregisterRun</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> uuid)</code> |
| <div class="block">Removes a run from the store.</div> |
| </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="getRun-org.taverna.server.master.utils.UsernamePrincipal-org.taverna.server.master.interfaces.Policy-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRun</h4> |
| <pre><a href="../../../../../org/taverna/server/master/interfaces/TavernaRun.html" title="interface in org.taverna.server.master.interfaces">TavernaRun</a> getRun(<a href="../../../../../org/taverna/server/master/utils/UsernamePrincipal.html" title="class in org.taverna.server.master.utils">UsernamePrincipal</a> user, |
| <a href="../../../../../org/taverna/server/master/interfaces/Policy.html" title="interface in org.taverna.server.master.interfaces">Policy</a> p, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> uuid) |
| throws <a href="../../../../../org/taverna/server/master/exceptions/UnknownRunException.html" title="class in org.taverna.server.master.exceptions">UnknownRunException</a></pre> |
| <div class="block">Obtain the workflow run for a given user and name.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>user</code> - Who wants to do the lookup.</dd> |
| <dd><code>p</code> - The general policy system context.</dd> |
| <dd><code>uuid</code> - The handle for the run.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The workflow instance run.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/taverna/server/master/exceptions/UnknownRunException.html" title="class in org.taverna.server.master.exceptions">UnknownRunException</a></code> - If the lookup fails (either because it does not exist or |
| because it is not permitted for the user by the policy).</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getRun-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRun</h4> |
| <pre><a href="../../../../../org/taverna/server/master/interfaces/TavernaRun.html" title="interface in org.taverna.server.master.interfaces">TavernaRun</a> getRun(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> uuid) |
| throws <a href="../../../../../org/taverna/server/master/exceptions/UnknownRunException.html" title="class in org.taverna.server.master.exceptions">UnknownRunException</a></pre> |
| <div class="block">Obtain the named workflow run.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>uuid</code> - The handle for the run.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The workflow instance run.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/taverna/server/master/exceptions/UnknownRunException.html" title="class in org.taverna.server.master.exceptions">UnknownRunException</a></code> - If the lookup fails (either because it does not exist or |
| because it is not permitted for the user by the policy).</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="listRuns-org.taverna.server.master.utils.UsernamePrincipal-org.taverna.server.master.interfaces.Policy-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>listRuns</h4> |
| <pre><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="../../../../../org/taverna/server/master/interfaces/TavernaRun.html" title="interface in org.taverna.server.master.interfaces">TavernaRun</a>> listRuns(<a href="../../../../../org/taverna/server/master/utils/UsernamePrincipal.html" title="class in org.taverna.server.master.utils">UsernamePrincipal</a> user, |
| <a href="../../../../../org/taverna/server/master/interfaces/Policy.html" title="interface in org.taverna.server.master.interfaces">Policy</a> p)</pre> |
| <div class="block">List the runs that a particular user may access.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>user</code> - Who wants to do the lookup, or <code>null</code> if it is |
| being done "by the system" when the full mapping should be |
| returned.</dd> |
| <dd><code>p</code> - The general policy system context.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A mapping from run names to run instances.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="registerRun-org.taverna.server.master.interfaces.TavernaRun-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>registerRun</h4> |
| <pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> registerRun(<a href="../../../../../org/taverna/server/master/interfaces/TavernaRun.html" title="interface in org.taverna.server.master.interfaces">TavernaRun</a> run)</pre> |
| <div class="block">Adds a workflow instance run to the store. Note that this operation is |
| <i>not</i> expected to be security-checked; that is the callers' |
| responsibility.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>run</code> - The run itself.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The name of the run.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="unregisterRun-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>unregisterRun</h4> |
| <pre>void unregisterRun(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> uuid)</pre> |
| <div class="block">Removes a run from the store. Note that this operation is <i>not</i> |
| expected to be security-checked; that is the callers' responsibility.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>uuid</code> - The name of the run.</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/RunStore.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/taverna/server/master/interfaces/Policy.html" title="interface in org.taverna.server.master.interfaces"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/taverna/server/master/interfaces/SecurityContextFactory.html" title="interface in org.taverna.server.master.interfaces"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/taverna/server/master/interfaces/RunStore.html" target="_top">Frames</a></li> |
| <li><a href="RunStore.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 ======= --> |
| <p class="legalCopy"><small>Copyright © 2015–2018 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |