Package org.apache.geode.management.api

Interface Summary

Interface	Description
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.
ClusterManagementService	this is responsible for applying and persisting cache configuration changes on locators and/or servers.
CorrespondWith<R extends RuntimeInfo>	provides correlation to the additional object that would be returned with the configuration to indicate runtime information.
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
RestfulEndpoint	a restful service request just needs: 1.

Class Summary

Class	Description
ClusterManagementListOperationsResult<V extends OperationResult>	returned from ClusterManagementService.list(ClusterManagementOperation)
ClusterManagementListResult<T extends CacheElement & CorrespondWith<R>,R extends RuntimeInfo>	returned from ClusterManagementService.list(CacheElement)
ClusterManagementOperationResult<V extends OperationResult>	This is normally returned by ClusterManagementService.start(ClusterManagementOperation) to convey status of launching the async operation, and if successful, the CompletableFuture to access the status, result, and start/end times of the async operation.
ClusterManagementRealizationResult	returned from ClusterManagementService.create(CacheElement) / ClusterManagementService.update(CacheElement) / ClusterManagementService.delete(CacheElement) methods
ClusterManagementResult	This base class provides the common attributes returned from all ClusterManagementService methods
ConfigurationResult<T extends CacheElement & CorrespondWith<R>,R extends RuntimeInfo>	A simple object that holds a configuration object and its corresponding runtime info on each member.
RealizationResult	this holds the information returned by the ConfigurationRealizers to indicate the success/failure of the realization step.

Enum Summary

Enum	Description
ClusterManagementResult.StatusCode	these status codes generally have a one-to-one mapping to the http status code returned by the REST controller

Exception Summary

Exception	Description
ClusterManagementException	Base class of all exceptions thrown by ClusterManagementService implementations.
ClusterManagementRealizationException	Thrown by ClusterManagementService.create(CacheElement), update, and delete operations which have a possibility of "partial" failure.