| <!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_272) on Thu Nov 12 16:27:25 PST 2020 --> |
| <title>SingleGfshCommand (Apache Geode 1.13.1)</title> |
| <meta name="date" content="2020-11-12"> |
| <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="SingleGfshCommand (Apache Geode 1.13.1)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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="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/cli/Result.Status.html" title="enum in org.apache.geode.management.cli"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/geode/management/cli/UpdateAllConfigurationGroupsMarker.html" title="interface in org.apache.geode.management.cli"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/geode/management/cli/SingleGfshCommand.html" target="_top">Frames</a></li> |
| <li><a href="SingleGfshCommand.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="#fields.inherited.from.class.org.apache.geode.management.cli.GfshCommand">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>Field | </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.geode.management.cli</div> |
| <h2 title="Class SingleGfshCommand" class="title">Class SingleGfshCommand</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/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><a href="../../../../../org/apache/geode/management/cli/GfshCommand.html" title="class in org.apache.geode.management.cli">org.apache.geode.management.cli.GfshCommand</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.geode.management.cli.SingleGfshCommand</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd>org.springframework.shell.core.CommandMarker</dd> |
| </dl> |
| <hr> |
| <br> |
| <pre><a href="../../../../../org/apache/geode/annotations/Experimental.html" title="annotation in org.apache.geode.annotations">@Experimental</a> |
| public abstract class <span class="typeNameLabel">SingleGfshCommand</span> |
| extends <a href="../../../../../org/apache/geode/management/cli/GfshCommand.html" title="class in org.apache.geode.management.cli">GfshCommand</a></pre> |
| <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> |
| </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> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.geode.management.cli.GfshCommand"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.geode.management.cli.<a href="../../../../../org/apache/geode/management/cli/GfshCommand.html" title="class in org.apache.geode.management.cli">GfshCommand</a></h3> |
| <code><a href="../../../../../org/apache/geode/management/cli/GfshCommand.html#EXPERIMENTAL">EXPERIMENTAL</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" 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><span class="memberNameLink"><a href="../../../../../org/apache/geode/management/cli/SingleGfshCommand.html#SingleGfshCommand--">SingleGfshCommand</a></span>()</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="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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/management/cli/SingleGfshCommand.html#updateConfigForGroup-java.lang.String-org.apache.geode.cache.configuration.CacheConfig-java.lang.Object-">updateConfigForGroup</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> group, |
| <a href="../../../../../org/apache/geode/cache/configuration/CacheConfig.html" title="class in org.apache.geode.cache.configuration">CacheConfig</a> config, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> configObject)</code> |
| <div class="block">Implement this method for updating the configuration of a given group |
| |
| the implementation should update the passed in config object with appropriate changes if for |
| any reason config can't be updated.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.geode.management.cli.GfshCommand"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.geode.management.cli.<a href="../../../../../org/apache/geode/management/cli/GfshCommand.html" title="class in org.apache.geode.management.cli">GfshCommand</a></h3> |
| <code><a href="../../../../../org/apache/geode/management/cli/GfshCommand.html#authorize-org.apache.geode.security.ResourcePermission.Resource-org.apache.geode.security.ResourcePermission.Operation-org.apache.geode.security.ResourcePermission.Target-">authorize</a>, <a href="../../../../../org/apache/geode/management/cli/GfshCommand.html#authorize-org.apache.geode.security.ResourcePermission.Resource-org.apache.geode.security.ResourcePermission.Operation-java.lang.String-">authorize</a>, <a href="../../../../../org/apache/geode/management/cli/GfshCommand.html#authorize-org.apache.geode.security.ResourcePermission.Resource-org.apache.geode.security.ResourcePermission.Operation-java.lang.String-java.lang.String-">authorize</a>, <a href="../../../../../org/apache/geode/management/cli/GfshCommand.html#executeAndGetFunctionResult-org.apache.geode.cache.execute.Function-java.lang.Object-java.util.Set-">executeAndGetFunctionResult</a>, <a href="../../../../../org/apache/geode/management/cli/GfshCommand.html#executeFunction-org.apache.geode.cache.execute.Function-java.lang.Object-org.apache.geode.distributed.DistributedMember-">executeFunction</a>, <a href="../../../../../org/apache/geode/management/cli/GfshCommand.html#executeFunction-org.apache.geode.cache.execute.Function-java.lang.Object-java.util.Set-">executeFunction</a>, <a href="../../../../../org/apache/geode/management/cli/GfshCommand.html#executeFunctionAndGetFunctionResult-org.apache.geode.cache.execute.Function-java.lang.Object-org.apache.geode.distributed.DistributedMember-">executeFunctionAndGetFunctionResult</a>, <a href="../../../../../org/apache/geode/management/cli/GfshCommand.html#findAnyMembersForRegion-java.lang.String-">findAnyMembersForRegion</a>, <a href="../../../../../org/apache/geode/management/cli/GfshCommand.html#findMember-java.lang.String-">findMember</a>, <a href="../../../../../org/apache/geode/management/cli/GfshCommand.html#findMembers-java.lang.String:A-java.lang.String:A-">findMembers</a>, <a href="../../../../../org/apache/geode/management/cli/GfshCommand.html#findMembersForRegion-java.lang.String-">findMembersForRegion</a>, <a href="../../../../../org/apache/geode/management/cli/GfshCommand.html#findMembersIncludingLocators-java.lang.String:A-java.lang.String:A-">findMembersIncludingLocators</a>, <a href="../../../../../org/apache/geode/management/cli/GfshCommand.html#getAllMembers--">getAllMembers</a>, <a href="../../../../../org/apache/geode/management/cli/GfshCommand.html#getAllNormalMembers--">getAllNormalMembers</a>, <a href="../../../../../org/apache/geode/management/cli/GfshCommand.html#getCache--">getCache</a>, <a href="../../../../../org/apache/geode/management/cli/GfshCommand.html#getClusterManagementService--">getClusterManagementService</a>, <a href="../../../../../org/apache/geode/management/cli/GfshCommand.html#getConfigurationPersistenceService--">getConfigurationPersistenceService</a>, <a href="../../../../../org/apache/geode/management/cli/GfshCommand.html#getManagementService--">getManagementService</a>, <a href="../../../../../org/apache/geode/management/cli/GfshCommand.html#getMember-java.lang.String-">getMember</a>, <a href="../../../../../org/apache/geode/management/cli/GfshCommand.html#getMembers-java.lang.String:A-java.lang.String:A-">getMembers</a>, <a href="../../../../../org/apache/geode/management/cli/GfshCommand.html#getMembersFunctionExecutor-java.util.Set-">getMembersFunctionExecutor</a>, <a href="../../../../../org/apache/geode/management/cli/GfshCommand.html#getMembersIncludingLocators-java.lang.String:A-java.lang.String:A-">getMembersIncludingLocators</a>, <a href="../../../../../org/apache/geode/management/cli/GfshCommand.html#getNormalMembersWithSameOrNewerVersion-org.apache.geode.internal.serialization.Version-">getNormalMembersWithSameOrNewerVersion</a>, <a href="../../../../../org/apache/geode/management/cli/GfshCommand.html#getSubject--">getSubject</a>, <a href="../../../../../org/apache/geode/management/cli/GfshCommand.html#isOnlineCommandAvailable--">isOnlineCommandAvailable</a>, <a href="../../../../../org/apache/geode/management/cli/GfshCommand.html#isSharedConfigurationRunning--">isSharedConfigurationRunning</a>, <a href="../../../../../org/apache/geode/management/cli/GfshCommand.html#poll-long-java.util.concurrent.TimeUnit-java.util.function.Supplier-">poll</a>, <a href="../../../../../org/apache/geode/management/cli/GfshCommand.html#setCache-org.apache.geode.cache.Cache-">setCache</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" 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="SingleGfshCommand--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>SingleGfshCommand</h4> |
| <pre>public SingleGfshCommand()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="updateConfigForGroup-java.lang.String-org.apache.geode.cache.configuration.CacheConfig-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>updateConfigForGroup</h4> |
| <pre>public boolean updateConfigForGroup(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> group, |
| <a href="../../../../../org/apache/geode/cache/configuration/CacheConfig.html" title="class in org.apache.geode.cache.configuration">CacheConfig</a> config, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> configObject)</pre> |
| <div class="block">Implement this method for updating the configuration of a given group |
| |
| the implementation should update the passed in config object with appropriate changes if for |
| any reason config can't be updated. throw a RuntimeException stating the reason.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>group</code> - the name of the group to update cluster config for</dd> |
| <dd><code>config</code> - the configuration object, never null</dd> |
| <dd><code>configObject</code> - the return value of CommandResult.getConfigObject. CommandResult is the |
| return value of your command method.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a boolean indicating whether a change to the cluster configuration was persisted.</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="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/cli/Result.Status.html" title="enum in org.apache.geode.management.cli"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/geode/management/cli/UpdateAllConfigurationGroupsMarker.html" title="interface in org.apache.geode.management.cli"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/geode/management/cli/SingleGfshCommand.html" target="_top">Frames</a></li> |
| <li><a href="SingleGfshCommand.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="#fields.inherited.from.class.org.apache.geode.management.cli.GfshCommand">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>Field | </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 ======= --> |
| </body> |
| </html> |