VMware GemFire Java API Reference
Package org.apache.geode.management.api
Interface ClusterManagementServiceTransport
-
- All Known Implementing Classes:
RestTemplateClusterManagementServiceTransport
@Experimental public interface ClusterManagementServiceTransport
Interface which abstracts the transport between the CMS client and the endpoint. Currently only an http implementation exists. However it does allow for different implementations; perhaps something that doesn't useRestTemplate. This interface supports the operations fromClusterManagementService.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidclose()Close the transport.voidconfigureConnection(ConnectionConfig connectionConfig)Configure the transport with using connectionConfig.booleanisConnected()Indicate whether this transport is currently connected<T extends AbstractConfiguration<?>>
ClusterManagementRealizationResultsubmitMessage(T configMessage, CommandType command)Submit a message with a specific command.<T extends AbstractConfiguration<R>,R extends RuntimeInfo>
ClusterManagementGetResult<T,R>submitMessageForGet(T configMessage)Submit a message with a specific command which returns a single result.<A extends ClusterManagementOperation<V>,V extends OperationResult>
ClusterManagementOperationResult<A,V>submitMessageForGetOperation(A opType, java.lang.String operationId)Submit a message for a specific command which returns a single operation in progress.<T extends AbstractConfiguration<R>,R extends RuntimeInfo>
ClusterManagementListResult<T,R>submitMessageForList(T configMessage)Submit a message with a specific command which returns a list result.<A extends ClusterManagementOperation<V>,V extends OperationResult>
ClusterManagementListOperationsResult<A,V>submitMessageForListOperation(A opType)Submit a message for a specific command which returns a list result of operations in progress.<A extends ClusterManagementOperation<V>,V extends OperationResult>
ClusterManagementOperationResult<A,V>submitMessageForStart(A op)Submit a message to start a specific command.
-
-
-
Method Detail
-
submitMessage
<T extends AbstractConfiguration<?>> ClusterManagementRealizationResult submitMessage(T configMessage, CommandType command)
Submit a message with a specific command. This supports theClusterManagementService.create(T)andClusterManagementService.delete(T)commands.- Type Parameters:
T- configuration object which extendsAbstractConfiguration- Parameters:
configMessage- configuration objectcommand- the command to use- Returns:
ClusterManagementRealizationResult
-
submitMessageForList
<T extends AbstractConfiguration<R>,R extends RuntimeInfo> ClusterManagementListResult<T,R> submitMessageForList(T configMessage)
Submit a message with a specific command which returns a list result. This supports theClusterManagementService.list(AbstractConfiguration)command.- Type Parameters:
T- configuration object which extendsAbstractConfigurationR- the type of the corresponding runtime information- Parameters:
configMessage- configuration object- Returns:
ClusterManagementListResult
-
submitMessageForGet
<T extends AbstractConfiguration<R>,R extends RuntimeInfo> ClusterManagementGetResult<T,R> submitMessageForGet(T configMessage)
Submit a message with a specific command which returns a single result. This supports theClusterManagementService.get(T)command.- Type Parameters:
T- configuration object which extendsAbstractConfigurationR- the type of the corresponding runtime information- Parameters:
configMessage- configuration object- Returns:
ClusterManagementGetResult
-
submitMessageForListOperation
<A extends ClusterManagementOperation<V>,V extends OperationResult> ClusterManagementListOperationsResult<A,V> submitMessageForListOperation(A opType)
Submit a message for a specific command which returns a list result of operations in progress. This supports theClusterManagementService.list(ClusterManagementOperation)command.- Type Parameters:
A- operation of typeClusterManagementOperationV- result of typeOperationResult- Parameters:
opType- the operation for which a message should be submitted- Returns:
ClusterManagementListResult
-
submitMessageForGetOperation
<A extends ClusterManagementOperation<V>,V extends OperationResult> ClusterManagementOperationResult<A,V> submitMessageForGetOperation(A opType, java.lang.String operationId)
Submit a message for a specific command which returns a single operation in progress. This supports theClusterManagementService.get(AbstractConfiguration)command.- Type Parameters:
A- operation of typeClusterManagementOperationV- result of typeOperationResult- Parameters:
opType- the operation for which a message should be submittedoperationId- the identifier of the operation- Returns:
ClusterManagementListResult
-
submitMessageForStart
<A extends ClusterManagementOperation<V>,V extends OperationResult> ClusterManagementOperationResult<A,V> submitMessageForStart(A op)
Submit a message to start a specific command. This supports theClusterManagementService.start(ClusterManagementOperation)command.- Type Parameters:
A- operation of typeClusterManagementOperationV- result of typeOperationResult- Parameters:
op- the operation for which a message should be submitted- Returns:
ClusterManagementListResult
-
isConnected
boolean isConnected()
Indicate whether this transport is currently connected- Returns:
- boolean indicating whether connected
-
configureConnection
void configureConnection(ConnectionConfig connectionConfig)
Configure the transport with using connectionConfig.- Parameters:
connectionConfig-ConnectionConfigholding connection configuration information.
-
close
void close()
Close the transport.
-
-