org.apache.hadoop.fs.http.server

Class HttpFSServer

java.lang.Object

org.apache.hadoop.fs.http.server.HttpFSServer

@InterfaceAudience.Private
public class HttpFSServer
extends Object

Main class of HttpFSServer server.

The HttpFSServer class uses Jersey JAX-RS to binds HTTP requests to the different operations.

Constructor Summary

Constructors

Constructor and Description
HttpFSServer()

Method Summary

Methods

Modifier and Type	Method and Description
protected URI	createUploadRedirectionURL(javax.ws.rs.core.UriInfo uriInfo, Enum<?> uploadOperation) Creates the URL for an upload operation (create or append).
javax.ws.rs.core.Response	delete(String path, HttpFSParametersProvider.OperationParam op, Parameters params, javax.servlet.http.HttpServletRequest request) Binding to handle DELETE requests.
javax.ws.rs.core.Response	get(String path, HttpFSParametersProvider.OperationParam op, Parameters params, javax.servlet.http.HttpServletRequest request) Binding to handle GET requests, supported operations are
javax.ws.rs.core.Response	getRoot(HttpFSParametersProvider.OperationParam op, Parameters params, javax.servlet.http.HttpServletRequest request) Special binding for '/' as it is not handled by the wildcard binding.
javax.ws.rs.core.Response	post(InputStream is, javax.ws.rs.core.UriInfo uriInfo, String path, HttpFSParametersProvider.OperationParam op, Parameters params, javax.servlet.http.HttpServletRequest request) Binding to handle POST requests.
javax.ws.rs.core.Response	put(InputStream is, javax.ws.rs.core.UriInfo uriInfo, String path, HttpFSParametersProvider.OperationParam op, Parameters params, javax.servlet.http.HttpServletRequest request) Binding to handle PUT requests.

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpFSServer

public HttpFSServer()

Method Detail

getRoot

public javax.ws.rs.core.Response getRoot(HttpFSParametersProvider.OperationParam op,
                                @Context
                                Parameters params,
                                @Context
                                javax.servlet.http.HttpServletRequest request)
                                  throws IOException,
                                         FileSystemAccessException

Special binding for '/' as it is not handled by the wildcard binding.

Parameters:

op - the HttpFS operation of the request.

params - the HttpFS parameters of the request.

Returns:

the request response.

Throws:

IOException - thrown if an IO error occurred. Thrown exceptions are handled by HttpFSExceptionProvider.

FileSystemAccessException - thrown if a FileSystemAccess releated error occurred. Thrown exceptions are handled by HttpFSExceptionProvider.

get

public javax.ws.rs.core.Response get(String path,
                            HttpFSParametersProvider.OperationParam op,
                            @Context
                            Parameters params,
                            @Context
                            javax.servlet.http.HttpServletRequest request)
                              throws IOException,
                                     FileSystemAccessException

Binding to handle GET requests, supported operations are

Parameters:

path - the path for operation.

op - the HttpFS operation of the request.

params - the HttpFS parameters of the request.

Returns:

the request response.

Throws:

IOException - thrown if an IO error occurred. Thrown exceptions are handled by HttpFSExceptionProvider.

FileSystemAccessException - thrown if a FileSystemAccess releated error occurred. Thrown exceptions are handled by HttpFSExceptionProvider.

delete

public javax.ws.rs.core.Response delete(String path,
                               HttpFSParametersProvider.OperationParam op,
                               @Context
                               Parameters params,
                               @Context
                               javax.servlet.http.HttpServletRequest request)
                                 throws IOException,
                                        FileSystemAccessException

Binding to handle DELETE requests.

Parameters:

path - the path for operation.

op - the HttpFS operation of the request.

params - the HttpFS parameters of the request.

Returns:

the request response.

Throws:

IOException - thrown if an IO error occurred. Thrown exceptions are handled by HttpFSExceptionProvider.

FileSystemAccessException - thrown if a FileSystemAccess releated error occurred. Thrown exceptions are handled by HttpFSExceptionProvider.

post

public javax.ws.rs.core.Response post(InputStream is,
                             @Context
                             javax.ws.rs.core.UriInfo uriInfo,
                             String path,
                             HttpFSParametersProvider.OperationParam op,
                             @Context
                             Parameters params,
                             @Context
                             javax.servlet.http.HttpServletRequest request)
                               throws IOException,
                                      FileSystemAccessException

Binding to handle POST requests.

Parameters:

is - the inputstream for the request payload.

uriInfo - the of the request.

path - the path for operation.

op - the HttpFS operation of the request.

params - the HttpFS parameters of the request.

Returns:

the request response.

Throws:

IOException - thrown if an IO error occurred. Thrown exceptions are handled by HttpFSExceptionProvider.

FileSystemAccessException - thrown if a FileSystemAccess releated error occurred. Thrown exceptions are handled by HttpFSExceptionProvider.

createUploadRedirectionURL

protected URI createUploadRedirectionURL(javax.ws.rs.core.UriInfo uriInfo,
                             Enum<?> uploadOperation)

Creates the URL for an upload operation (create or append).

Parameters:

uriInfo - uri info of the request.

uploadOperation - operation for the upload URL.

Returns:

the URI for uploading data.

put

public javax.ws.rs.core.Response put(InputStream is,
                            @Context
                            javax.ws.rs.core.UriInfo uriInfo,
                            String path,
                            HttpFSParametersProvider.OperationParam op,
                            @Context
                            Parameters params,
                            @Context
                            javax.servlet.http.HttpServletRequest request)
                              throws IOException,
                                     FileSystemAccessException

Binding to handle PUT requests.

Parameters:

is - the inputstream for the request payload.

uriInfo - the of the request.

path - the path for operation.

op - the HttpFS operation of the request.

params - the HttpFS parameters of the request.

Returns:

the request response.

Throws:

IOException - thrown if an IO error occurred. Thrown exceptions are handled by HttpFSExceptionProvider.

FileSystemAccessException - thrown if a FileSystemAccess releated error occurred. Thrown exceptions are handled by HttpFSExceptionProvider.