com.linkedin.multipart

Class MultiPartMIMEReader.SinglePartMIMEReader

java.lang.Object

com.linkedin.multipart.MultiPartMIMEReader.SinglePartMIMEReader

All Implemented Interfaces:

MultiPartMIMEDataSourceWriter, com.linkedin.r2.message.stream.entitystream.Writer

Enclosing class:

MultiPartMIMEReader

public class MultiPartMIMEReader.SinglePartMIMEReader
extends java.lang.Object
implements MultiPartMIMEDataSourceWriter

A reader to register with and walk through an individual multipart mime body. When a new SinglePartMIMEReader is available, clients will be invoked on MultiPartMIMEReaderCallback.onNewPart(com.linkedin.multipart.MultiPartMIMEReader.SinglePartMIMEReader). At this time, clients should register an instance of SinglePartMIMEReaderCallback and then call requestPartData() to start the flow of data.

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.String>	dataSourceHeaders() Returns the headers for this part.
void	drainPart() Drains all bytes from this part and then notifies the registered callback (if present) on SinglePartMIMEReaderCallback.onDrainComplete().
void	onAbort(java.lang.Throwable e) Please do not use.
void	onInit(com.linkedin.r2.message.stream.entitystream.WriteHandle writeHandle) Please do not use.
void	onWritePossible() Please do not use.
void	registerReaderCallback(SinglePartMIMEReaderCallback callback) This call registers a callback and commits to reading this part.
void	requestPartData() Reads bytes from this part and notifies the registered callback on SinglePartMIMEReaderCallback.onPartDataAvailable(com.linkedin.data.ByteString).

Methods inherited from class java.lang.Object

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

Method Detail

registerReaderCallback

public void registerReaderCallback(SinglePartMIMEReaderCallback callback)

This call registers a callback and commits to reading this part. This can only happen once per life of each SinglePartMIMEReader. Subsequent attempts to modify this will throw SinglePartBindException.

Parameters:

callback - the callback to be invoked on in order to read data

requestPartData

public void requestPartData()

Reads bytes from this part and notifies the registered callback on SinglePartMIMEReaderCallback.onPartDataAvailable(com.linkedin.data.ByteString). Usage of this API requires registration using a SinglePartMIMEReaderCallback. Failure to do so will throw a SinglePartNotInitializedException. If this part is fully consumed, meaning SinglePartMIMEReaderCallback.onFinished() has been called, then any subsequent calls to requestPartData() will throw SinglePartFinishedException. Since this is async and request queueing is not allowed, repetitive calls will result in StreamBusyException. If the r2 reader is done, either through an error or a proper finish, calls to requestPartData() will throw SinglePartFinishedException.

drainPart

public void drainPart()

Drains all bytes from this part and then notifies the registered callback (if present) on SinglePartMIMEReaderCallback.onDrainComplete(). Usage of this API does NOT require registration using a SinglePartMIMEReaderCallback. If there is no callback registration then there is no notification provided upon completion of draining this part. If this part is fully consumed, meaning SinglePartMIMEReaderCallback.onFinished() has been called, then any subsequent calls to drainPart() will throw SinglePartFinishedException. Since this is async and request queueing is not allowed, repetitive calls will result in StreamBusyException. If the r2 reader is done, either through an error or a proper finish, calls to drainPart() will throw SinglePartFinishedException.

dataSourceHeaders

public java.util.Map<java.lang.String,java.lang.String> dataSourceHeaders()

Returns the headers for this part. For parts that have no headers, this will return Collections.emptyMap()

Specified by:

dataSourceHeaders in interface MultiPartMIMEDataSourceWriter

Returns:

onInit

public void onInit(com.linkedin.r2.message.stream.entitystream.WriteHandle writeHandle)

Please do not use. This is for internal use only.

Specified by:

onInit in interface com.linkedin.r2.message.stream.entitystream.Writer

onWritePossible

public void onWritePossible()

Please do not use. This is for internal use only.

Specified by:

onWritePossible in interface com.linkedin.r2.message.stream.entitystream.Writer

onAbort

public void onAbort(java.lang.Throwable e)

Please do not use. This is for internal use only.

Specified by:

onAbort in interface com.linkedin.r2.message.stream.entitystream.Writer