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 use RestTemplate. This interface supports the operations from ClusterManagementService.

Method Summary

Modifier and Type	Method	Description
void	close()	Close the transport.
void	configureConnection(ConnectionConfig connectionConfig)	Configure the transport with using connectionConfig.
boolean	isConnected()	Indicate whether this transport is currently connected
<T extends AbstractConfiguration<?>> ClusterManagementRealizationResult	submitMessage(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, 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 Details

submitMessage

<T extends AbstractConfiguration<?>>
ClusterManagementRealizationResult submitMessage(T configMessage,
 CommandType command)

Submit a message with a specific command. This supports the ClusterManagementService.create(T) and ClusterManagementService.delete(T) commands.

Type Parameters:

T - configuration object which extends AbstractConfiguration

Parameters:

configMessage - configuration object

command - 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 the ClusterManagementService.list(AbstractConfiguration) command.

Type Parameters:

T - configuration object which extends AbstractConfiguration

R - 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 the ClusterManagementService.get(T) command.

Type Parameters:

T - configuration object which extends AbstractConfiguration

R - 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 the ClusterManagementService.list(ClusterManagementOperation) command.

Type Parameters:

A - operation of type ClusterManagementOperation

V - result of type OperationResult

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,
 String operationId)

Submit a message for a specific command which returns a single operation in progress. This supports the ClusterManagementService.get(AbstractConfiguration) command.

Type Parameters:

A - operation of type ClusterManagementOperation

V - result of type OperationResult

Parameters:

opType - the operation for which a message should be submitted

operationId - 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 the ClusterManagementService.start(ClusterManagementOperation) command.

Type Parameters:

A - operation of type ClusterManagementOperation

V - result of type OperationResult

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 - ConnectionConfig holding connection configuration information.

close

void close()

Close the transport.