co.cask.coopr.http.handler

Class ClusterHandler

java.lang.Object

co.cask.http.AbstractHttpHandler

co.cask.coopr.http.handler.AbstractAuthHandler

co.cask.coopr.http.handler.ClusterHandler

All Implemented Interfaces:

co.cask.http.HttpHandler

@Path(value="/v2/clusters")
public class ClusterHandler
extends AbstractAuthHandler

Handler for performing cluster operations.

Method Summary

Methods

Modifier and Type	Method and Description
void	abortClusterJob(org.jboss.netty.handler.codec.http.HttpRequest request, co.cask.http.HttpResponder responder, String clusterId) Abort the cluster operation that is currently running for the given cluster.
void	addClusterServices(org.jboss.netty.handler.codec.http.HttpRequest request, co.cask.http.HttpResponder responder, String clusterId) Add specific services to a cluster.
void	changeClusterParameter(org.jboss.netty.handler.codec.http.HttpRequest request, co.cask.http.HttpResponder responder, String clusterId) Changes a cluster parameter like lease time.
void	createCluster(org.jboss.netty.handler.codec.http.HttpRequest request, co.cask.http.HttpResponder responder) Create a new cluster.
void	deleteCluster(org.jboss.netty.handler.codec.http.HttpRequest request, co.cask.http.HttpResponder responder, String clusterId) Delete a specific cluster that is deletable by the user.
void	getCluster(org.jboss.netty.handler.codec.http.HttpRequest request, co.cask.http.HttpResponder responder, String clusterId) Get a specific cluster visible to the user.
void	getClusterConfig(org.jboss.netty.handler.codec.http.HttpRequest request, co.cask.http.HttpResponder responder, String clusterId) Get the config used by the cluster.
void	getClusters(org.jboss.netty.handler.codec.http.HttpRequest request, co.cask.http.HttpResponder responder) Get all clusters visible to the user.
void	getClusterServices(org.jboss.netty.handler.codec.http.HttpRequest request, co.cask.http.HttpResponder responder, String clusterId) Get all services on a specific cluster visible to the user.
void	getClusterStatus(org.jboss.netty.handler.codec.http.HttpRequest request, co.cask.http.HttpResponder responder, String clusterId) Get the status of a specific cluster visible to the user.
void	getPlanForJob(org.jboss.netty.handler.codec.http.HttpRequest request, co.cask.http.HttpResponder responder, String clusterId, String planId) Get the task plan for an operation that has taken place or is currently taking place on a cluster.
void	getPlansForCluster(org.jboss.netty.handler.codec.http.HttpRequest request, co.cask.http.HttpResponder responder, String clusterId) Get all plans for cluster operations that have taken place or are currently taking place on a cluster.
void	pauseClusterJob(org.jboss.netty.handler.codec.http.HttpRequest request, co.cask.http.HttpResponder responder, String clusterId) Pause the cluster operation that is currently running for the given cluster.
void	putClusterConfig(org.jboss.netty.handler.codec.http.HttpRequest request, co.cask.http.HttpResponder responder, String clusterId) Overwrite the config used by an active cluster.
void	restartAllClusterServices(org.jboss.netty.handler.codec.http.HttpRequest request, co.cask.http.HttpResponder responder, String clusterId) Restarts all services on the cluster, taking into account service dependencies for order of service stops and starts.
void	restartClusterService(org.jboss.netty.handler.codec.http.HttpRequest request, co.cask.http.HttpResponder responder, String clusterId, String serviceId) Restarts the specified service on the cluster, plus all services that depend on it, taking into account service dependencies for order of service stops and starts.
void	resumeClusterJob(org.jboss.netty.handler.codec.http.HttpRequest request, co.cask.http.HttpResponder responder, String clusterId) Resume the cluster operation that is currently paused for the given cluster.
void	startAllClusterServices(org.jboss.netty.handler.codec.http.HttpRequest request, co.cask.http.HttpResponder responder, String clusterId) Starts all services on the cluster, taking into account service dependencies for order of service starts.
void	startClusterService(org.jboss.netty.handler.codec.http.HttpRequest request, co.cask.http.HttpResponder responder, String clusterId, String serviceId) Starts the specified service, plus all services it depends on, on the cluster.
void	stopAllClusterServices(org.jboss.netty.handler.codec.http.HttpRequest request, co.cask.http.HttpResponder responder, String clusterId) Stops all services on the cluster, taking into account service dependencies for order of service stops.
void	stopClusterService(org.jboss.netty.handler.codec.http.HttpRequest request, co.cask.http.HttpResponder responder, String clusterId, String serviceId) Stops the specified service on the cluster, plus all services that depend on it, taking into account service dependencies for order of service stops.
void	syncClusterTemplate(org.jboss.netty.handler.codec.http.HttpRequest request, co.cask.http.HttpResponder responder, String clusterId) Sync the cluster template of the cluster to the current version of the cluster template.

Methods inherited from class co.cask.coopr.http.handler.AbstractAuthHandler

getAndAuthenticateAccount

Methods inherited from class co.cask.http.AbstractHttpHandler

destroy, init, sendInternalRequest

Methods inherited from class java.lang.Object

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

Method Detail

getClusters

@GET
public void getClusters(org.jboss.netty.handler.codec.http.HttpRequest request,
                   co.cask.http.HttpResponder responder)

Get all clusters visible to the user. Clients can include a status filter as an http param. The key is 'status' and the value is a comma separated list of statuses. Clusters returned must be in one of the statuses given. If no status param is given, all clusters will be returned. Valid values to include in a status filter are any one of Cluster.Status.

Parameters:

request - Request for clusters.

responder - Responder for sending the response.

getCluster

@GET
@Path(value="/{cluster-id}")
public void getCluster(org.jboss.netty.handler.codec.http.HttpRequest request,
                       co.cask.http.HttpResponder responder,
                       @PathParam(value="cluster-id")
                       String clusterId)

Get a specific cluster visible to the user.

Parameters:

request - Request for a cluster.

responder - Responder for sending the response.

clusterId - Id of the cluster to get.

getClusterConfig

@GET
@Path(value="/{cluster-id}/config")
public void getClusterConfig(org.jboss.netty.handler.codec.http.HttpRequest request,
                             co.cask.http.HttpResponder responder,
                             @PathParam(value="cluster-id")
                             String clusterId)

Get the config used by the cluster.

Parameters:

request - Request for config of a cluster.

responder - Responder for sending the response.

clusterId - Id of the cluster containing the config to get.

getClusterServices

@GET
@Path(value="/{cluster-id}/services")
public void getClusterServices(org.jboss.netty.handler.codec.http.HttpRequest request,
                               co.cask.http.HttpResponder responder,
                               @PathParam(value="cluster-id")
                               String clusterId)

Get all services on a specific cluster visible to the user.

Parameters:

request - Request for services on a cluster.

responder - Responder for sending the response.

clusterId - Id of the cluster containing the services to get.

getClusterStatus

@GET
@Path(value="/{cluster-id}/status")
public void getClusterStatus(org.jboss.netty.handler.codec.http.HttpRequest request,
                             co.cask.http.HttpResponder responder,
                             @PathParam(value="cluster-id")
                             String clusterId)

Get the status of a specific cluster visible to the user.

Parameters:

request - Request for cluster status.

responder - Responder for sending the response.

clusterId - Id of the cluster whose status to get.

createCluster

@POST
public void createCluster(org.jboss.netty.handler.codec.http.HttpRequest request,
                      co.cask.http.HttpResponder responder)

Create a new cluster. Body must include a cluster template and a number of machines. Optionally it can include any setting that will override the corresponding template default value.

Parameters:

request - Request to add a cluster.

responder - Responder for sending the response.

deleteCluster

@DELETE
@Path(value="/{cluster-id}")
public void deleteCluster(org.jboss.netty.handler.codec.http.HttpRequest request,
                             co.cask.http.HttpResponder responder,
                             @PathParam(value="cluster-id")
                             String clusterId)

Delete a specific cluster that is deletable by the user.

Parameters:

request - Request to delete cluster.

responder - Responder for sending the response.

clusterId - Id of the cluster to delete.

abortClusterJob

@POST
@Path(value="/{cluster-id}/abort")
public void abortClusterJob(org.jboss.netty.handler.codec.http.HttpRequest request,
                             co.cask.http.HttpResponder responder,
                             @PathParam(value="cluster-id")
                             String clusterId)

Abort the cluster operation that is currently running for the given cluster.

Parameters:

request - Request to abort the cluster operation.

responder - Responder for sending the response.

clusterId - Id of the cluster to abort.

pauseClusterJob

@POST
@Path(value="/{cluster-id}/pause")
public void pauseClusterJob(org.jboss.netty.handler.codec.http.HttpRequest request,
                             co.cask.http.HttpResponder responder,
                             @PathParam(value="cluster-id")
                             String clusterId)

Pause the cluster operation that is currently running for the given cluster.

Parameters:

request - Request to pause the cluster operation.

responder - Responder for sending the response.

clusterId - Id of the cluster to pause.

resumeClusterJob

@POST
@Path(value="/{cluster-id}/resume")
public void resumeClusterJob(org.jboss.netty.handler.codec.http.HttpRequest request,
                              co.cask.http.HttpResponder responder,
                              @PathParam(value="cluster-id")
                              String clusterId)

Resume the cluster operation that is currently paused for the given cluster.

Parameters:

request - Request to resume the cluster operation.

responder - Responder for sending the response.

clusterId - Id of the cluster to resume.

changeClusterParameter

@POST
@Path(value="/{cluster-id}")
public void changeClusterParameter(org.jboss.netty.handler.codec.http.HttpRequest request,
                                    co.cask.http.HttpResponder responder,
                                    @PathParam(value="cluster-id")
                                    String clusterId)

Changes a cluster parameter like lease time.

Parameters:

request - Request to change cluster parameter.

responder - Responder to send the response.

clusterId - Id of the cluster to change.

getPlanForJob

@GET
@Path(value="/{cluster-id}/plans/{plan-id}")
public void getPlanForJob(org.jboss.netty.handler.codec.http.HttpRequest request,
                          co.cask.http.HttpResponder responder,
                          @PathParam(value="cluster-id")
                          String clusterId,
                          @PathParam(value="plan-id")
                          String planId)

Get the task plan for an operation that has taken place or is currently taking place on a cluster.

Parameters:

request - Request for the plan.

responder - Responder to send the response.

clusterId - Id of the cluster whose plan we want to get.

planId - Id of the plan for the cluster.

getPlansForCluster

@GET
@Path(value="/{cluster-id}/plans")
public void getPlansForCluster(org.jboss.netty.handler.codec.http.HttpRequest request,
                               co.cask.http.HttpResponder responder,
                               @PathParam(value="cluster-id")
                               String clusterId)

Get all plans for cluster operations that have taken place or are currently taking place on a cluster.

Parameters:

request - Request for cluster plans.

responder - Responder for sending the response.

clusterId - Id of the cluster whose plans we have to fetch.

putClusterConfig

@PUT
@Path(value="/{cluster-id}/config")
public void putClusterConfig(org.jboss.netty.handler.codec.http.HttpRequest request,
                             co.cask.http.HttpResponder responder,
                             @PathParam(value="cluster-id")
                             String clusterId)

Overwrite the config used by an active cluster. The POST body should contain a "config" key containing the new cluster config. Additionally, the body can contain a "restart" key whose value is true or false, indicating whether or not cluster services should be restarted along with being reconfigured. If restart is not specified, it defaults to true.

Parameters:

request - Request for config of a cluster.

responder - Responder for sending the response.

clusterId - Id of the cluster containing the config to get.

addClusterServices

@POST
@Path(value="/{cluster-id}/services")
public void addClusterServices(org.jboss.netty.handler.codec.http.HttpRequest request,
                                co.cask.http.HttpResponder responder,
                                @PathParam(value="cluster-id")
                                String clusterId)

Add specific services to a cluster. The POST body must be a JSON Object with a 'services' key whose value is a JSON Array of service names. Services must be compatible with the template used when the cluster was created, and any dependencies of services to add must either already be on the cluster, or also in the list of services to add. If any of these rules are violated, a BAD_REQUEST status is returned back. Otherwise, the request to add services is queued up.

Parameters:

request - Request to add services to a cluster.

responder - Responder for sending the response.

clusterId - Id of the cluster to add services to.

startAllClusterServices

@POST
@Path(value="/{cluster-id}/services/start")
public void startAllClusterServices(org.jboss.netty.handler.codec.http.HttpRequest request,
                                     co.cask.http.HttpResponder responder,
                                     @PathParam(value="cluster-id")
                                     String clusterId)

Starts all services on the cluster, taking into account service dependencies for order of service starts.

Parameters:

request - Request to start cluster services.

responder - Responder for sending the response.

clusterId - Id of the cluster whose services should be started.

stopAllClusterServices

@POST
@Path(value="/{cluster-id}/services/stop")
public void stopAllClusterServices(org.jboss.netty.handler.codec.http.HttpRequest request,
                                    co.cask.http.HttpResponder responder,
                                    @PathParam(value="cluster-id")
                                    String clusterId)

Stops all services on the cluster, taking into account service dependencies for order of service stops.

Parameters:

request - Request to stop cluster services.

responder - Responder for sending the response.

clusterId - Id of the cluster whose services should be stopped.

restartAllClusterServices

@POST
@Path(value="/{cluster-id}/services/restart")
public void restartAllClusterServices(org.jboss.netty.handler.codec.http.HttpRequest request,
                                       co.cask.http.HttpResponder responder,
                                       @PathParam(value="cluster-id")
                                       String clusterId)

Restarts all services on the cluster, taking into account service dependencies for order of service stops and starts.

Parameters:

request - Request to restart cluster services.

responder - Responder for sending the response.

clusterId - Id of the cluster whose services should be restarted.

startClusterService

@POST
@Path(value="/{cluster-id}/services/{service-id}/start")
public void startClusterService(org.jboss.netty.handler.codec.http.HttpRequest request,
                                 co.cask.http.HttpResponder responder,
                                 @PathParam(value="cluster-id")
                                 String clusterId,
                                 @PathParam(value="service-id")
                                 String serviceId)

Starts the specified service, plus all services it depends on, on the cluster.

Parameters:

request - Request to start cluster service.

responder - Responder for sending the response.

clusterId - Id of the cluster whose services should be started.

stopClusterService

@POST
@Path(value="/{cluster-id}/services/{service-id}/stop")
public void stopClusterService(org.jboss.netty.handler.codec.http.HttpRequest request,
                                co.cask.http.HttpResponder responder,
                                @PathParam(value="cluster-id")
                                String clusterId,
                                @PathParam(value="service-id")
                                String serviceId)

Stops the specified service on the cluster, plus all services that depend on it, taking into account service dependencies for order of service stops.

Parameters:

request - Request to stop cluster services.

responder - Responder for sending the response.

clusterId - Id of the cluster whose services should be stopped.

restartClusterService

@POST
@Path(value="/{cluster-id}/services/{service-id}/restart")
public void restartClusterService(org.jboss.netty.handler.codec.http.HttpRequest request,
                                   co.cask.http.HttpResponder responder,
                                   @PathParam(value="cluster-id")
                                   String clusterId,
                                   @PathParam(value="service-id")
                                   String serviceId)

Restarts the specified service on the cluster, plus all services that depend on it, taking into account service dependencies for order of service stops and starts.

Parameters:

request - Request to restart cluster service.

responder - Responder for sending the response.

clusterId - Id of the cluster whose service should be restarted.

syncClusterTemplate

@POST
@Path(value="/{cluster-id}/clustertemplate/sync")
public void syncClusterTemplate(org.jboss.netty.handler.codec.http.HttpRequest request,
                                 co.cask.http.HttpResponder responder,
                                 @PathParam(value="cluster-id")
                                 String clusterId)

Sync the cluster template of the cluster to the current version of the cluster template. The cluster must be active in order for this to work, and the cluster must be modifiable by the user making the request.

Parameters:

request - Request to sync the cluster template.

responder - Responder for sending the response.

clusterId - Id of the cluster that should be synced.