io.cdap.wrangler.service.explorer

Class FilesystemExplorer

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.explorer.FilesystemExplorer

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

A FilesystemExplorer is a HTTP Service handler for exploring the filesystem. It provides capabilities for listing file(s) and directories. It also provides metadata.

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
FilesystemExplorer() Deprecated.

Method Summary

Modifier and Type	Method and Description
void	initialize(io.cdap.cdap.api.service.http.SystemHttpServiceContext context) Deprecated.
void	list(io.cdap.cdap.api.service.http.HttpServiceRequest request, io.cdap.cdap.api.service.http.HttpServiceResponder responder, String namespace, String path, boolean hidden) Deprecated. Lists the content of the path specified using the Location.
void	read(io.cdap.cdap.api.service.http.HttpServiceRequest request, io.cdap.cdap.api.service.http.HttpServiceResponder responder, String namespace, String path, int lines, String sampler, double fraction, String scope) Deprecated. Given a path, reads the file into the workspace.
void	specification(io.cdap.cdap.api.service.http.HttpServiceRequest request, io.cdap.cdap.api.service.http.HttpServiceResponder responder, String namespace, String path, String workspaceId) Deprecated. Specification for the source.

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, 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

FilesystemExplorer

public FilesystemExplorer()

Deprecated.

Method Detail

list

@GET
 @Path(value="contexts/{context}/explorer/fs")
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="path")
                                                                     String path,
                                                                     @QueryParam(value="hidden")
                                                                     boolean hidden)

Deprecated.

Lists the content of the path specified using the Location.

Parameters:

request - HTTP Request Handler

responder - HTTP Response Handler

path - to the location in the filesystem

read

@GET
 @Path(value="contexts/{context}/explorer/fs/read")
public void read(io.cdap.cdap.api.service.http.HttpServiceRequest request,
                                                                          io.cdap.cdap.api.service.http.HttpServiceResponder responder,
                                                                          @PathParam(value="context")
                                                                          String namespace,
                                                                          @QueryParam(value="path")
                                                                          String path,
                                                                          @QueryParam(value="lines")
                                                                          int lines,
                                                                          @QueryParam(value="sampler")
                                                                          String sampler,
                                                                          @QueryParam(value="fraction")
                                                                          double fraction,
                                                                          @QueryParam(value="scope") @DefaultValue(value="default")
                                                                          String scope)

Deprecated.

Given a path, reads the file into the workspace.

Parameters:

request - HTTP request handler.

responder - HTTP response handler.

path - to the location in the filesystem.

lines - number of lines to extracted from file if it's a text/plain.

sampler - sampling method to be used.

specification

@GET
 @Path(value="contexts/{context}/explorer/fs/specification")
public void specification(io.cdap.cdap.api.service.http.HttpServiceRequest request,
                                                                                            io.cdap.cdap.api.service.http.HttpServiceResponder responder,
                                                                                            @PathParam(value="context")
                                                                                            String namespace,
                                                                                            @QueryParam(value="path")
                                                                                            String path,
                                                                                            @QueryParam(value="wid")
                                                                                            String workspaceId)

Deprecated.

Specification for the source.

Parameters:

request - HTTP request handler.

responder - HTTP response handler.

path - to the location in the filesystem.

initialize

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

Deprecated.

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