dataminer-pool-manager/target/apidocs/org/gcube/dataanalysis/dataminer/poolmanager/ansible/AnsibleWorker.html

424 lines
20 KiB
HTML

<!DOCTYPE HTML PUBLIC "-***REMOVED***W3C***REMOVED***DTD HTML 4.01 Transitional***REMOVED***EN" "http:***REMOVED***www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_80) on Fri Mar 03 18:44:18 CET 2017 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>AnsibleWorker (dataminer-pool-manager 1.0.0-SNAPSHOT API)</title>
<meta name="date" content="2017-03-03">
<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) ***REMOVED***
parent.document.title="AnsibleWorker (dataminer-pool-manager 1.0.0-SNAPSHOT API)";
***REMOVED***
***REMOVED***-->
</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/AnsibleWorker.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>Prev Class</li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/gcube/dataanalysis/dataminer/poolmanager/ansible/AnsibleWorker.html" target="_top">Frames</a></li>
<li><a href="AnsibleWorker.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) ***REMOVED***
allClassesLink.style.display = "block";
***REMOVED***
else ***REMOVED***
allClassesLink.style.display = "none";
***REMOVED***
***REMOVED***-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</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.gcube.dataanalysis.dataminer.poolmanager.ansible</div>
<h2 title="Class AnsibleWorker" class="title">Class AnsibleWorker</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http:***REMOVED***download.oracle.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.gcube.dataanalysis.dataminer.poolmanager.ansible.AnsibleWorker</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">AnsibleWorker</span>
extends <a href="http:***REMOVED***download.oracle.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">This class is responsible for the interface with ansible, retrieving log,
etc. etc. It's not supposed to access templates and static stuff files. It
does not know the service datamodel.</div>
<dl><dt><span class="strong">Author:</span></dt>
<dd>paolo</dd></dl>
</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../../org/gcube/dataanalysis/dataminer/poolmanager/ansible/AnsibleWorker.html#AnsibleWorker(java.io.File)">AnsibleWorker</a></strong>(<a href="http:***REMOVED***download.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>&nbsp;root)</code>&nbsp;</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">&nbsp;</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>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/gcube/dataanalysis/dataminer/poolmanager/ansible/AnsibleWorker.html#addRole(org.gcube.dataanalysis.dataminer.poolmanager.ansible.model.Role)">addRole</a></strong>(<a href="../../../../../../org/gcube/dataanalysis/dataminer/poolmanager/ansible/model/Role.html" title="class in org.gcube.dataanalysis.dataminer.poolmanager.ansible.model">Role</a>&nbsp;r)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/gcube/dataanalysis/dataminer/poolmanager/ansible/AnsibleWorker.html#apply()">apply</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/gcube/dataanalysis/dataminer/poolmanager/ansible/AnsibleWorker.html#destroy()">destroy</a></strong>()</code>
<div class="block">Destroy the worker:
- remove the working dir</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/gcube/dataanalysis/dataminer/poolmanager/ansible/AnsibleWorker.html#ensureWorkStructure()">ensureWorkStructure</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http:***REMOVED***download.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/gcube/dataanalysis/dataminer/poolmanager/ansible/AnsibleWorker.html#getInventoryFile()">getInventoryFile</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http:***REMOVED***download.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/gcube/dataanalysis/dataminer/poolmanager/ansible/AnsibleWorker.html#getPlaybookFile()">getPlaybookFile</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http:***REMOVED***download.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/gcube/dataanalysis/dataminer/poolmanager/ansible/AnsibleWorker.html#getRolesDir()">getRolesDir</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http:***REMOVED***download.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/gcube/dataanalysis/dataminer/poolmanager/ansible/AnsibleWorker.html#getWorkdir()">getWorkdir</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http:***REMOVED***download.oracle.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/gcube/dataanalysis/dataminer/poolmanager/ansible/AnsibleWorker.html#getWorkerId()">getWorkerId</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/gcube/dataanalysis/dataminer/poolmanager/ansible/AnsibleWorker.html#removeWorkStructure()">removeWorkStructure</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/gcube/dataanalysis/dataminer/poolmanager/ansible/AnsibleWorker.html#setInventory(org.gcube.dataanalysis.dataminer.poolmanager.ansible.model.Inventory)">setInventory</a></strong>(<a href="../../../../../../org/gcube/dataanalysis/dataminer/poolmanager/ansible/model/Inventory.html" title="class in org.gcube.dataanalysis.dataminer.poolmanager.ansible.model">Inventory</a>&nbsp;inventory)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/gcube/dataanalysis/dataminer/poolmanager/ansible/AnsibleWorker.html#setPlaybook(org.gcube.dataanalysis.dataminer.poolmanager.ansible.model.Playbook)">setPlaybook</a></strong>(<a href="../../../../../../org/gcube/dataanalysis/dataminer/poolmanager/ansible/model/Playbook.html" title="class in org.gcube.dataanalysis.dataminer.poolmanager.ansible.model">Playbook</a>&nbsp;playbook)</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="http:***REMOVED***download.oracle.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:***REMOVED***download.oracle.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:***REMOVED***download.oracle.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:***REMOVED***download.oracle.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:***REMOVED***download.oracle.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:***REMOVED***download.oracle.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:***REMOVED***download.oracle.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:***REMOVED***download.oracle.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:***REMOVED***download.oracle.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:***REMOVED***download.oracle.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:***REMOVED***download.oracle.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:***REMOVED***download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" 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="AnsibleWorker(java.io.File)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>AnsibleWorker</h4>
<pre>public&nbsp;AnsibleWorker(<a href="http:***REMOVED***download.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>&nbsp;root)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getWorkdir()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWorkdir</h4>
<pre>public&nbsp;<a href="http:***REMOVED***download.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>&nbsp;getWorkdir()</pre>
</li>
</ul>
<a name="getRolesDir()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRolesDir</h4>
<pre>public&nbsp;<a href="http:***REMOVED***download.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>&nbsp;getRolesDir()</pre>
</li>
</ul>
<a name="getWorkerId()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWorkerId</h4>
<pre>public&nbsp;<a href="http:***REMOVED***download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getWorkerId()</pre>
</li>
</ul>
<a name="ensureWorkStructure()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ensureWorkStructure</h4>
<pre>public&nbsp;void&nbsp;ensureWorkStructure()</pre>
</li>
</ul>
<a name="removeWorkStructure()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeWorkStructure</h4>
<pre>public&nbsp;void&nbsp;removeWorkStructure()</pre>
</li>
</ul>
<a name="getPlaybookFile()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPlaybookFile</h4>
<pre>public&nbsp;<a href="http:***REMOVED***download.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>&nbsp;getPlaybookFile()</pre>
</li>
</ul>
<a name="getInventoryFile()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInventoryFile</h4>
<pre>public&nbsp;<a href="http:***REMOVED***download.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>&nbsp;getInventoryFile()</pre>
</li>
</ul>
<a name="setInventory(org.gcube.dataanalysis.dataminer.poolmanager.ansible.model.Inventory)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setInventory</h4>
<pre>public&nbsp;void&nbsp;setInventory(<a href="../../../../../../org/gcube/dataanalysis/dataminer/poolmanager/ansible/model/Inventory.html" title="class in org.gcube.dataanalysis.dataminer.poolmanager.ansible.model">Inventory</a>&nbsp;inventory)
throws <a href="http:***REMOVED***download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http:***REMOVED***download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd></dl>
</li>
</ul>
<a name="setPlaybook(org.gcube.dataanalysis.dataminer.poolmanager.ansible.model.Playbook)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPlaybook</h4>
<pre>public&nbsp;void&nbsp;setPlaybook(<a href="../../../../../../org/gcube/dataanalysis/dataminer/poolmanager/ansible/model/Playbook.html" title="class in org.gcube.dataanalysis.dataminer.poolmanager.ansible.model">Playbook</a>&nbsp;playbook)
throws <a href="http:***REMOVED***download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http:***REMOVED***download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd></dl>
</li>
</ul>
<a name="addRole(org.gcube.dataanalysis.dataminer.poolmanager.ansible.model.Role)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addRole</h4>
<pre>public&nbsp;void&nbsp;addRole(<a href="../../../../../../org/gcube/dataanalysis/dataminer/poolmanager/ansible/model/Role.html" title="class in org.gcube.dataanalysis.dataminer.poolmanager.ansible.model">Role</a>&nbsp;r)
throws <a href="http:***REMOVED***download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http:***REMOVED***download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd></dl>
</li>
</ul>
<a name="apply()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>apply</h4>
<pre>public&nbsp;void&nbsp;apply()
throws <a href="http:***REMOVED***download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http:***REMOVED***download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd></dl>
</li>
</ul>
<a name="destroy()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>destroy</h4>
<pre>public&nbsp;void&nbsp;destroy()</pre>
<div class="block">Destroy the worker:
- remove the working dir</div>
</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/AnsibleWorker.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>Prev Class</li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/gcube/dataanalysis/dataminer/poolmanager/ansible/AnsibleWorker.html" target="_top">Frames</a></li>
<li><a href="AnsibleWorker.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) ***REMOVED***
allClassesLink.style.display = "block";
***REMOVED***
else ***REMOVED***
allClassesLink.style.display = "none";
***REMOVED***
***REMOVED***-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</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 &#169; 2017. All Rights Reserved.</small></p>
</body>
</html>