org.dataone.mimemultipart

Class SimpleMultipartEntity

java.lang.Object

org.apache.http.entity.mime.MultipartEntity

org.dataone.mimemultipart.SimpleMultipartEntity

All Implemented Interfaces:

org.apache.http.HttpEntity

public class SimpleMultipartEntity
extends org.apache.http.entity.mime.MultipartEntity

Author:

berkley, nahf A class to simplify creation of MIME multipart messages

Constructor Summary

Constructors

Constructor and Description
SimpleMultipartEntity()

Method Summary

Methods

Modifier and Type	Method and Description
void	addFilePart(String name, File file) add a file part to the MMP
void	addFilePart(String name, InputStream is) add a file part to the MMP, using InputStream This method writes the contents of the stream to a temp file and sends it.
void	addFilePart(String name, Object serializableD1Object) The DataONE object (serializable datatype) passed in is serialized as the specified type to file.
void	addFilePart(String name, Object serializableD1Object, Class type) Deprecated.
void	addFilePart(String name, String value) This method generates a temp files for sending, containing the value parameter.
void	addParamPart(String name, String value) add a param part to the MMP
boolean	cleanupTempFiles() calling this method attempts to delete the client-side temp files from the system.
String	getDescription() Returns a concise description of the existing file parts, as comma-separated key-value pairs.
protected String	getLastTempfile()

Methods inherited from class org.apache.http.entity.mime.MultipartEntity

addPart, addPart, consumeContent, generateBoundary, generateContentType, getContent, getContentEncoding, getContentLength, getContentType, isChunked, isRepeatable, isStreaming, writeTo

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleMultipartEntity

public SimpleMultipartEntity()

Method Detail

getDescription

public String getDescription()

Returns a concise description of the existing file parts, as comma-separated key-value pairs. Values for file parts are its filename and size.

Returns:

addFilePart

public void addFilePart(String name,
               File file)

add a file part to the MMP

Parameters:

name - - the name assigned to the file part

file - - the file to be put into the file part

addFilePart

public void addFilePart(String name,
               InputStream is)
                 throws IOException

add a file part to the MMP, using InputStream This method writes the contents of the stream to a temp file and sends it.

Parameters:

name - - the name assigned to the file part

is - - the inputStream

Throws:

IOException

addFilePart

public void addFilePart(String name,
               Object serializableD1Object)
                 throws IOException,
                        MarshallingException

The DataONE object (serializable datatype) passed in is serialized as the specified type to file. Then added as a file part.

Parameters:

name -

serializableD1Object - - the dataone serializable object to add

type - - class of the serializable dataone datatype

Throws:

IOException

MarshallingException

addFilePart

@Deprecated
public void addFilePart(String name,
                          Object serializableD1Object,
                          Class type)
                 throws IOException,
                        MarshallingException

Deprecated.

Throws:

IOException

MarshallingException

addFilePart

public void addFilePart(String name,
               String value)
                 throws IOException

This method generates a temp files for sending, containing the value parameter. Encoding is in UTF-8.

Parameters:

name - - the name assigned to the file part

value - - the String to be passed as a file part

Throws:

IOException

addParamPart

public void addParamPart(String name,
                String value)

add a param part to the MMP

Parameters:

name - - the name (key) assigned to the param part

value - - the value associated to the name

getLastTempfile

protected String getLastTempfile()

cleanupTempFiles

public boolean cleanupTempFiles()

calling this method attempts to delete the client-side temp files from the system. Safest if called after response received from the request.

Returns:

boolean [false] if not all files were deleted [true] otherwise