cassandra-server
Version:
A thin Javascript wrapper around Apache Cassandra to provide out of the box server support
541 lines (540 loc) • 19.2 kB
HTML
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_67) on Sun Sep 07 15:29:27 CEST 2014 -->
<title>AbstractJmxClient (apache-cassandra API)</title>
<meta name="date" content="2014-09-07">
<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="AbstractJmxClient (apache-cassandra 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/AbstractJmxClient.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><a href="../../../../org/apache/cassandra/tools/BulkLoader.html" title="class in org.apache.cassandra.tools"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/cassandra/tools/AbstractJmxClient.html" target="_top">Frames</a></li>
<li><a href="AbstractJmxClient.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><a href="#field_summary">Field</a> | </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><a href="#field_detail">Field</a> | </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.cassandra.tools</div>
<h2 title="Class AbstractJmxClient" class="title">Class AbstractJmxClient</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.cassandra.tools.AbstractJmxClient</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Closeable, java.lang.AutoCloseable</dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="strong">AbstractJmxClient</span>
extends java.lang.Object
implements java.io.Closeable</pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected static java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/tools/AbstractJmxClient.html#DEFAULT_HOST">DEFAULT_HOST</a></strong></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected static int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/tools/AbstractJmxClient.html#DEFAULT_JMX_PORT">DEFAULT_JMX_PORT</a></strong></code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/tools/AbstractJmxClient.html#host">host</a></strong></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected org.apache.cassandra.tools.JMXConnection</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/tools/AbstractJmxClient.html#jmxConn">jmxConn</a></strong></code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.io.PrintStream</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/tools/AbstractJmxClient.html#out">out</a></strong></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/tools/AbstractJmxClient.html#password">password</a></strong></code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/tools/AbstractJmxClient.html#port">port</a></strong></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/tools/AbstractJmxClient.html#username">username</a></strong></code> </td>
</tr>
</table>
</li>
</ul>
<!-- ======== 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"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../org/apache/cassandra/tools/AbstractJmxClient.html#AbstractJmxClient(java.lang.String,%20java.lang.Integer,%20java.lang.String,%20java.lang.String)">AbstractJmxClient</a></strong>(java.lang.String host,
java.lang.Integer port,
java.lang.String username,
java.lang.String password)</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </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>static void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/tools/AbstractJmxClient.html#addCmdOption(java.lang.String,%20java.lang.String,%20boolean,%20java.lang.String)">addCmdOption</a></strong>(java.lang.String shortOpt,
java.lang.String longOpt,
boolean hasArg,
java.lang.String description)</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/tools/AbstractJmxClient.html#close()">close</a></strong>()</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/tools/AbstractJmxClient.html#printHelp(java.lang.String,%20java.lang.String)">printHelp</a></strong>(java.lang.String synopsis,
java.lang.String header)</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static org.apache.commons.cli.CommandLine</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/tools/AbstractJmxClient.html#processArguments(java.lang.String[])">processArguments</a></strong>(java.lang.String[] args)</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/tools/AbstractJmxClient.html#setOutput(java.io.PrintStream)">setOutput</a></strong>(java.io.PrintStream out)</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/tools/AbstractJmxClient.html#write(java.lang.String)">write</a></strong>(java.lang.String msg)</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/tools/AbstractJmxClient.html#write(java.lang.String,%20java.lang.Object...)">write</a></strong>(java.lang.String format,
java.lang.Object... args)</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/tools/AbstractJmxClient.html#writeln(java.lang.String)">writeln</a></strong>(java.lang.String msg)</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/tools/AbstractJmxClient.html#writeln(java.lang.String,%20java.lang.Object...)">writeln</a></strong>(java.lang.String format,
java.lang.Object... args)</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/tools/AbstractJmxClient.html#writeln(java.lang.Throwable)">writeln</a></strong>(java.lang.Throwable err)</code> </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.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="DEFAULT_JMX_PORT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_JMX_PORT</h4>
<pre>protected static final int DEFAULT_JMX_PORT</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.cassandra.tools.AbstractJmxClient.DEFAULT_JMX_PORT">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="DEFAULT_HOST">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_HOST</h4>
<pre>protected static final java.lang.String DEFAULT_HOST</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.cassandra.tools.AbstractJmxClient.DEFAULT_HOST">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="host">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>host</h4>
<pre>protected final java.lang.String host</pre>
</li>
</ul>
<a name="port">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>port</h4>
<pre>protected final int port</pre>
</li>
</ul>
<a name="username">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>username</h4>
<pre>protected final java.lang.String username</pre>
</li>
</ul>
<a name="password">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>password</h4>
<pre>protected final java.lang.String password</pre>
</li>
</ul>
<a name="jmxConn">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>jmxConn</h4>
<pre>protected org.apache.cassandra.tools.JMXConnection jmxConn</pre>
</li>
</ul>
<a name="out">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>out</h4>
<pre>protected java.io.PrintStream out</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="AbstractJmxClient(java.lang.String, java.lang.Integer, java.lang.String, java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>AbstractJmxClient</h4>
<pre>public AbstractJmxClient(java.lang.String host,
java.lang.Integer port,
java.lang.String username,
java.lang.String password)
throws java.io.IOException</pre>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="close()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre>public void close()
throws java.io.IOException</pre>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>close</code> in interface <code>java.io.Closeable</code></dd>
<dt><strong>Specified by:</strong></dt>
<dd><code>close</code> in interface <code>java.lang.AutoCloseable</code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd></dl>
</li>
</ul>
<a name="writeln(java.lang.Throwable)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>writeln</h4>
<pre>public void writeln(java.lang.Throwable err)</pre>
</li>
</ul>
<a name="writeln(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>writeln</h4>
<pre>public void writeln(java.lang.String msg)</pre>
</li>
</ul>
<a name="write(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>write</h4>
<pre>public void write(java.lang.String msg)</pre>
</li>
</ul>
<a name="writeln(java.lang.String, java.lang.Object...)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>writeln</h4>
<pre>public void writeln(java.lang.String format,
java.lang.Object... args)</pre>
</li>
</ul>
<a name="write(java.lang.String, java.lang.Object...)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>write</h4>
<pre>public void write(java.lang.String format,
java.lang.Object... args)</pre>
</li>
</ul>
<a name="setOutput(java.io.PrintStream)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setOutput</h4>
<pre>public void setOutput(java.io.PrintStream out)</pre>
</li>
</ul>
<a name="processArguments(java.lang.String[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>processArguments</h4>
<pre>public static org.apache.commons.cli.CommandLine processArguments(java.lang.String[] args)
throws org.apache.commons.cli.ParseException</pre>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code>org.apache.commons.cli.ParseException</code></dd></dl>
</li>
</ul>
<a name="addCmdOption(java.lang.String, java.lang.String, boolean, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addCmdOption</h4>
<pre>public static void addCmdOption(java.lang.String shortOpt,
java.lang.String longOpt,
boolean hasArg,
java.lang.String description)</pre>
</li>
</ul>
<a name="printHelp(java.lang.String, java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>printHelp</h4>
<pre>public static void printHelp(java.lang.String synopsis,
java.lang.String header)</pre>
</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/AbstractJmxClient.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><a href="../../../../org/apache/cassandra/tools/BulkLoader.html" title="class in org.apache.cassandra.tools"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/cassandra/tools/AbstractJmxClient.html" target="_top">Frames</a></li>
<li><a href="AbstractJmxClient.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><a href="#field_summary">Field</a> | </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><a href="#field_detail">Field</a> | </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 © 2014 The Apache Software Foundation</small></p>
</body>
</html>