alluxio.master.file

Class FileSystemMasterClientRestServiceHandler

java.lang.Object

alluxio.master.file.FileSystemMasterClientRestServiceHandler

Deprecated.

since version 1.4 and will be removed in version 2.0

@NotThreadSafe
 @Path(value="master/file")
 @Produces(value="application/json")
 @Deprecated
public final class FileSystemMasterClientRestServiceHandler
extends Object

This class is a REST handler for file system master requests.

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPLETE_FILE Deprecated.
static String	CREATE_DIRECTORY Deprecated.
static String	CREATE_FILE Deprecated.
static String	FREE Deprecated.
static String	GET_MOUNT_POINTS Deprecated.
static String	GET_NEW_BLOCK_ID_FOR_FILE Deprecated.
static String	GET_STATUS Deprecated.
static String	LIST_STATUS Deprecated.
static String	MOUNT Deprecated.
static String	REMOVE Deprecated.
static String	RENAME Deprecated.
static String	SCHEDULE_ASYNC_PERSIST Deprecated.
static String	SERVICE_NAME Deprecated.
static String	SERVICE_PREFIX Deprecated.
static String	SERVICE_VERSION Deprecated.
static String	SET_ATTRIBUTE Deprecated.
static String	UNMOUNT Deprecated.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	completeFile(String path, Long ufsLength) Deprecated.
javax.ws.rs.core.Response	createDirectory(String path, Boolean persisted, Boolean recursive, Boolean allowExists) Deprecated.
javax.ws.rs.core.Response	createFile(String path, Boolean persisted, Boolean recursive, Long blockSizeBytes, Long ttl, TtlAction ttlAction) Deprecated.
javax.ws.rs.core.Response	free(String path, boolean recursive) Deprecated.
javax.ws.rs.core.Response	getMountPoints() Deprecated.
javax.ws.rs.core.Response	getNewBlockIdForFile(String path) Deprecated.
javax.ws.rs.core.Response	getServiceName() Deprecated.
javax.ws.rs.core.Response	getServiceVersion() Deprecated.
javax.ws.rs.core.Response	getStatus(String path) Deprecated.
javax.ws.rs.core.Response	listStatus(String path, boolean loadDirectChildren, String loadMetadataType) Deprecated.
javax.ws.rs.core.Response	mount(String path, String ufsPath, Boolean readOnly, Boolean shared) Deprecated.
javax.ws.rs.core.Response	remove(String path, boolean recursive) Deprecated.
javax.ws.rs.core.Response	rename(String srcPath, String dstPath) Deprecated.
javax.ws.rs.core.Response	scheduleAsyncPersist(String path) Deprecated.
javax.ws.rs.core.Response	setAttribute(String path, Boolean pinned, Long ttl, Boolean persisted, String owner, String group, Short permission, Boolean recursive, TtlAction ttlAction) Deprecated.
javax.ws.rs.core.Response	unmount(String path) Deprecated.

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 String SERVICE_PREFIX

Deprecated.

See Also:

Constant Field Values

SERVICE_NAME

public static final String SERVICE_NAME

Deprecated.

See Also:

Constant Field Values

SERVICE_VERSION

public static final String SERVICE_VERSION

Deprecated.

See Also:

Constant Field Values

COMPLETE_FILE

public static final String COMPLETE_FILE

Deprecated.

See Also:

Constant Field Values

CREATE_DIRECTORY

public static final String CREATE_DIRECTORY

Deprecated.

See Also:

Constant Field Values

CREATE_FILE

public static final String CREATE_FILE

Deprecated.

See Also:

Constant Field Values

FREE

public static final String FREE

Deprecated.

See Also:

Constant Field Values

GET_MOUNT_POINTS

public static final String GET_MOUNT_POINTS

Deprecated.

See Also:

Constant Field Values

GET_NEW_BLOCK_ID_FOR_FILE

public static final String GET_NEW_BLOCK_ID_FOR_FILE

Deprecated.

See Also:

Constant Field Values

GET_STATUS

public static final String GET_STATUS

Deprecated.

See Also:

Constant Field Values

LIST_STATUS

public static final String LIST_STATUS

Deprecated.

See Also:

Constant Field Values

MOUNT

public static final String MOUNT

Deprecated.

See Also:

Constant Field Values

REMOVE

public static final String REMOVE

Deprecated.

See Also:

Constant Field Values

RENAME

public static final String RENAME

Deprecated.

See Also:

Constant Field Values

SCHEDULE_ASYNC_PERSIST

public static final String SCHEDULE_ASYNC_PERSIST

Deprecated.

See Also:

Constant Field Values

SET_ATTRIBUTE

public static final String SET_ATTRIBUTE

Deprecated.

See Also:

Constant Field Values

UNMOUNT

public static final String UNMOUNT

Deprecated.

See Also:

Constant Field Values

Constructor Detail

FileSystemMasterClientRestServiceHandler

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

Deprecated.

Constructs a new FileSystemMasterClientRestServiceHandler.

Parameters:

context - context for the servlet

Method Detail

getServiceName

@GET
 @Path(value="service_name")
public javax.ws.rs.core.Response getServiceName()

Deprecated.

Returns:

the response object

getServiceVersion

@GET
 @Path(value="service_version")
public javax.ws.rs.core.Response getServiceVersion()

Deprecated.

Returns:

the response object

completeFile

@POST
 @Path(value="complete_file")
public javax.ws.rs.core.Response completeFile(@QueryParam(value="path")
                                                                                  String path,
                                                                                  @QueryParam(value="ufsLength")
                                                                                  Long ufsLength)

Deprecated.

Parameters:

path - the file path

ufsLength - the length of the file in under file system

Returns:

the response object

createDirectory

@POST
 @Path(value="create_directory")
public javax.ws.rs.core.Response createDirectory(@QueryParam(value="path")
                                                                                        String path,
                                                                                        @QueryParam(value="persisted")
                                                                                        Boolean persisted,
                                                                                        @QueryParam(value="recursive")
                                                                                        Boolean recursive,
                                                                                        @QueryParam(value="allowExists")
                                                                                        Boolean allowExists)

Deprecated.

Parameters:

path - the file path

persisted - whether directory should be persisted

recursive - whether parent directories should be created if they do not already exist

allowExists - whether the operation should succeed even if the directory already exists

Returns:

the response object

createFile

@POST
 @Path(value="create_file")
public javax.ws.rs.core.Response createFile(@QueryParam(value="path")
                                                                              String path,
                                                                              @QueryParam(value="persisted")
                                                                              Boolean persisted,
                                                                              @QueryParam(value="recursive")
                                                                              Boolean recursive,
                                                                              @QueryParam(value="blockSizeBytes")
                                                                              Long blockSizeBytes,
                                                                              @QueryParam(value="ttl")
                                                                              Long ttl,
                                                                              @QueryParam(value="ttlAction")
                                                                              TtlAction ttlAction)

Deprecated.

Parameters:

path - the file path

persisted - whether directory should be persisted

recursive - whether parent directories should be created if they do not already exist

blockSizeBytes - the target block size in bytes

ttl - the time-to-live (in milliseconds)

ttlAction - action to take after TTL is expired

Returns:

the response object

getNewBlockIdForFile

@POST
 @Path(value="new_block_id_for_file")
public javax.ws.rs.core.Response getNewBlockIdForFile(@QueryParam(value="path")
                                                                                                  String path)

Deprecated.

Parameters:

path - the file path

Returns:

the response object

getStatus

@GET
 @Path(value="status")
public javax.ws.rs.core.Response getStatus(@QueryParam(value="path")
                                                                       String path)

Deprecated.

Parameters:

path - the file path

Returns:

the response object

free

@POST
 @Path(value="free")
public javax.ws.rs.core.Response free(@QueryParam(value="path")
                                                                 String path,
                                                                 @QueryParam(value="recursive")
                                                                 boolean recursive)

Deprecated.

Parameters:

path - the path

recursive - whether the path should be freed recursively

Returns:

the response object

listStatus

@GET
 @Path(value="list_status")
public javax.ws.rs.core.Response listStatus(@QueryParam(value="path")
                                                                             String path,
                                                                             @Deprecated @QueryParam(value="loadDirectChildren")
                                                                             boolean loadDirectChildren,
                                                                             @DefaultValue(value="") @QueryParam(value="loadMetadataType")
                                                                             String loadMetadataType)

Deprecated.

Parameters:

path - the file path

loadDirectChildren - whether to load direct children of path

loadMetadataType - the LoadMetadataType. It overrides loadDirectChildren if it is set.

Returns:

the response object

mount

@POST
 @Path(value="mount")
public javax.ws.rs.core.Response mount(@QueryParam(value="path")
                                                                   String path,
                                                                   @QueryParam(value="ufsPath")
                                                                   String ufsPath,
                                                                   @QueryParam(value="readOnly")
                                                                   Boolean readOnly,
                                                                   @QueryParam(value="shared")
                                                                   Boolean shared)

Deprecated.

Parameters:

path - the alluxio mount point

ufsPath - the UFS path to mount

readOnly - whether to make the mount option read only

shared - whether to make the mount option shared with all Alluxio users

Returns:

the response object

getMountPoints

@GET
 @Path(value="mount_points")
public javax.ws.rs.core.Response getMountPoints()

Deprecated.

Returns:

the response object

remove

@POST
 @Path(value="remove")
public javax.ws.rs.core.Response remove(@QueryParam(value="path")
                                                                     String path,
                                                                     @QueryParam(value="recursive")
                                                                     boolean recursive)

Deprecated.

Parameters:

path - the path to remove

recursive - whether to remove paths recursively

Returns:

the response object

rename

@POST
 @Path(value="rename")
public javax.ws.rs.core.Response rename(@QueryParam(value="srcPath")
                                                                     String srcPath,
                                                                     @QueryParam(value="dstPath")
                                                                     String dstPath)

Deprecated.

Parameters:

srcPath - the source path

dstPath - the destination path

Returns:

the response object

scheduleAsyncPersist

@POST
 @Path(value="schedule_async_persist")
public javax.ws.rs.core.Response scheduleAsyncPersist(@QueryParam(value="path")
                                                                                                   String path)

Deprecated.

Parameters:

path - the file path

Returns:

the response object

setAttribute

@POST
 @Path(value="set_attribute")
public javax.ws.rs.core.Response setAttribute(@QueryParam(value="path")
                                                                                  String path,
                                                                                  @QueryParam(value="pinned")
                                                                                  Boolean pinned,
                                                                                  @QueryParam(value="ttl")
                                                                                  Long ttl,
                                                                                  @QueryParam(value="persisted")
                                                                                  Boolean persisted,
                                                                                  @QueryParam(value="owner")
                                                                                  String owner,
                                                                                  @QueryParam(value="group")
                                                                                  String group,
                                                                                  @QueryParam(value="permission")
                                                                                  Short permission,
                                                                                  @QueryParam(value="recursive")
                                                                                  Boolean recursive,
                                                                                  @QueryParam(value="ttxAction")
                                                                                  TtlAction ttlAction)

Deprecated.

Parameters:

path - the file path

pinned - the pinned flag value to use

ttl - the time-to-live (in seconds) to use

persisted - the persisted flag value to use

owner - the file owner

group - the file group

permission - the file permission bits

recursive - whether the attribute should be set recursively

ttlAction - action to take after TTL is expired

Returns:

the response object

unmount

@POST
 @Path(value="unmount")
public javax.ws.rs.core.Response unmount(@QueryParam(value="path")
                                                                       String path)

Deprecated.

Parameters:

path - the file path

Returns:

the response object