Google Git
Sign in
apache / geode-site / asf-site / . / releases / latest / javadoc / org / apache / geode / management / cli / package-summary.html
blob: 4af0bfa3a40044b77c120e7ff6128201a4c0df42 [file] [log] [blame]
<!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 -->
<title>org.apache.geode.management.cli (Apache Geode 1.15.1)</title>
<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="org.apache.geode.management.cli (Apache Geode 1.15.1)";
}
}
catch(err) {
}
//-->
</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 class="navBarCell1Rev">Package</li>
<li>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="../../../../../org/apache/geode/management/builder/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../org/apache/geode/management/cluster/client/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/geode/management/cli/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.apache.geode.management.cli</h1>
<div class="docSummary">
<div class="block">The Command Line Interface (CLI) package provides a set of APIs for writing commands that can be used to manage and monitor GemFire components.</div>
</div>
<p>See:&nbsp;<a href="#package.description">Description</a></p>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/geode/management/cli/CommandStatement.html" title="interface in org.apache.geode.management.cli">CommandStatement</a></td>
<td class="colLast">Deprecated
<div class="block"><span class="deprecationComment">since Geode 1.3.</span></div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/geode/management/cli/ConverterHint.html" title="interface in org.apache.geode.management.cli">ConverterHint</a></td>
<td class="colLast">
<div class="block">Used in <code>CliOption</code> annotations to indicate which converter(s) should or should not be
used.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/geode/management/cli/Result.html" title="interface in org.apache.geode.management.cli">Result</a></td>
<td class="colLast">
<div class="block">The result of processing a GemFire Command Line Interface (CLI) command string.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/geode/management/cli/UpdateAllConfigurationGroupsMarker.html" title="interface in org.apache.geode.management.cli">UpdateAllConfigurationGroupsMarker</a></td>
<td class="colLast">
<div class="block">This interface is implemented by gfsh commands that can potentially update the configuration for
all groups (including the cluster-wide group, "cluster").</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/geode/management/cli/CliFunction.html" title="class in org.apache.geode.management.cli">CliFunction</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">An abstract function implementation to be extended by cli functions.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/geode/management/cli/CommandService.html" title="class in org.apache.geode.management.cli">CommandService</a></td>
<td class="colLast">Deprecated
<div class="block"><span class="deprecationComment">since 1.3 use OnlineCommandProcessor directly</span></div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/geode/management/cli/GfshCommand.html" title="class in org.apache.geode.management.cli">GfshCommand</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/geode/management/cli/SingleGfshCommand.html" title="class in org.apache.geode.management.cli">SingleGfshCommand</a></td>
<td class="colLast">
<div class="block">Command class that extends this class can only have one single command method,
* i.e only one method that is annotated with @CliCommand.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation">
<caption><span>Enum Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Enum</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/geode/management/cli/Result.Status.html" title="enum in org.apache.geode.management.cli">Result.Status</a></td>
<td class="colLast">
<div class="block">Indicates a Results status.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation">
<caption><span>Exception Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Exception</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/geode/management/cli/CommandProcessingException.html" title="class in org.apache.geode.management.cli">CommandProcessingException</a></td>
<td class="colLast">
<div class="block">Indicates that an exception occurred while processing a GemFire Command Line Interface (CLI)
command.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/geode/management/cli/CommandServiceException.html" title="class in org.apache.geode.management.cli">CommandServiceException</a></td>
<td class="colLast">
<div class="block">Indicates that an exception occurred while accessing/creating a Command Service for processing
GemFire Command Line Interface (CLI) commands.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Annotation Types Summary table, listing annotation types, and an explanation">
<caption><span>Annotation Types Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Annotation Type</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/geode/management/cli/CliMetaData.html" title="annotation in org.apache.geode.management.cli">CliMetaData</a></td>
<td class="colLast">
<div class="block">An annotation to define additional meta-data for commands.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/geode/management/cli/CliMetaData.AvailabilityMetadata.html" title="annotation in org.apache.geode.management.cli">CliMetaData.AvailabilityMetadata</a></td>
<td class="colLast">Deprecated
<div class="block"><span class="deprecationComment">since Geode1.2, not used at all</span></div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/geode/management/cli/Disabled.html" title="annotation in org.apache.geode.management.cli">Disabled</a></td>
<td class="colLast">
<div class="block">This annotation disables a <a href="../../../../../org/apache/geode/management/cli/GfshCommand.html" title="class in org.apache.geode.management.cli"><code>GfshCommand</code></a>
class from being loaded by the
<code>CommandManager</code>
unless the provided flag value exists in the VM's environment.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package org.apache.geode.management.cli Description">Package org.apache.geode.management.cli Description</h2>
<div class="block"><p>The Command Line Interface (CLI) package provides a set of APIs for writing commands that can be used to manage and monitor GemFire components.
This interface is currently used by the GemFire SHell (GFSH) command line utility, but may be used to create custom commands which build upon that functionality.</p></div>
</div>
<!-- ======= 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 class="navBarCell1Rev">Package</li>
<li>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="../../../../../org/apache/geode/management/builder/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../org/apache/geode/management/cluster/client/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/geode/management/cli/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>