io.cdap.wrangler.service.directive

Class DirectivesHandler

java.lang.Object

io.cdap.cdap.internal.api.AbstractProgramDatasetConfigurable<T>

io.cdap.cdap.internal.api.AbstractPluginConfigurable<V>

io.cdap.cdap.api.service.http.AbstractHttpServiceHandler<io.cdap.cdap.api.service.http.SystemHttpServiceContext,io.cdap.cdap.api.service.http.SystemHttpServiceConfigurer>

io.cdap.cdap.api.service.http.AbstractSystemHttpServiceHandler

io.cdap.wrangler.service.common.AbstractWranglerHandler

io.cdap.wrangler.service.directive.DirectivesHandler

All Implemented Interfaces:

io.cdap.cdap.api.ProgramLifecycle<io.cdap.cdap.api.service.http.SystemHttpServiceContext>, io.cdap.cdap.api.service.http.HttpServiceHandler<io.cdap.cdap.api.service.http.SystemHttpServiceContext,io.cdap.cdap.api.service.http.SystemHttpServiceConfigurer>

public class DirectivesHandler
extends AbstractWranglerHandler

Service for managing workspaces and also application of directives on to the workspace.

Nested Class Summary

Nested classes/interfaces inherited from class io.cdap.wrangler.service.common.AbstractWranglerHandler

AbstractWranglerHandler.NamespacedResponder<T>

Constructor Summary

Constructors

Constructor and Description
DirectivesHandler()

Method Summary

Modifier and Type	Method and Description
void	artifacts(io.cdap.cdap.api.service.http.HttpServiceRequest request, io.cdap.cdap.api.service.http.HttpServiceResponder responder, String namespace) This HTTP endpoint is used to retrieve artifacts that include plugins of type Directive.Type (directive).
void	capabilities(io.cdap.cdap.api.service.http.HttpServiceRequest request, io.cdap.cdap.api.service.http.HttpServiceResponder responder) Generates the capability matrix, with versions and build number.
void	charsets(io.cdap.cdap.api.service.http.HttpServiceRequest request, io.cdap.cdap.api.service.http.HttpServiceResponder responder) Extracts the charsets supported.
void	create(io.cdap.cdap.api.service.http.HttpServiceRequest request, io.cdap.cdap.api.service.http.HttpServiceResponder responder, String namespace, String id, String name, String scope) Creates a workspace.
void	delete(io.cdap.cdap.api.service.http.HttpServiceRequest request, io.cdap.cdap.api.service.http.HttpServiceResponder responder, String namespace, String id) Deletes the workspace.
void	deleteGroup(io.cdap.cdap.api.service.http.HttpServiceRequest request, io.cdap.cdap.api.service.http.HttpServiceResponder responder, String namespace, String group) Deletes the workspace.
void	destroy() Closes the resources help by the composite registry.
void	directives(io.cdap.cdap.api.service.http.HttpServiceRequest request, io.cdap.cdap.api.service.http.HttpServiceResponder responder, String namespace) This HTTP endpoint is used to retrieve plugins that are of type Directive.Type (directive).
void	directivesReload(io.cdap.cdap.api.service.http.HttpServiceRequest request, io.cdap.cdap.api.service.http.HttpServiceResponder responder, String namespace) This HTTP endpoint is used to reload the plugins that are of type Directive.Type (directive).
void	execute(io.cdap.cdap.api.service.http.HttpServiceRequest request, io.cdap.cdap.api.service.http.HttpServiceResponder responder, String namespace, String id) Executes the directives on the record stored in the workspace.
void	get(io.cdap.cdap.api.service.http.HttpServiceRequest request, io.cdap.cdap.api.service.http.HttpServiceResponder responder, String namespace, String id) Get information about the workspace.
void	getConfig(io.cdap.cdap.api.service.http.HttpServiceRequest request, io.cdap.cdap.api.service.http.HttpServiceResponder responder) Updates the configuration.
void	healthCheck(io.cdap.cdap.api.service.http.HttpServiceRequest request, io.cdap.cdap.api.service.http.HttpServiceResponder responder)
void	initialize(io.cdap.cdap.api.service.http.SystemHttpServiceContext context)
void	list(io.cdap.cdap.api.service.http.HttpServiceRequest request, io.cdap.cdap.api.service.http.HttpServiceResponder responder, String namespace, String scope) Lists all workspaces.
void	schema(io.cdap.cdap.api.service.http.HttpServiceRequest request, io.cdap.cdap.api.service.http.HttpServiceResponder responder, String namespace, String id)
void	summary(io.cdap.cdap.api.service.http.HttpServiceRequest request, io.cdap.cdap.api.service.http.HttpServiceResponder responder, String namespace, String id) Summarizes the workspace by running directives.
void	upload(io.cdap.cdap.api.service.http.HttpServiceRequest request, io.cdap.cdap.api.service.http.HttpServiceResponder responder, String namespace) Upload data to the workspace, the workspace is created automatically on fly.
void	uploadConfig(io.cdap.cdap.api.service.http.HttpServiceRequest request, io.cdap.cdap.api.service.http.HttpServiceResponder responder) Updates the configuration.
void	uploadData(io.cdap.cdap.api.service.http.HttpServiceRequest request, io.cdap.cdap.api.service.http.HttpServiceResponder responder, String namespace, String id) Upload data to the workspace.
void	usage(io.cdap.cdap.api.service.http.HttpServiceRequest request, io.cdap.cdap.api.service.http.HttpServiceResponder responder, String namespace) This REST API returns an array of all the directives, their usage and description.

Methods inherited from class io.cdap.wrangler.service.common.AbstractWranglerHandler

getConnection, getValidatedConnection, getValidatedConnection, getWorkspace, respond, respond, shouldCopyHeader

Methods inherited from class io.cdap.cdap.api.service.http.AbstractSystemHttpServiceHandler

createTable

Methods inherited from class io.cdap.cdap.api.service.http.AbstractHttpServiceHandler

configure, configure, getConfigurer, getContext, setProperties

Methods inherited from class io.cdap.cdap.internal.api.AbstractPluginConfigurable

usePlugin, usePlugin, usePluginClass, usePluginClass

Methods inherited from class io.cdap.cdap.internal.api.AbstractProgramDatasetConfigurable

addDatasetModule, addDatasetType, createDataset, createDataset, createDataset, createDataset

Methods inherited from class java.lang.Object

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

Constructor Detail

DirectivesHandler

public DirectivesHandler()

Method Detail

initialize

public void initialize(io.cdap.cdap.api.service.http.SystemHttpServiceContext context)
                throws Exception

Specified by:

initialize in interface io.cdap.cdap.api.ProgramLifecycle<io.cdap.cdap.api.service.http.SystemHttpServiceContext>

Specified by:

initialize in interface io.cdap.cdap.api.service.http.HttpServiceHandler<io.cdap.cdap.api.service.http.SystemHttpServiceContext,io.cdap.cdap.api.service.http.SystemHttpServiceConfigurer>

Overrides:

initialize in class io.cdap.cdap.api.service.http.AbstractHttpServiceHandler<io.cdap.cdap.api.service.http.SystemHttpServiceContext,io.cdap.cdap.api.service.http.SystemHttpServiceConfigurer>

Throws:

Exception

destroy

public void destroy()

Closes the resources help by the composite registry.

Specified by:

destroy in interface io.cdap.cdap.api.ProgramLifecycle<io.cdap.cdap.api.service.http.SystemHttpServiceContext>

Specified by:

destroy in interface io.cdap.cdap.api.service.http.HttpServiceHandler<io.cdap.cdap.api.service.http.SystemHttpServiceContext,io.cdap.cdap.api.service.http.SystemHttpServiceConfigurer>

Overrides:

destroy in class io.cdap.cdap.api.service.http.AbstractHttpServiceHandler<io.cdap.cdap.api.service.http.SystemHttpServiceContext,io.cdap.cdap.api.service.http.SystemHttpServiceConfigurer>

healthCheck

@GET
 @Path(value="health")
public void healthCheck(io.cdap.cdap.api.service.http.HttpServiceRequest request,
                                                    io.cdap.cdap.api.service.http.HttpServiceResponder responder)

create

@PUT
 @Path(value="contexts/{context}/workspaces/{id}")
public void create(io.cdap.cdap.api.service.http.HttpServiceRequest request,
                                                                           io.cdap.cdap.api.service.http.HttpServiceResponder responder,
                                                                           @PathParam(value="context")
                                                                           String namespace,
                                                                           @PathParam(value="id")
                                                                           String id,
                                                                           @QueryParam(value="name")
                                                                           String name,
                                                                           @QueryParam(value="scope") @DefaultValue(value="default")
                                                                           String scope)

Creates a workspace. Following is the response { "status" : 200, "message" : Successfully created workspace 'test'. }

Parameters:

request - Handler for incoming request.

responder - Responder for data going out.

id - of workspace to be created.

name - of workspace to be created.

list

@GET
 @Path(value="contexts/{context}/workspaces")
public void list(io.cdap.cdap.api.service.http.HttpServiceRequest request,
                                                                    io.cdap.cdap.api.service.http.HttpServiceResponder responder,
                                                                    @PathParam(value="context")
                                                                    String namespace,
                                                                    @QueryParam(value="scope") @DefaultValue(value="default")
                                                                    String scope)

Lists all workspaces. Following is a response returned { "status" : 200, "message" : "Success", "count" : 4, "values" : [ { "id" : "ABC", "name" : "body"}, { "id" : "XYZ", "name" : "ws"}, { "id" : "123", "name" : "test"}, { "id" : "UVW", "name" : "foo"} ] }

Parameters:

request - Handler for incoming request.

responder - Responder for data going out.

delete

@DELETE
 @Path(value="contexts/{context}/workspaces/{id}")
public void delete(io.cdap.cdap.api.service.http.HttpServiceRequest request,
                                                                              io.cdap.cdap.api.service.http.HttpServiceResponder responder,
                                                                              @PathParam(value="context")
                                                                              String namespace,
                                                                              @PathParam(value="id")
                                                                              String id)

Deletes the workspace. Following is the response { "status" : 200, "message" : Successfully deleted workspace 'test'. }

Parameters:

request - Handler for incoming request.

responder - Responder for data going out.

id - Workspace to deleted.

deleteGroup

@DELETE
 @Path(value="contexts/{context}/workspaces/")
public void deleteGroup(io.cdap.cdap.api.service.http.HttpServiceRequest request,
                                                                               io.cdap.cdap.api.service.http.HttpServiceResponder responder,
                                                                               @PathParam(value="context")
                                                                               String namespace,
                                                                               @QueryParam(value="group")
                                                                               String group)

Deletes the workspace. Following is the response { "status" : 200, "message" : Successfully deleted workspace 'test'. }

Parameters:

request - Handler for incoming request.

responder - Responder for data going out.

group - Group of workspaces.

get

@GET
 @Path(value="contexts/{context}/workspaces/{id}")
public void get(io.cdap.cdap.api.service.http.HttpServiceRequest request,
                                                                        io.cdap.cdap.api.service.http.HttpServiceResponder responder,
                                                                        @PathParam(value="context")
                                                                        String namespace,
                                                                        @PathParam(value="id")
                                                                        String id)

Get information about the workspace. Following is the response { "status" : 200, "message" : "Success", "count" : 1, "values" : [ { "workspace" : "data", "created" : 1430202202, "recipe" : [ "parse-as-csv data ,", "drop data" ], "properties" : { { "key" : "value"}, { "key" : "value"} } } ] }

Parameters:

request - Handler for incoming request.

responder - Responder for data going out.

id - Workspace to deleted.

upload

@POST
 @Path(value="contexts/{context}/workspaces")
public void upload(io.cdap.cdap.api.service.http.HttpServiceRequest request,
                                                                       io.cdap.cdap.api.service.http.HttpServiceResponder responder,
                                                                       @PathParam(value="context")
                                                                       String namespace)

Upload data to the workspace, the workspace is created automatically on fly.

Parameters:

request - Handler for incoming request.

responder - Responder for data going out.

uploadData

@POST
 @Path(value="contexts/{context}/workspaces/{id}/upload")
public void uploadData(io.cdap.cdap.api.service.http.HttpServiceRequest request,
                                                                                       io.cdap.cdap.api.service.http.HttpServiceResponder responder,
                                                                                       @PathParam(value="context")
                                                                                       String namespace,
                                                                                       @PathParam(value="id")
                                                                                       String id)

Upload data to the workspace.

Parameters:

request - Handler for incoming request.

responder - Responder for data going out.

id - Upload data to the workspace.

execute

@POST
 @Path(value="contexts/{context}/workspaces/{id}/execute")
public void execute(io.cdap.cdap.api.service.http.HttpServiceRequest request,
                                                                                     io.cdap.cdap.api.service.http.HttpServiceResponder responder,
                                                                                     @PathParam(value="context")
                                                                                     String namespace,
                                                                                     @PathParam(value="id")
                                                                                     String id)

Executes the directives on the record stored in the workspace. Following is the response from this request { "status" : 200, "message" : "Success", "count" : 2, "header" : [ "a", "b", "c", "d" ], "value" : [ { record 1}, { record 2} ] }

Parameters:

request - to gather information of the request.

responder - to respond to the service request.

id - workspace in which the directives are executed.

summary

@POST
 @Path(value="contexts/{context}/workspaces/{id}/summary")
public void summary(io.cdap.cdap.api.service.http.HttpServiceRequest request,
                                                                                     io.cdap.cdap.api.service.http.HttpServiceResponder responder,
                                                                                     @PathParam(value="context")
                                                                                     String namespace,
                                                                                     @PathParam(value="id")
                                                                                     String id)

Summarizes the workspace by running directives.

Parameters:

request - Handler for incoming request.

responder - Responder for data going out.

id - Workspace data to be summarized.

schema

@POST
 @Path(value="contexts/{context}/workspaces/{id}/schema")
public void schema(io.cdap.cdap.api.service.http.HttpServiceRequest request,
                                                                                   io.cdap.cdap.api.service.http.HttpServiceResponder responder,
                                                                                   @PathParam(value="context")
                                                                                   String namespace,
                                                                                   @PathParam(value="id")
                                                                                   String id)

capabilities

@GET
 @Path(value="info")
public void capabilities(io.cdap.cdap.api.service.http.HttpServiceRequest request,
                                                   io.cdap.cdap.api.service.http.HttpServiceResponder responder)

Generates the capability matrix, with versions and build number.

Parameters:

request - Handler for incoming request.

responder - Responder for data going out.

usage

@GET
 @Path(value="contexts/{context}/usage")
public void usage(io.cdap.cdap.api.service.http.HttpServiceRequest request,
                                                                io.cdap.cdap.api.service.http.HttpServiceResponder responder,
                                                                @PathParam(value="context")
                                                                String namespace)

This REST API returns an array of all the directives, their usage and description. Following is the response of this call. { "status": "OK", "message": "Success", "count" : 10, "values" : [ { "directive" : "parse-as-csv", "usage" : "parse-as-csv ", "description" : "Parses as CSV ..." }, ... ] }

Parameters:

request - to gather information of the request.

responder - to respond to the service request.

artifacts

@GET
 @Path(value="contexts/{context}/artifacts")
public void artifacts(io.cdap.cdap.api.service.http.HttpServiceRequest request,
                                                                        io.cdap.cdap.api.service.http.HttpServiceResponder responder,
                                                                        @PathParam(value="context")
                                                                        String namespace)

This HTTP endpoint is used to retrieve artifacts that include plugins of type Directive.Type (directive). Artifact will be reported if it atleast has one plugin that is of type "directive".

directives

@GET
 @Path(value="contexts/{context}/directives")
public void directives(io.cdap.cdap.api.service.http.HttpServiceRequest request,
                                                                          io.cdap.cdap.api.service.http.HttpServiceResponder responder,
                                                                          @PathParam(value="context")
                                                                          String namespace)

This HTTP endpoint is used to retrieve plugins that are of type Directive.Type (directive). Artifact will be reported if it atleast has one plugin that is of type "directive". TODO: (CDAP-14694) Doesn't look like this should exist. Why wasn't the CDAP endpoint used?

directivesReload

@GET
 @Path(value="contexts/{context}/directives/reload")
public void directivesReload(io.cdap.cdap.api.service.http.HttpServiceRequest request,
                                                                                       io.cdap.cdap.api.service.http.HttpServiceResponder responder,
                                                                                       @PathParam(value="context")
                                                                                       String namespace)

This HTTP endpoint is used to reload the plugins that are of type Directive.Type (directive). Artifact will be reported if it atleast has one plugin that is of type "directive".

charsets

@GET
 @Path(value="charsets")
public void charsets(io.cdap.cdap.api.service.http.HttpServiceRequest request,
                                                   io.cdap.cdap.api.service.http.HttpServiceResponder responder)

Extracts the charsets supported.

Parameters:

request - to gather information of the request.

responder - to respond to the service request.

uploadConfig

@POST
 @Path(value="config")
public void uploadConfig(io.cdap.cdap.api.service.http.HttpServiceRequest request,
                                                      io.cdap.cdap.api.service.http.HttpServiceResponder responder)

Updates the configuration.

Parameters:

request - to gather information of the request.

responder - to respond to the service request.

getConfig

@GET
 @Path(value="config")
public void getConfig(io.cdap.cdap.api.service.http.HttpServiceRequest request,
                                                  io.cdap.cdap.api.service.http.HttpServiceResponder responder)

Updates the configuration.

Parameters:

request - to gather information of the request.

responder - to respond to the service request.