org.apache.geode.management.api (Apache Geode 2.0.2)
Description: declaration: package: org.apache.geode.management.api

# Package org.apache.geode.management.api

package org.apache.geode.management.api

- Related Packages
  Package
  Description
  org.apache.geode.management
- Class
  Description
  ClusterManagementException
  Base class of all exceptions thrown by `ClusterManagementService` implementations.
  ClusterManagementGetResult<T extends AbstractConfiguration<R>,R extends RuntimeInfo>
  ClusterManagementListOperationsResult<A extends ClusterManagementOperation<V>,V extends OperationResult>
  returned from `ClusterManagementService.list(ClusterManagementOperation)`
  ClusterManagementListResult<T extends AbstractConfiguration<R>,R extends RuntimeInfo>
  ClusterManagementOperation<V extends OperationResult>
  Interface for cluster management operations that can be used with `ClusterManagementService.start(ClusterManagementOperation)` Classes implementing this interface should hold only the parameters for the operation.
  ClusterManagementOperationResult<A extends ClusterManagementOperation<V>,V extends OperationResult>
  Returned by `ClusterManagementService.start(ClusterManagementOperation)` to convey status of launching the async operation, and by `ClusterManagementService.get(ClusterManagementOperation, String)` to describe the status of a started async operation.
  ClusterManagementRealizationException
  Thrown by `ClusterManagementService.create(AbstractConfiguration)`, update, and delete operations which have a possibility of "partial" failure.
  ClusterManagementRealizationResult
  ClusterManagementResult
  This base class provides the common attributes returned from all `ClusterManagementService` methods
  ClusterManagementResult.StatusCode
  these status codes generally have a one-to-one mapping to the http status code returned by the REST controller
  ClusterManagementService
  Implementations of this interface are responsible for applying and persisting cache configuration changes.
  ClusterManagementServiceTransport
  Interface which abstracts the transport between the CMS client and the endpoint.
  CommandType
  Commands used by `ClusterManagementServiceTransport` which mimic HTTP verbs.
  ConnectionConfig
  Concrete implementation of `ConnectionConfig` which can be used where the various connection properties should be set directly as opposed to being derived from another context such as a `Cache`.
  EntityGroupInfo<T extends AbstractConfiguration<R>,R extends RuntimeInfo>
  A simple object that holds a configuration object and its corresponding runtime info on each member.
  EntityInfo<T extends AbstractConfiguration<R>,R extends RuntimeInfo>
  This holds the configuration of a particular entity in the cluster.
  JsonSerializable
  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
  RealizationResult
  this holds the information returned by the ConfigurationRealizers to indicate the success/failure of the realization step.
  RestTemplateClusterManagementServiceTransport
  Concrete implementation of `ClusterManagementServiceTransport` which uses Spring's `RestTemplate` for communication between client and CMS endpoint.