alluxio.worker.grpc

Class UfsFileWriteHandler

java.lang.Object

alluxio.worker.grpc.UfsFileWriteHandler

@NotThreadSafe
public final class UfsFileWriteHandler
extends Object

This handler handles writes to a file in the under file system. Due to the semantics enforced on under file systems, the client must write all the data of a file through the same stream to the under file system. This prevents us from handling the writes at a block level. For more information about the implementation of read/write buffering, see AbstractWriteHandler. For more information about the implementation of the client side writer, see UnderFileSystemFileOutStream.

Field Summary

Fields

Modifier and Type	Field and Description
protected AuthenticatedUserInfo	mUserInfo

Method Summary

Modifier and Type	Method and Description
protected void	cancelRequest(UfsFileWriteRequestContext context) Cancels this write.
protected void	cleanupRequest(UfsFileWriteRequestContext context) Cleans up this write.
protected void	completeRequest(UfsFileWriteRequestContext context) Completes this write.
protected UfsFileWriteRequestContext	createRequestContext(WriteRequest msg) Creates a new request context.
protected void	flushRequest(UfsFileWriteRequestContext context) Flushes the buffered data.
String	getLocation()
protected String	getLocationInternal(UfsFileWriteRequestContext context)
protected void	handleCommand(WriteRequestCommand command, T context) Handles a command in the write request.
void	onCancel() Handles request cancellation event.
void	onCompleted() Handles request complete event.
void	onError(Throwable cause) Handles errors from the request.
void	write(WriteRequest writeRequest) Handles write request.
protected void	writeBuf(UfsFileWriteRequestContext context, io.grpc.stub.StreamObserver<WriteResponse> observer, DataBuffer buf, long pos) Writes the buffer.
void	writeDataMessage(WriteRequest request, DataBuffer buffer) Handles write request with data message.

Methods inherited from class java.lang.Object

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

Field Detail

mUserInfo

protected AuthenticatedUserInfo mUserInfo

Method Detail

createRequestContext

protected UfsFileWriteRequestContext createRequestContext(WriteRequest msg)

Creates a new request context.

Parameters:

msg - the block write request

completeRequest

protected void completeRequest(UfsFileWriteRequestContext context)
                        throws Exception

Completes this write. This is called when the write completes.

Parameters:

context - context of the request to complete

Throws:

Exception

cancelRequest

protected void cancelRequest(UfsFileWriteRequestContext context)
                      throws Exception

Cancels this write. This is called when the client issues a cancel request.

Parameters:

context - context of the request to complete

Throws:

Exception

cleanupRequest

protected void cleanupRequest(UfsFileWriteRequestContext context)
                       throws Exception

Cleans up this write. This is called when the write request is aborted due to any exception or session timeout.

Parameters:

context - context of the request to complete

Throws:

Exception

flushRequest

protected void flushRequest(UfsFileWriteRequestContext context)
                     throws Exception

Flushes the buffered data. Flush only happens after write.

Parameters:

context - context of the request to complete

Throws:

Exception

writeBuf

protected void writeBuf(UfsFileWriteRequestContext context,
                        io.grpc.stub.StreamObserver<WriteResponse> observer,
                        DataBuffer buf,
                        long pos)
                 throws Exception

Writes the buffer.

Parameters:

context - context of the request to complete

observer - the response observer

buf - the buffer

pos - the pos

Throws:

Exception

getLocationInternal

protected String getLocationInternal(UfsFileWriteRequestContext context)

Parameters:

context - the context of the request

Returns:

an informational string of the location the writer is writing to

write

public void write(WriteRequest writeRequest)

Handles write request.

Parameters:

writeRequest - the request from the client

writeDataMessage

public void writeDataMessage(WriteRequest request,
                             DataBuffer buffer)

Handles write request with data message.

Parameters:

request - the request from the client

buffer - the data associated with the request

onCompleted

public void onCompleted()

Handles request complete event.

onCancel

public void onCancel()

Handles request cancellation event.

onError

public void onError(Throwable cause)

Handles errors from the request.

Parameters:

cause - the exception

getLocation

public String getLocation()

Returns:

an informational string of the location the writer is writing to

handleCommand

protected void handleCommand(WriteRequestCommand command,
                             T context)
                      throws Exception

Handles a command in the write request.

Parameters:

command - the command to be handled

Throws:

Exception