io.cdap.wrangler.service.connections

Class ConnectionHandler

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.connections.ConnectionHandler

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>

Deprecated.

@Deprecated
public class ConnectionHandler
extends AbstractWranglerHandler

This service exposes REST APIs for managing the lifecycle of a connection in the connection store.

Nested Class Summary

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

AbstractWranglerHandler.NamespacedResponder<T>, AbstractWranglerHandler.NamespacedResponderRunnable

Constructor Summary

Constructors

Constructor and Description
ConnectionHandler(ConnectionTypeConfig connectionTypeConfig) Deprecated.

Method Summary

Modifier and Type	Method and Description
void	clone(io.cdap.cdap.api.service.http.HttpServiceRequest request, io.cdap.cdap.api.service.http.HttpServiceResponder responder, String namespace, String id) Deprecated. Given a connection id, Clones and returns a new connection.
void	configure() Deprecated.
void	create(io.cdap.cdap.api.service.http.HttpServiceRequest request, io.cdap.cdap.api.service.http.HttpServiceResponder responder, String namespace) Deprecated. Creates a connection object in the connections store.
void	delete(io.cdap.cdap.api.service.http.HttpServiceRequest request, io.cdap.cdap.api.service.http.HttpServiceResponder responder, String namespace, String id) Deprecated. Deletes a connection from the connection store.
void	get(io.cdap.cdap.api.service.http.HttpServiceRequest request, io.cdap.cdap.api.service.http.HttpServiceResponder responder, String namespace, String id) Deprecated. Given a connection id, returns the complete information about the connection.
void	getConnectionTypes(io.cdap.cdap.api.service.http.HttpServiceRequest request, io.cdap.cdap.api.service.http.HttpServiceResponder responder) Deprecated. Get the list of connection types that are supported
void	initialize(io.cdap.cdap.api.service.http.SystemHttpServiceContext context) Deprecated. Stores the context so that it can be used later.
void	list(io.cdap.cdap.api.service.http.HttpServiceRequest request, io.cdap.cdap.api.service.http.HttpServiceResponder responder, String namespace, String type) Deprecated. Lists all the connections available in the connection store.
void	properties(io.cdap.cdap.api.service.http.HttpServiceRequest request, io.cdap.cdap.api.service.http.HttpServiceResponder responder, String namespace, String id) Deprecated. Returns only the properties of the connection requested.
void	update(io.cdap.cdap.api.service.http.HttpServiceRequest request, io.cdap.cdap.api.service.http.HttpServiceResponder responder, String namespace, String id) Deprecated. Updates the connection within the connections store.
void	updateProp(io.cdap.cdap.api.service.http.HttpServiceRequest request, io.cdap.cdap.api.service.http.HttpServiceResponder responder, String namespace, String id, String key, String value) Deprecated. Updates a property of the connection.

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

getConnection, getValidatedConnection, getValidatedConnection, getWorkspace, respond, 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, destroy, 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

ConnectionHandler

public ConnectionHandler(ConnectionTypeConfig connectionTypeConfig)

Deprecated.

Method Detail

configure

public void configure()

Deprecated.

Overrides:

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

initialize

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

Deprecated.

Stores the context so that it can be used later.

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>

Parameters:

context - the HTTP service runtime context

Throws:

Exception

create

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

Deprecated.

Creates a connection object in the connections store. Following is the JSON request for setting the connection. { "name" : "MySQL Production DB", "description" : "Production DB connection handler", "type" : "DATABASE", "properties" : { "hostname" : "localhost", "port" : 3306, "username" : "root", "password" : "", "ssl" : false } }

Parameters:

request - Handler for incoming request.

responder - Responder for data going out.

update

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

Deprecated.

Updates the connection within the connections store. Following is the JSON request for setting the connection. { "id" : "mysql_production_db", "name" : "MySQL Production DB", "description" : "Production DB connection handler", "created" : 123323213, "updated" : 123453533, "type" : "DATABASE", "properties" : { "hostname" : "localhost", "port" : 3306, "username" : "root", "password" : "", "ssl" : false } }

Parameters:

request - Handler for incoming request.

responder - Responder for data going out.

list

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

Deprecated.

Lists all the connections available in the connection store.

Parameters:

request - Handler for incoming request.

responder - Responder for data going out.

delete

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

Deprecated.

Deletes a connection from the connection store.

Parameters:

request - Handler for incoming request.

responder - Responder for data going out.

id - of the connection to be deleted.

get

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

Deprecated.

Given a connection id, returns the complete information about the connection.

Parameters:

request - Handler for incoming request.

responder - Responder for data going out.

id - for which all the information is returned from the connection store.

properties

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

Deprecated.

Returns only the properties of the connection requested.

Parameters:

request - Handler for incoming request.

responder - Responder for data going out.

id - of the connection for which all properties need to be returned.

updateProp

@PUT
 @Path(value="contexts/{context}/connections/{id}/properties")
public void updateProp(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="key")
                                                                                           String key,
                                                                                           @QueryParam(value="value")
                                                                                           String value)

Deprecated.

Updates a property of the connection.

Parameters:

request - Handler for incoming request.

responder - Responder for data going out.

id - of the connection to be who's property needs to be updated.

clone

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

Deprecated.

Given a connection id, Clones and returns a new connection.

Parameters:

request - Handler for incoming request.

responder - Responder for data going out.

id - of the connection that should be cloned.

getConnectionTypes

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

Deprecated.

Get the list of connection types that are supported