alluxio.proxy

Class PathsRestServiceHandler

java.lang.Object

alluxio.proxy.PathsRestServiceHandler

@NotThreadSafe
 @Path(value="paths")
 @Produces(value="application/json")
 @Consumes(value="application/json")
public final class PathsRestServiceHandler
extends java.lang.Object

This class is a REST handler for path resources.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CREATE_DIRECTORY
static java.lang.String	CREATE_FILE
static java.lang.String	DELETE
static java.lang.String	DOWNLOAD_FILE
static java.lang.String	EXISTS
static java.lang.String	FREE
static java.lang.String	GET_STATUS
static java.lang.String	LIST_STATUS
static java.lang.String	MOUNT
static java.lang.String	OPEN_FILE
static java.lang.String	PATH_PARAM
static java.lang.String	RENAME
static java.lang.String	SERVICE_PREFIX
static java.lang.String	SET_ATTRIBUTE
static java.lang.String	UNMOUNT

Constructor Summary

Constructors

Constructor and Description
PathsRestServiceHandler(javax.servlet.ServletContext context) Constructs a new PathsRestServiceHandler.

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	createDirectory(java.lang.String path, CreateDirectoryPOptions options)
javax.ws.rs.core.Response	createFile(java.lang.String path, CreateFilePOptions options)
javax.ws.rs.core.Response	delete(java.lang.String path, DeletePOptions options)
javax.ws.rs.core.Response	downloadFile(java.lang.String path)
javax.ws.rs.core.Response	exists(java.lang.String path, ExistsPOptions options)
javax.ws.rs.core.Response	free(java.lang.String path, FreePOptions options)
javax.ws.rs.core.Response	getStatus(java.lang.String path, GetStatusPOptions options)
javax.ws.rs.core.Response	listStatus(java.lang.String path, ListStatusPOptions options)
javax.ws.rs.core.Response	mount(java.lang.String path, java.lang.String src, MountPOptions options)
javax.ws.rs.core.Response	openFile(java.lang.String path, OpenFilePOptions options)
javax.ws.rs.core.Response	rename(java.lang.String path, java.lang.String dst, RenamePOptions options)
javax.ws.rs.core.Response	setAttribute(java.lang.String path, SetAttributePOptions options)
javax.ws.rs.core.Response	unmount(java.lang.String path, UnmountPOptions options)

Methods inherited from class java.lang.Object

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

Field Detail

SERVICE_PREFIX

public static final java.lang.String SERVICE_PREFIX

See Also:

Constant Field Values

PATH_PARAM

public static final java.lang.String PATH_PARAM

See Also:

Constant Field Values

CREATE_DIRECTORY

public static final java.lang.String CREATE_DIRECTORY

See Also:

Constant Field Values

CREATE_FILE

public static final java.lang.String CREATE_FILE

See Also:

Constant Field Values

DELETE

public static final java.lang.String DELETE

See Also:

Constant Field Values

DOWNLOAD_FILE

public static final java.lang.String DOWNLOAD_FILE

See Also:

Constant Field Values

EXISTS

public static final java.lang.String EXISTS

See Also:

Constant Field Values

FREE

public static final java.lang.String FREE

See Also:

Constant Field Values

GET_STATUS

public static final java.lang.String GET_STATUS

See Also:

Constant Field Values

LIST_STATUS

public static final java.lang.String LIST_STATUS

See Also:

Constant Field Values

MOUNT

public static final java.lang.String MOUNT

See Also:

Constant Field Values

OPEN_FILE

public static final java.lang.String OPEN_FILE

See Also:

Constant Field Values

RENAME

public static final java.lang.String RENAME

See Also:

Constant Field Values

SET_ATTRIBUTE

public static final java.lang.String SET_ATTRIBUTE

See Also:

Constant Field Values

UNMOUNT

public static final java.lang.String UNMOUNT

See Also:

Constant Field Values

Constructor Detail

PathsRestServiceHandler

public PathsRestServiceHandler(@Context
                               javax.servlet.ServletContext context)

Constructs a new PathsRestServiceHandler.

Parameters:

context - context for the servlet

Method Detail

createDirectory

@POST
 @Path(value="{path:.*}/create-directory")
 @Consumes(value="application/json")
public javax.ws.rs.core.Response createDirectory(@PathParam(value="path")
                                                                                                                                       java.lang.String path,
                                                                                                                                       CreateDirectoryPOptions options)

Parameters:

path - the Alluxio path

options - method options

Returns:

the response object

createFile

@POST
 @Path(value="{path:.*}/create-file")
 @Consumes(value="application/json")
public javax.ws.rs.core.Response createFile(@PathParam(value="path")
                                                                                                                             java.lang.String path,
                                                                                                                             CreateFilePOptions options)

Parameters:

path - the Alluxio path

options - method options

Returns:

the response object

delete

@POST
 @Path(value="{path:.*}/delete")
public javax.ws.rs.core.Response delete(@PathParam(value="path")
                                                                               java.lang.String path,
                                                                               DeletePOptions options)

Parameters:

path - the Alluxio path

options - method options

Returns:

the response object

downloadFile

@GET
 @Path(value="{path:.*}/download-file")
 @Produces(value="application/octet-stream")
public javax.ws.rs.core.Response downloadFile(@PathParam(value="path")
                                                                                                                                        java.lang.String path)

Parameters:

path - the path

Returns:

the response

exists

@POST
 @Path(value="{path:.*}/exists")
public javax.ws.rs.core.Response exists(@PathParam(value="path")
                                                                               java.lang.String path,
                                                                               ExistsPOptions options)

Parameters:

path - the Alluxio path

options - method options

Returns:

the response object

free

@POST
 @Path(value="{path:.*}/free")
public javax.ws.rs.core.Response free(@PathParam(value="path")
                                                                           java.lang.String path,
                                                                           FreePOptions options)

Parameters:

path - the Alluxio path

options - method options

Returns:

the response object

getStatus

@POST
 @Path(value="{path:.*}/get-status")
public javax.ws.rs.core.Response getStatus(@PathParam(value="path")
                                                                                      java.lang.String path,
                                                                                      GetStatusPOptions options)

Parameters:

path - the Alluxio path

options - method options

Returns:

the response object

listStatus

@POST
 @Path(value="{path:.*}/list-status")
public javax.ws.rs.core.Response listStatus(@PathParam(value="path")
                                                                                        java.lang.String path,
                                                                                        ListStatusPOptions options)

Parameters:

path - the Alluxio path

options - method options

Returns:

the response object

mount

@POST
 @Path(value="{path:.*}/mount")
public javax.ws.rs.core.Response mount(@PathParam(value="path")
                                                                             java.lang.String path,
                                                                             @QueryParam(value="src")
                                                                             java.lang.String src,
                                                                             MountPOptions options)

Parameters:

path - the Alluxio path

src - the UFS source to mount

options - method options

Returns:

the response object

openFile

@POST
 @Path(value="{path:.*}/open-file")
 @Produces(value="application/json")
public javax.ws.rs.core.Response openFile(@PathParam(value="path")
                                                                                                                         java.lang.String path,
                                                                                                                         OpenFilePOptions options)

Parameters:

path - the Alluxio path

options - method options

Returns:

the response object

rename

@POST
 @Path(value="{path:.*}/rename")
public javax.ws.rs.core.Response rename(@PathParam(value="path")
                                                                               java.lang.String path,
                                                                               @QueryParam(value="dst")
                                                                               java.lang.String dst,
                                                                               RenamePOptions options)

Parameters:

path - the Alluxio path

dst - the destination path

options - method options

Returns:

the response object

setAttribute

@POST
 @Path(value="{path:.*}/set-attribute")
public javax.ws.rs.core.Response setAttribute(@PathParam(value="path")
                                                                                            java.lang.String path,
                                                                                            SetAttributePOptions options)

Parameters:

path - the Alluxio path

options - method options

Returns:

the response object

unmount

@POST
 @Path(value="{path:.*}/unmount")
public javax.ws.rs.core.Response unmount(@PathParam(value="path")
                                                                                 java.lang.String path,
                                                                                 UnmountPOptions options)

Parameters:

path - the Alluxio path

options - method options

Returns:

the response object