io.cdap.wrangler.service.schema

Class SchemaRegistryHandler

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.schema.SchemaRegistryHandler

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 SchemaRegistryHandler
extends AbstractWranglerHandler

This class SchemaRegistryHandler provides schema management service.

Nested Class Summary

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

AbstractWranglerHandler.NamespacedResponder<T>

Constructor Summary

Constructors

Constructor and Description
SchemaRegistryHandler()

Method Summary

Modifier and Type	Method and Description
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 description, String type) Creates an entry for Schema with id, name, description and type of schema.
void	delete(io.cdap.cdap.api.service.http.HttpServiceRequest request, io.cdap.cdap.api.service.http.HttpServiceResponder responder, String namespace, String id) Deletes the entire entry from the registry.
void	delete(io.cdap.cdap.api.service.http.HttpServiceRequest request, io.cdap.cdap.api.service.http.HttpServiceResponder responder, String namespace, String id, long version) Deletes a version of schema from the registry for a given schema id.
void	get(io.cdap.cdap.api.service.http.HttpServiceRequest request, io.cdap.cdap.api.service.http.HttpServiceResponder responder, String namespace, String id) Returns information of schema, including schema requested along with versions available and other metadata.
void	get(io.cdap.cdap.api.service.http.HttpServiceRequest request, io.cdap.cdap.api.service.http.HttpServiceResponder responder, String namespace, String id, long version) Returns information of schema, including schema requested along with versions available and other metadata.
void	upload(io.cdap.cdap.api.service.http.HttpServiceRequest request, io.cdap.cdap.api.service.http.HttpServiceResponder responder, String namespace, String id) Uploads a schema to be associated with the schema id.
void	versions(io.cdap.cdap.api.service.http.HttpServiceRequest request, io.cdap.cdap.api.service.http.HttpServiceResponder responder, String namespace, String id) Returns list of versions for a give schema id.

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, destroy, getConfigurer, getContext, initialize, 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

SchemaRegistryHandler

public SchemaRegistryHandler()

Method Detail

create

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

Creates an entry for Schema with id, name, description and type of schema. if the 'id' already exists, then it overwrites the data with new information. This responds with HTTP - OK (200) or Internal Error (500).

Parameters:

request - HTTP request handler.

responder - HTTP response handler.

id - of schema to be created.

name - for the schema id being created.

description - associated with schema.

type - of schema.

upload

@POST
 @Path(value="contexts/{context}/schemas/{id}")
public void upload(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)

Uploads a schema to be associated with the schema id. This API will automatically increment the schema version. Upon adding the schema to associated id in schema registry, it returns the version to which the uploaded schema was added to. Following is the response when it's HTTP OK(200) { "status" : "OK", "message" : "Success", "count" : 1, "values" : [ { "id" : "version" : } ] } On any issues, returns error with proper error message and Internal Server error (500).

Parameters:

request - HTTP request handler.

responder - HTTP response handler.

id - of the schema being uploaded.

delete

@DELETE
 @Path(value="contexts/{context}/schemas/{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 entire entry from the registry. Everything related to the schema id is deleted completely. All versions of schema are also deleted.

Parameters:

request - HTTP request handler.

responder - HTTP response handler.

id - of the schema to be deleted.

delete

@DELETE
 @Path(value="contexts/{context}/schemas/{id}/versions/{version}")
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,
                                                                                              @PathParam(value="version")
                                                                                              long version)

Deletes a version of schema from the registry for a given schema id.

Parameters:

request - HTTP request handler.

responder - HTTP response handler.

id - of the schema

version - version of the schema.

get

@GET
 @Path(value="contexts/{context}/schemas/{id}/versions/{version}")
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,
                                                                                        @PathParam(value="version")
                                                                                        long version)

Returns information of schema, including schema requested along with versions available and other metadata.

Parameters:

request - HTTP request handler.

responder - HTTP response handler.

id - of the schema.

version - of the schema.

get

@GET
 @Path(value="contexts/{context}/schemas/{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)

Returns information of schema, including schema requested along with versions available and other metadata. This call will automatically detect the currect active version of schema.

Parameters:

request - HTTP request handler.

responder - HTTP response handler.

id - of the schema.

versions

@GET
 @Path(value="contexts/{context}/schemas/{id}/versions")
public void versions(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)

Returns list of versions for a give schema id.

Parameters:

request - HTTP request handler.

responder - HTTP response handler.

id - of the schema.