| <!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.api (Apache Geode 1.15.0)</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.api (Apache Geode 1.15.0)"; |
| } |
| } |
| 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/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../../org/apache/geode/management/builder/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/geode/management/api/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.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> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <div class="header"> |
| <h1 title="Package" class="title">Package org.apache.geode.management.api</h1> |
| </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"> </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/api/ClusterManagementOperation.html" title="interface in org.apache.geode.management.api">ClusterManagementOperation</a><V extends <a href="../../../../../org/apache/geode/management/runtime/OperationResult.html" title="interface in org.apache.geode.management.runtime">OperationResult</a>></td> |
| <td class="colLast"> |
| <div class="block">Interface for cluster management operations that can be used with |
| <a href="../../../../../org/apache/geode/management/api/ClusterManagementService.html#start-A-"><code>ClusterManagementService.start(ClusterManagementOperation)</code></a> |
| |
| Classes implementing this interface should hold only the parameters for the operation.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/geode/management/api/ClusterManagementService.html" title="interface in org.apache.geode.management.api">ClusterManagementService</a></td> |
| <td class="colLast"> |
| <div class="block">Implementations of this interface are responsible for applying and persisting cache |
| configuration changes.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/geode/management/api/ClusterManagementServiceTransport.html" title="interface in org.apache.geode.management.api">ClusterManagementServiceTransport</a></td> |
| <td class="colLast"> |
| <div class="block">Interface which abstracts the transport between the CMS client and the endpoint.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/geode/management/api/JsonSerializable.html" title="interface in org.apache.geode.management.api">JsonSerializable</a></td> |
| <td class="colLast"> |
| <div class="block">marker interface that allows subclasses to be deserialized correctly |
| note that any class can still be serialized using JSON (without implementing this interface) as |
| long as it has no subclasses</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"> </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/api/ClusterManagementGetResult.html" title="class in org.apache.geode.management.api">ClusterManagementGetResult</a><T extends <a href="../../../../../org/apache/geode/management/configuration/AbstractConfiguration.html" title="class in org.apache.geode.management.configuration">AbstractConfiguration</a><R>,R extends <a href="../../../../../org/apache/geode/management/runtime/RuntimeInfo.html" title="class in org.apache.geode.management.runtime">RuntimeInfo</a>></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/geode/management/api/ClusterManagementListOperationsResult.html" title="class in org.apache.geode.management.api">ClusterManagementListOperationsResult</a><A extends <a href="../../../../../org/apache/geode/management/api/ClusterManagementOperation.html" title="interface in org.apache.geode.management.api">ClusterManagementOperation</a><V>,V extends <a href="../../../../../org/apache/geode/management/runtime/OperationResult.html" title="interface in org.apache.geode.management.runtime">OperationResult</a>></td> |
| <td class="colLast"> |
| <div class="block">returned from <a href="../../../../../org/apache/geode/management/api/ClusterManagementService.html#list-A-"><code>ClusterManagementService.list(ClusterManagementOperation)</code></a></div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/geode/management/api/ClusterManagementListResult.html" title="class in org.apache.geode.management.api">ClusterManagementListResult</a><T extends <a href="../../../../../org/apache/geode/management/configuration/AbstractConfiguration.html" title="class in org.apache.geode.management.configuration">AbstractConfiguration</a><R>,R extends <a href="../../../../../org/apache/geode/management/runtime/RuntimeInfo.html" title="class in org.apache.geode.management.runtime">RuntimeInfo</a>></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/geode/management/api/ClusterManagementOperationResult.html" title="class in org.apache.geode.management.api">ClusterManagementOperationResult</a><A extends <a href="../../../../../org/apache/geode/management/api/ClusterManagementOperation.html" title="interface in org.apache.geode.management.api">ClusterManagementOperation</a><V>,V extends <a href="../../../../../org/apache/geode/management/runtime/OperationResult.html" title="interface in org.apache.geode.management.runtime">OperationResult</a>></td> |
| <td class="colLast"> |
| <div class="block">Returned by |
| <a href="../../../../../org/apache/geode/management/api/ClusterManagementService.html#start-A-"><code>ClusterManagementService.start(ClusterManagementOperation)</code></a> to convey status of |
| launching the async operation, |
| and by <a href="../../../../../org/apache/geode/management/api/ClusterManagementService.html#get-A-java.lang.String-"><code>ClusterManagementService.get(ClusterManagementOperation, String)</code></a> to |
| describe the status of |
| a started async operation.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/geode/management/api/ClusterManagementRealizationResult.html" title="class in org.apache.geode.management.api">ClusterManagementRealizationResult</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/geode/management/api/ClusterManagementResult.html" title="class in org.apache.geode.management.api">ClusterManagementResult</a></td> |
| <td class="colLast"> |
| <div class="block">This base class provides the common attributes returned from all <a href="../../../../../org/apache/geode/management/api/ClusterManagementService.html" title="interface in org.apache.geode.management.api"><code>ClusterManagementService</code></a> |
| methods</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/geode/management/api/ConnectionConfig.html" title="class in org.apache.geode.management.api">ConnectionConfig</a></td> |
| <td class="colLast"> |
| <div class="block">Concrete implementation of <a href="../../../../../org/apache/geode/management/api/ConnectionConfig.html" title="class in org.apache.geode.management.api"><code>ConnectionConfig</code></a> which can be used where the various |
| connection properties should be set directly as opposed to being derived from another context |
| such as a <code>Cache</code>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/geode/management/api/EntityGroupInfo.html" title="class in org.apache.geode.management.api">EntityGroupInfo</a><T extends <a href="../../../../../org/apache/geode/management/configuration/AbstractConfiguration.html" title="class in org.apache.geode.management.configuration">AbstractConfiguration</a><R>,R extends <a href="../../../../../org/apache/geode/management/runtime/RuntimeInfo.html" title="class in org.apache.geode.management.runtime">RuntimeInfo</a>></td> |
| <td class="colLast"> |
| <div class="block">A simple object that holds a configuration object and its corresponding runtime info on each |
| member.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/geode/management/api/EntityInfo.html" title="class in org.apache.geode.management.api">EntityInfo</a><T extends <a href="../../../../../org/apache/geode/management/configuration/AbstractConfiguration.html" title="class in org.apache.geode.management.configuration">AbstractConfiguration</a><R>,R extends <a href="../../../../../org/apache/geode/management/runtime/RuntimeInfo.html" title="class in org.apache.geode.management.runtime">RuntimeInfo</a>></td> |
| <td class="colLast"> |
| <div class="block">This holds the configuration of a particular entity in the cluster.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/geode/management/api/RealizationResult.html" title="class in org.apache.geode.management.api">RealizationResult</a></td> |
| <td class="colLast"> |
| <div class="block">this holds the information returned by the ConfigurationRealizers to indicate the |
| success/failure of the realization step.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/geode/management/api/RestTemplateClusterManagementServiceTransport.html" title="class in org.apache.geode.management.api">RestTemplateClusterManagementServiceTransport</a></td> |
| <td class="colLast"> |
| <div class="block">Concrete implementation of <a href="../../../../../org/apache/geode/management/api/ClusterManagementServiceTransport.html" title="interface in org.apache.geode.management.api"><code>ClusterManagementServiceTransport</code></a> which uses Spring's |
| <code>RestTemplate</code> for communication between client and CMS endpoint.</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"> </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/api/ClusterManagementResult.StatusCode.html" title="enum in org.apache.geode.management.api">ClusterManagementResult.StatusCode</a></td> |
| <td class="colLast"> |
| <div class="block">these status codes generally have a one-to-one mapping to the http status code returned by the |
| REST controller</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/geode/management/api/CommandType.html" title="enum in org.apache.geode.management.api">CommandType</a></td> |
| <td class="colLast"> |
| <div class="block">Commands used by <a href="../../../../../org/apache/geode/management/api/ClusterManagementServiceTransport.html" title="interface in org.apache.geode.management.api"><code>ClusterManagementServiceTransport</code></a> which mimic HTTP verbs.</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"> </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/api/ClusterManagementException.html" title="class in org.apache.geode.management.api">ClusterManagementException</a></td> |
| <td class="colLast"> |
| <div class="block">Base class of all exceptions thrown by <a href="../../../../../org/apache/geode/management/api/ClusterManagementService.html" title="interface in org.apache.geode.management.api"><code>ClusterManagementService</code></a> implementations.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/geode/management/api/ClusterManagementRealizationException.html" title="class in org.apache.geode.management.api">ClusterManagementRealizationException</a></td> |
| <td class="colLast"> |
| <div class="block">Thrown by <a href="../../../../../org/apache/geode/management/api/ClusterManagementService.html#create-T-"><code>ClusterManagementService.create(AbstractConfiguration)</code></a>, update, and delete |
| operations |
| which have a possibility of "partial" failure.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| </ul> |
| </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/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../../org/apache/geode/management/builder/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/geode/management/api/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.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> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
