com.elastisys.scale.cloudpool.api.restapi.impl

Class CloudPoolRestApiImpl

java.lang.Object

com.elastisys.scale.cloudpool.api.restapi.impl.CloudPoolRestApiImpl

All Implemented Interfaces:

CloudPoolRestApi

@Path(value="/")
public class CloudPoolRestApiImpl
extends Object
implements CloudPoolRestApi

/** Implements the cloud pool REST API, which is fully covered in the elastisys:scale cloud pool REST API documentation.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_CONFIG_FILE_NAME Default file name (within the storage directory) in which CloudPool configuration is stored.

Constructor Summary

Constructors

Constructor and Description
CloudPoolRestApiImpl(CloudPool cloudPool, String storageDir) Creates a CloudPoolRestApiImpl that will store set CloudPool configurations under a given storage directory with the DEFAULT_CONFIG_FILE_NAME.
CloudPoolRestApiImpl(CloudPool cloudPool, String storageDir, String configFileName) Creates a CloudPoolRestApiImpl that will store set CloudPool configurations under a given storage directory with a given file name.

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	attachMachine(String machineId) Attaches an already running machine instance to the pool, growing the pool with a new member.
javax.ws.rs.core.Response	detachMachine(String machineId, DetachMachineRequest request) Removes a member from the pool without terminating it.
Path	getCloudPoolConfigPath() Returns the file system path where the CloudPoolRestApiImpl stores received CloudPool configurations.
javax.ws.rs.core.Response	getConfig() Retrieves the configuration currently set for the CloudPool.
javax.ws.rs.core.Response	getPool() Retrieves the current machine pool members.
javax.ws.rs.core.Response	getPoolSize() Returns the current size of the machine pool -- both in terms of the desired size and the actual size (as these may differ at any time).
javax.ws.rs.core.Response	getStatus() Retrieves the execution status for the cloud pool.
javax.ws.rs.core.Response	setConfig(com.google.gson.JsonObject configuration) Sets the configuration for the CloudPool.
javax.ws.rs.core.Response	setDesiredSize(SetDesiredSizeRequest request) Sets the desired number of machines in the machine pool.
javax.ws.rs.core.Response	setMembershipStatus(String machineId, SetMembershipStatusRequest request) Sets the membership status of a given pool member.
javax.ws.rs.core.Response	setServiceState(String machineId, SetServiceStateRequest request) Sets the service state of a given machine pool member.
javax.ws.rs.core.Response	start() Starts the cloud pool.
javax.ws.rs.core.Response	stop() Stops the cloud pool.
void	storeConfig(com.google.gson.JsonObject configuration) Stores a configuration in the storageDir, to allow it to be restored when the CloudPool is restarted.
javax.ws.rs.core.Response	terminateMachine(String machineId, TerminateMachineRequest request) Terminates a particular machine pool member.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_CONFIG_FILE_NAME

public static final String DEFAULT_CONFIG_FILE_NAME

Default file name (within the storage directory) in which CloudPool configuration is stored.

See Also:

Constant Field Values

Constructor Detail

CloudPoolRestApiImpl

public CloudPoolRestApiImpl(CloudPool cloudPool,
                            String storageDir)

Creates a CloudPoolRestApiImpl that will store set CloudPool configurations under a given storage directory with the DEFAULT_CONFIG_FILE_NAME.

Parameters:

cloudPool - The back-end CloudPool that is being managed.

storageDir - The directory path where runtime state for the CloudPool is stored. The CloudPoolRestApiImpl will use this directory to store every set configuration so that it can be restored on restart. The directory will be created if it does not exist.

CloudPoolRestApiImpl

public CloudPoolRestApiImpl(CloudPool cloudPool,
                            String storageDir,
                            String configFileName)

Creates a CloudPoolRestApiImpl that will store set CloudPool configurations under a given storage directory with a given file name.

Parameters:

cloudPool - The back-end CloudPool that is being managed.

storageDir - The directory path where runtime state for the CloudPool is stored. The CloudPoolRestApiImpl will use this directory to store every set configuration so that it can be restored on restart. The directory will be created if it does not exist.

configFileName - The file name, within the storageDir, in which CloudPool configuration is stored.

Method Detail

getConfig

public javax.ws.rs.core.Response getConfig()

Description copied from interface: CloudPoolRestApi

Retrieves the configuration currently set for the CloudPool.

More details can be found in the official API documentation.

Specified by:

getConfig in interface CloudPoolRestApi

Returns:

A response message as per the cloud pool REST API.

setConfig

public javax.ws.rs.core.Response setConfig(com.google.gson.JsonObject configuration)

Description copied from interface: CloudPoolRestApi

Sets the configuration for the CloudPool.

More details can be found in the official API documentation.

Specified by:

setConfig in interface CloudPoolRestApi

Parameters:

configuration - The (JSON) configuration document to set.

Returns:

A response message as per the cloud pool REST API.

start

public javax.ws.rs.core.Response start()

Description copied from interface: CloudPoolRestApi

Starts the cloud pool.

This will set the cloud pool in an activated state where it will start to accept requests to query or modify the machine pool.

If the cloud pool has not been configured the method should fail. If the cloud pool is already started this is a no-op.

More details can be found in the official API documentation.

Specified by:

start in interface CloudPoolRestApi

Returns:

A response message as per the cloud pool REST API.

stop

public javax.ws.rs.core.Response stop()

Description copied from interface: CloudPoolRestApi

Stops the cloud pool.

A stopped cloud pool is in a passivated state and will not accept any requests to query or modify the machine pool.

If the cloud pool is already in a stopped state this is a no-op.

More details can be found in the official API documentation.

Specified by:

stop in interface CloudPoolRestApi

Returns:

A response message as per the cloud pool REST API.

getStatus

public javax.ws.rs.core.Response getStatus()

Description copied from interface: CloudPoolRestApi

Retrieves the execution status for the cloud pool.

More details can be found in the official API documentation.

Specified by:

getStatus in interface CloudPoolRestApi

Returns:

A response message as per the cloud pool REST API.

storeConfig

public void storeConfig(com.google.gson.JsonObject configuration)
                 throws IOException

Stores a configuration in the storageDir, to allow it to be restored when the CloudPool is restarted.

Parameters:

configuration -

Throws:

IOException - If the configuration could not be stored.

getCloudPoolConfigPath

public Path getCloudPoolConfigPath()

Returns the file system path where the CloudPoolRestApiImpl stores received CloudPool configurations.

Parameters:

storageDir -

Returns:

getPool

public javax.ws.rs.core.Response getPool()

Description copied from interface: CloudPoolRestApi

Retrieves the current machine pool members.

More details can be found in the official API documentation.

Specified by:

getPool in interface CloudPoolRestApi

Returns:

A response message as per the cloud pool REST API.

setDesiredSize

public javax.ws.rs.core.Response setDesiredSize(SetDesiredSizeRequest request)

Description copied from interface: CloudPoolRestApi

Sets the desired number of machines in the machine pool. This method is asynchronous in that the method returns immediately without having carried out any required changes to the machine pool.

More details can be found in the official API documentation.

Specified by:

setDesiredSize in interface CloudPoolRestApi

Parameters:

request - A SetDesiredSizeRequest.

Returns:

A response message as per the cloud pool REST API.

getPoolSize

public javax.ws.rs.core.Response getPoolSize()

Description copied from interface: CloudPoolRestApi

Returns the current size of the machine pool -- both in terms of the desired size and the actual size (as these may differ at any time).

More details can be found in the official API documentation.

Specified by:

getPoolSize in interface CloudPoolRestApi

Returns:

A response message as per the cloud pool REST API.

terminateMachine

public javax.ws.rs.core.Response terminateMachine(String machineId,
                                                  TerminateMachineRequest request)

Description copied from interface: CloudPoolRestApi

Terminates a particular machine pool member. The caller can control if a replacement machine is to be provisioned.

More details can be found in the official API documentation.

Specified by:

terminateMachine in interface CloudPoolRestApi

Parameters:

machineId - The identifier of the machine to terminate.

request - A TerminateMachineRequest.

Returns:

A response message as per the cloud pool REST API.

detachMachine

public javax.ws.rs.core.Response detachMachine(String machineId,
                                               DetachMachineRequest request)

Description copied from interface: CloudPoolRestApi

Removes a member from the pool without terminating it. The machine keeps running but is no longer considered a pool member and, therefore, needs to be managed independently. The caller can control if a replacement machine is to be provisioned.

More details can be found in the official API documentation.

Specified by:

detachMachine in interface CloudPoolRestApi

Parameters:

machineId - The identifier of the machine to detach from the pool.

request - A DetachMachineRequest.

Returns:

A response message as per the cloud pool REST API.

attachMachine

public javax.ws.rs.core.Response attachMachine(String machineId)

Description copied from interface: CloudPoolRestApi

Attaches an already running machine instance to the pool, growing the pool with a new member. This operation implies that the desired size of the pool is incremented by one.

More details can be found in the official API documentation.

Specified by:

attachMachine in interface CloudPoolRestApi

Parameters:

machineId - The identifier of the machine to attach to the pool.

Returns:

A response message as per the cloud pool REST API.

setServiceState

public javax.ws.rs.core.Response setServiceState(String machineId,
                                                 SetServiceStateRequest request)

Description copied from interface: CloudPoolRestApi

Sets the service state of a given machine pool member. Setting the service state does not have any functional implications on the pool member, but should be seen as way to supply operational information about the service running on the machine to third-party services (such as load balancers).

More details can be found in the official API documentation.

Specified by:

setServiceState in interface CloudPoolRestApi

Parameters:

machineId - The machine whose service state is to be set.

request - A SetServiceStateRequest.

Returns:

A response message as per the cloud pool REST API.

setMembershipStatus

public javax.ws.rs.core.Response setMembershipStatus(String machineId,
                                                     SetMembershipStatusRequest request)

Description copied from interface: CloudPoolRestApi

Sets the membership status of a given pool member. The membership status for a machine can be set to protect the machine from being terminated (by setting its evictability status) and/or to mark a machine as being in need of replacement by flagging it as an inactive pool member.

More details can be found in the official API documentation.

Specified by:

setMembershipStatus in interface CloudPoolRestApi

Parameters:

machineId - The machine whose service state is to be set.

request - A SetMembershipStatusRequest.

Returns:

A response message as per the cloud pool REST API.