co.cask.coopr.http.handler

Class PluginHandler

java.lang.Object

co.cask.http.AbstractHttpHandler

co.cask.coopr.http.handler.AbstractAuthHandler

co.cask.coopr.http.handler.PluginHandler

All Implemented Interfaces:

co.cask.http.HttpHandler

@Path(value="/v2/plugins")
public class PluginHandler
extends AbstractAuthHandler

Handler for plugin resource related operations, such as uploading resources, staging, and recalling resources, and syncing resources. Only a tenant admin can access these APIs.

Method Summary

Methods

Modifier and Type	Method and Description
void	deleteAutomatorTypeResource(org.jboss.netty.handler.codec.http.HttpRequest request, co.cask.http.HttpResponder responder, String automatortypeId, String resourceType, String resourceName) Delete all versions of the given resource.
void	deleteAutomatorTypeResourceVersion(org.jboss.netty.handler.codec.http.HttpRequest request, co.cask.http.HttpResponder responder, String automatortypeId, String resourceType, String resourceName, String version) Delete a specific version of the given resource.
void	deleteProviderTypeResource(org.jboss.netty.handler.codec.http.HttpRequest request, co.cask.http.HttpResponder responder, String providertypeId, String resourceType, String resourceName) Delete all versions of the given resource.
void	deleteProviderTypeResourceVersion(org.jboss.netty.handler.codec.http.HttpRequest request, co.cask.http.HttpResponder responder, String providertypeId, String resourceType, String resourceName, String version) Delete a specific version of the given resource.
void	getAllAutomatorTypeModules(org.jboss.netty.handler.codec.http.HttpRequest request, co.cask.http.HttpResponder responder, String automatortypeId, String resourceType) Get a mapping of all resources of the given type for the given automator type.
void	getAllAutomatorTypeResourceVersions(org.jboss.netty.handler.codec.http.HttpRequest request, co.cask.http.HttpResponder responder, String automatortypeId, String resourceType, String resourceName) Get a list of all versions of the given resource of the given type for the given automator type.
void	getAllProviderTypeModules(org.jboss.netty.handler.codec.http.HttpRequest request, co.cask.http.HttpResponder responder, String providertypeId, String resourceType) Get a mapping of all resources of the given type for the given provider type.
void	getAllProviderTypeResourceVersions(org.jboss.netty.handler.codec.http.HttpRequest request, co.cask.http.HttpResponder responder, String providertypeId, String resourceType, String resourceName) Get a list of all versions of the given resource of the given type for the given provider type.
void	recallAutomatorTypeModule(org.jboss.netty.handler.codec.http.HttpRequest request, co.cask.http.HttpResponder responder, String automatortypeId, String resourceType, String resourceName, String version) Recall a particular resource version, which means that version of the resource will get removed from provisioners on the next sync call.
void	recallProviderTypeModule(org.jboss.netty.handler.codec.http.HttpRequest request, co.cask.http.HttpResponder responder, String providertypeId, String resourceType, String resourceName, String version) Recall a particular resource version, which means that version of the resource will get removed from provisioners on the next sync call.
void	stageAutomatorTypeModule(org.jboss.netty.handler.codec.http.HttpRequest request, co.cask.http.HttpResponder responder, String automatortypeId, String resourceType, String resourceName, String version) Stage a particular resource version, which means that version of the resource will get pushed to provisioners on the next sync call.
void	stageProviderTypeModule(org.jboss.netty.handler.codec.http.HttpRequest request, co.cask.http.HttpResponder responder, String providertypeId, String resourceType, String resourceName, String version) Stage a particular resource version, which means that version of the resource will get pushed to provisioners on the next sync call.
void	syncPlugins(org.jboss.netty.handler.codec.http.HttpRequest request, co.cask.http.HttpResponder responder) Push staged resources to the provisioners, and remove recalled resources from the provisioners.
co.cask.http.BodyConsumer	uploadAutomatorTypeModule(org.jboss.netty.handler.codec.http.HttpRequest request, co.cask.http.HttpResponder responder, String automatortypeId, String resourceType, String resourceName) Add an automator type resource.
co.cask.http.BodyConsumer	uploadProviderTypeModule(org.jboss.netty.handler.codec.http.HttpRequest request, co.cask.http.HttpResponder responder, String providertypeId, String resourceType, String resourceName) Add a provider type resource.

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

uploadAutomatorTypeModule

@POST
@Path(value="/automatortypes/{automatortype-id}/{resource-type}/{resource-name}")
public co.cask.http.BodyConsumer uploadAutomatorTypeModule(org.jboss.netty.handler.codec.http.HttpRequest request,
                                                            co.cask.http.HttpResponder responder,
                                                            @PathParam(value="automatortype-id")
                                                            String automatortypeId,
                                                            @PathParam(value="resource-type")
                                                            String resourceType,
                                                            @PathParam(value="resource-name")
                                                            String resourceName)

Add an automator type resource. For example, uploading a resource named "hadoop" of resource type "cookbook" for the automator type "chef-solo".

Parameters:

request - Request containing the resource contents

responder - Responder for responding to the request

automatortypeId - Id of the automator type that is having a resource uploaded

resourceType - Type of resource that is being uploaded for the specified automator type

resourceName - Name of the resource being uploaded

Returns:

Body consumer for streaming the contents of the resource to the plugin store

uploadProviderTypeModule

@POST
@Path(value="/providertypes/{providertype-id}/{resource-type}/{resource-name}")
public co.cask.http.BodyConsumer uploadProviderTypeModule(org.jboss.netty.handler.codec.http.HttpRequest request,
                                                           co.cask.http.HttpResponder responder,
                                                           @PathParam(value="providertype-id")
                                                           String providertypeId,
                                                           @PathParam(value="resource-type")
                                                           String resourceType,
                                                           @PathParam(value="resource-name")
                                                           String resourceName)

Add a provider type resource. For example, uploading a resource named "dev" of resource type "keys" for the provider type "openstack".

Parameters:

request - Request containing the resource contents

responder - Responder for responding to the request

providertypeId - Id of the provider type that is having a resource uploaded

resourceType - Type of resource that is being uploaded for the specified provider type

resourceName - Name of the resource being uploaded

Returns:

Body consumer for streaming the contents of the resource to the plugin store

stageAutomatorTypeModule

@POST
@Path(value="/automatortypes/{automatortype-id}/{resource-type}/{resource-name}/versions/{version}/stage")
public void stageAutomatorTypeModule(org.jboss.netty.handler.codec.http.HttpRequest request,
                                      co.cask.http.HttpResponder responder,
                                      @PathParam(value="automatortype-id")
                                      String automatortypeId,
                                      @PathParam(value="resource-type")
                                      String resourceType,
                                      @PathParam(value="resource-name")
                                      String resourceName,
                                      @PathParam(value="version")
                                      String version)

Stage a particular resource version, which means that version of the resource will get pushed to provisioners on the next sync call. Staging one version recalls other versions of the resource.

Parameters:

request - Request to stage a resource

responder - Responder for responding to the request

automatortypeId - Id of the automator type that has the resource

resourceType - Type of resource to stage

resourceName - Name of the resource to stage

version - Version of the resource to stage

stageProviderTypeModule

@POST
@Path(value="/providertypes/{providertype-id}/{resource-type}/{resource-name}/versions/{version}/stage")
public void stageProviderTypeModule(org.jboss.netty.handler.codec.http.HttpRequest request,
                                     co.cask.http.HttpResponder responder,
                                     @PathParam(value="providertype-id")
                                     String providertypeId,
                                     @PathParam(value="resource-type")
                                     String resourceType,
                                     @PathParam(value="resource-name")
                                     String resourceName,
                                     @PathParam(value="version")
                                     String version)

Stage a particular resource version, which means that version of the resource will get pushed to provisioners on the next sync call. Staging one version recalls other versions of the resource.

Parameters:

request - Request to stage a resource

responder - Responder for responding to the request

providertypeId - Id of the provider type that has the resource

resourceType - Type of resource to stage

resourceName - Name of the resource to stage

version - Version of the resource to stage

recallAutomatorTypeModule

@POST
@Path(value="/automatortypes/{automatortype-id}/{resource-type}/{resource-name}/versions/{version}/recall")
public void recallAutomatorTypeModule(org.jboss.netty.handler.codec.http.HttpRequest request,
                                       co.cask.http.HttpResponder responder,
                                       @PathParam(value="automatortype-id")
                                       String automatortypeId,
                                       @PathParam(value="resource-type")
                                       String resourceType,
                                       @PathParam(value="resource-name")
                                       String resourceName,
                                       @PathParam(value="version")
                                       String version)

Recall a particular resource version, which means that version of the resource will get removed from provisioners on the next sync call.

Parameters:

request - Request to recall a resource

responder - Responder for responding to the request

automatortypeId - Id of the automator type that has the resource

resourceType - Type of resource to recall

resourceName - Name of the resource to recall

version - Version of the resource to recall

recallProviderTypeModule

@POST
@Path(value="/providertypes/{providertype-id}/{resource-type}/{resource-name}/versions/{version}/recall")
public void recallProviderTypeModule(org.jboss.netty.handler.codec.http.HttpRequest request,
                                      co.cask.http.HttpResponder responder,
                                      @PathParam(value="providertype-id")
                                      String providertypeId,
                                      @PathParam(value="resource-type")
                                      String resourceType,
                                      @PathParam(value="resource-name")
                                      String resourceName,
                                      @PathParam(value="version")
                                      String version)

Recall a particular resource version, which means that version of the resource will get removed from provisioners on the next sync call.

Parameters:

request - Request to recall a resource

responder - Responder for responding to the request

providertypeId - Id of the provider type that has the resource

resourceType - Type of resource to recall

resourceName - Name of the resource to recall

version - Version of the resource to recall

getAllAutomatorTypeModules

@GET
@Path(value="/automatortypes/{automatortype-id}/{resource-type}")
public void getAllAutomatorTypeModules(org.jboss.netty.handler.codec.http.HttpRequest request,
                                       co.cask.http.HttpResponder responder,
                                       @PathParam(value="automatortype-id")
                                       String automatortypeId,
                                       @PathParam(value="resource-type")
                                       String resourceType)

Get a mapping of all resources of the given type for the given automator type. Request can optionally contain a 'status' http param whose value is one of 'active', 'inactive', 'staged', or 'recalled' to filter the results to only contain resource that have the given status.

Parameters:

request - Request to get resources of the given type

responder - Responder for responding to the request

automatortypeId - Id of the automator type that has the resources

resourceType - Type of resources to get

getAllProviderTypeModules

@GET
@Path(value="/providertypes/{providertype-id}/{resource-type}")
public void getAllProviderTypeModules(org.jboss.netty.handler.codec.http.HttpRequest request,
                                      co.cask.http.HttpResponder responder,
                                      @PathParam(value="providertype-id")
                                      String providertypeId,
                                      @PathParam(value="resource-type")
                                      String resourceType)

Get a mapping of all resources of the given type for the given provider type. Request can optionally contain a 'status' http param whose value is one of 'active', 'inactive', 'staged', or 'recalled' to filter the results to only contain resource that have the given status.

Parameters:

request - Request to get resources of the given type

responder - Responder for responding to the request

providertypeId - Id of the provider type that has the resources

resourceType - Type of resources to get

getAllAutomatorTypeResourceVersions

@GET
@Path(value="/automatortypes/{automatortype-id}/{resource-type}/{resource-name}")
public void getAllAutomatorTypeResourceVersions(org.jboss.netty.handler.codec.http.HttpRequest request,
                                                co.cask.http.HttpResponder responder,
                                                @PathParam(value="automatortype-id")
                                                String automatortypeId,
                                                @PathParam(value="resource-type")
                                                String resourceType,
                                                @PathParam(value="resource-name")
                                                String resourceName)

Get a list of all versions of the given resource of the given type for the given automator type. Request can optionally contain a 'status' http param whose value is one of 'active', 'inactive', 'staged', or 'recalled' to filter the results to only contain resource that have the given status.

Parameters:

request - Request to get resources of the given type

responder - Responder for responding to the request

automatortypeId - Id of the automator type that has the resources

resourceType - Type of resources to get

resourceName - Name of the resources to get

getAllProviderTypeResourceVersions

@GET
@Path(value="/providertypes/{providertype-id}/{resource-type}/{resource-name}")
public void getAllProviderTypeResourceVersions(org.jboss.netty.handler.codec.http.HttpRequest request,
                                               co.cask.http.HttpResponder responder,
                                               @PathParam(value="providertype-id")
                                               String providertypeId,
                                               @PathParam(value="resource-type")
                                               String resourceType,
                                               @PathParam(value="resource-name")
                                               String resourceName)

Get a list of all versions of the given resource of the given type for the given provider type. Request can optionally contain a 'status' http param whose value is one of 'active', 'inactive', 'staged', or 'recalled' to filter the results to only contain resource that have the given status.

Parameters:

request - Request to get resources of the given type

responder - Responder for responding to the request

providertypeId - Id of the provider type that has the resources

resourceType - Type of resources to get

resourceName - Name of the resources to get

deleteAutomatorTypeResource

@DELETE
@Path(value="/automatortypes/{automatortype-id}/{resource-type}/{resource-name}")
public void deleteAutomatorTypeResource(org.jboss.netty.handler.codec.http.HttpRequest request,
                                           co.cask.http.HttpResponder responder,
                                           @PathParam(value="automatortype-id")
                                           String automatortypeId,
                                           @PathParam(value="resource-type")
                                           String resourceType,
                                           @PathParam(value="resource-name")
                                           String resourceName)

Delete all versions of the given resource.

Parameters:

request - Request to delete resources

responder - Responder for responding to the request

automatortypeId - Id of the automator type whose resources should be deleted

resourceType - Type of resources to delete

resourceName - Name of resources to delete

deleteProviderTypeResource

@DELETE
@Path(value="/providertypes/{providertype-id}/{resource-type}/{resource-name}")
public void deleteProviderTypeResource(org.jboss.netty.handler.codec.http.HttpRequest request,
                                          co.cask.http.HttpResponder responder,
                                          @PathParam(value="providertype-id")
                                          String providertypeId,
                                          @PathParam(value="resource-type")
                                          String resourceType,
                                          @PathParam(value="resource-name")
                                          String resourceName)

Delete all versions of the given resource.

Parameters:

request - Request to delete resources

responder - Responder for responding to the request

providertypeId - Id of the provider type whose resources should be deleted

resourceType - Type of resources to delete

resourceName - Name of resources to delete

deleteAutomatorTypeResourceVersion

@DELETE
@Path(value="/automatortypes/{automatortype-id}/{resource-type}/{resource-name}/versions/{version}")
public void deleteAutomatorTypeResourceVersion(org.jboss.netty.handler.codec.http.HttpRequest request,
                                                  co.cask.http.HttpResponder responder,
                                                  @PathParam(value="automatortype-id")
                                                  String automatortypeId,
                                                  @PathParam(value="resource-type")
                                                  String resourceType,
                                                  @PathParam(value="resource-name")
                                                  String resourceName,
                                                  @PathParam(value="version")
                                                  String version)

Delete a specific version of the given resource.

Parameters:

request - Request to delete resource

responder - Responder for responding to the request

automatortypeId - Id of the automator type whose resource should be deleted

resourceType - Type of resource to delete

resourceName - Name of resource to delete

version - Version of resource to delete

deleteProviderTypeResourceVersion

@DELETE
@Path(value="/providertypes/{providertype-id}/{resource-type}/{resource-name}/versions/{version}")
public void deleteProviderTypeResourceVersion(org.jboss.netty.handler.codec.http.HttpRequest request,
                                                 co.cask.http.HttpResponder responder,
                                                 @PathParam(value="providertype-id")
                                                 String providertypeId,
                                                 @PathParam(value="resource-type")
                                                 String resourceType,
                                                 @PathParam(value="resource-name")
                                                 String resourceName,
                                                 @PathParam(value="version")
                                                 String version)

Delete a specific version of the given resource.

Parameters:

request - Request to delete resource

responder - Responder for responding to the request

providertypeId - Id of the provider type whose resource should be deleted

resourceType - Type of resource to delete

resourceName - Name of resource to delete

version - Version of resource to delete

syncPlugins

@POST
@Path(value="/sync")
public void syncPlugins(org.jboss.netty.handler.codec.http.HttpRequest request,
                         co.cask.http.HttpResponder responder)

Push staged resources to the provisioners, and remove recalled resources from the provisioners.

Parameters:

request - Request to sync resources to the provisioners

responder - Responder for responding to the request