Sophie

Sophie

distrib > Mageia > 4 > i586 > by-pkgid > ee5115d1de8d9cf1c36a33cc4513700b > files > 431

mx4j-manual-3.0.1-9.mga4.noarch.rpm

<!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_40) on Fri Oct 18 06:47:25 UTC 2013 -->
<title>JythonRunnerMBean (MX4J API)</title>
<meta name="date" content="2013-10-18">
<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="JythonRunnerMBean (MX4J 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/JythonRunnerMBean.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="../../../mx4j/tools/jython/JythonRunner.html" title="class in mx4j.tools.jython"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../mx4j/tools/jython/JythonRunnerMBeanDescription.html" title="class in mx4j.tools.jython"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?mx4j/tools/jython/JythonRunnerMBean.html" target="_top">Frames</a></li>
<li><a href="JythonRunnerMBean.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&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">mx4j.tools.jython</div>
<h2 title="Interface JythonRunnerMBean" class="title">Interface JythonRunnerMBean</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../mx4j/tools/jython/JythonRunner.html" title="class in mx4j.tools.jython">JythonRunner</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">JythonRunnerMBean</span></pre>
<div class="block">Management interface for the JythonRunner MBean.</div>
<dl><dt><span class="strong">Version:</span></dt>
  <dd>$Revision: 1.6 $</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="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>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../mx4j/tools/jython/JythonRunnerMBean.html#getCacheScript()">getCacheScript</a></strong>()</code>
<div class="block">Returns whether the script should be kept in the cache.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../mx4j/tools/jython/JythonRunnerMBean.html#getNotificationType()">getNotificationType</a></strong>()</code>
<div class="block">Gets the specific notification type being listened</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>javax.management.ObjectName</code></td>
<td class="colLast"><code><strong><a href="../../../mx4j/tools/jython/JythonRunnerMBean.html#getObservedObject()">getObservedObject</a></strong>()</code>
<div class="block">Gets the object being observed by this MBean</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../mx4j/tools/jython/JythonRunnerMBean.html#getScript()">getScript</a></strong>()</code>
<div class="block">Returns the script as text.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.net.URL</code></td>
<td class="colLast"><code><strong><a href="../../../mx4j/tools/jython/JythonRunnerMBean.html#getScriptURL()">getScriptURL</a></strong>()</code>
<div class="block">Returns the URL pointing to the script source</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../mx4j/tools/jython/JythonRunnerMBean.html#getUseText()">getUseText</a></strong>()</code>
<div class="block">Indicates wether to use the script given in the ScripText variable or the one given in the script File.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../mx4j/tools/jython/JythonRunnerMBean.html#runScript()">runScript</a></strong>()</code>
<div class="block">Executes a given script.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../mx4j/tools/jython/JythonRunnerMBean.html#setCacheScript(boolean)">setCacheScript</a></strong>(boolean&nbsp;useCache)</code>
<div class="block">Sets whether the script should be kept in the cache.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../mx4j/tools/jython/JythonRunnerMBean.html#setNotificationType(java.lang.String)">setNotificationType</a></strong>(java.lang.String&nbsp;notificationName)</code>
<div class="block">Sets the notification type being listened.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../mx4j/tools/jython/JythonRunnerMBean.html#setObservedObject(javax.management.ObjectName)">setObservedObject</a></strong>(javax.management.ObjectName&nbsp;targetMBeanName)</code>
<div class="block">Sets the object being observed by this MBean.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../mx4j/tools/jython/JythonRunnerMBean.html#setScript(java.lang.String)">setScript</a></strong>(java.lang.String&nbsp;text)</code>
<div class="block">Sets the content of the script.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../mx4j/tools/jython/JythonRunnerMBean.html#setScriptURL(java.net.URL)">setScriptURL</a></strong>(java.net.URL&nbsp;file)</code>
<div class="block">Sets the script source as URL.</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="runScript()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>runScript</h4>
<pre>void&nbsp;runScript()</pre>
<div class="block">Executes a given script.
 If useText is true the text passed will be run as a script otherwise
 the script will be loaded from the URL an executed</div>
</li>
</ul>
<a name="getNotificationType()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNotificationType</h4>
<pre>java.lang.String&nbsp;getNotificationType()</pre>
<div class="block">Gets the specific notification type being listened</div>
</li>
</ul>
<a name="setNotificationType(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setNotificationType</h4>
<pre>void&nbsp;setNotificationType(java.lang.String&nbsp;notificationName)</pre>
<div class="block">Sets the notification type being listened.
 If null any notification will trigger the execution of the script.
 Otherwise only notifications matching notificationName will trigger it</div>
</li>
</ul>
<a name="setObservedObject(javax.management.ObjectName)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setObservedObject</h4>
<pre>void&nbsp;setObservedObject(javax.management.ObjectName&nbsp;targetMBeanName)</pre>
<div class="block">Sets the object being observed by this MBean.
 The MBean will register itself as a listener of targetMBeanName</div>
</li>
</ul>
<a name="getObservedObject()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getObservedObject</h4>
<pre>javax.management.ObjectName&nbsp;getObservedObject()</pre>
<div class="block">Gets the object being observed by this MBean</div>
</li>
</ul>
<a name="getUseText()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUseText</h4>
<pre>boolean&nbsp;getUseText()</pre>
<div class="block">Indicates wether to use the script given in the ScripText variable or the one given in the script File.</div>
</li>
</ul>
<a name="setScript(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setScript</h4>
<pre>void&nbsp;setScript(java.lang.String&nbsp;text)</pre>
<div class="block">Sets the content of the script. If you want to use a file, use ScriptFile instead.</div>
</li>
</ul>
<a name="getScript()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getScript</h4>
<pre>java.lang.String&nbsp;getScript()</pre>
<div class="block">Returns the script as text.</div>
</li>
</ul>
<a name="getScriptURL()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getScriptURL</h4>
<pre>java.net.URL&nbsp;getScriptURL()</pre>
<div class="block">Returns the URL pointing to the script source</div>
</li>
</ul>
<a name="setScriptURL(java.net.URL)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setScriptURL</h4>
<pre>void&nbsp;setScriptURL(java.net.URL&nbsp;file)</pre>
<div class="block">Sets the script source as URL. If the cache script variable is true the file will be loaded only once, otherwise everytime the script is executed</div>
</li>
</ul>
<a name="getCacheScript()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCacheScript</h4>
<pre>boolean&nbsp;getCacheScript()</pre>
<div class="block">Returns whether the script should be kept in the cache.
 If true, no further attempts to read the script will be done afterwards. By default is false</div>
</li>
</ul>
<a name="setCacheScript(boolean)">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setCacheScript</h4>
<pre>void&nbsp;setCacheScript(boolean&nbsp;useCache)</pre>
<div class="block">Sets whether the script should be kept in the cache. If true, no further attempts to read the script will be done afterwards. By default is false</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/JythonRunnerMBean.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="../../../mx4j/tools/jython/JythonRunner.html" title="class in mx4j.tools.jython"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../mx4j/tools/jython/JythonRunnerMBeanDescription.html" title="class in mx4j.tools.jython"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?mx4j/tools/jython/JythonRunnerMBean.html" target="_top">Frames</a></li>
<li><a href="JythonRunnerMBean.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&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><center><small>Copyright &#169; 2001-2005 The MX4J Contributors. All Rights Reserved.</small></center></small></p>
</body>
</html>