org.lacibus.storeapi

Class MultipartHttp

java.lang.Object

org.lacibus.storeapi.MultipartHttp

All Implemented Interfaces:

java.io.Serializable

public class MultipartHttp
extends java.lang.Object
implements java.io.Serializable

An instance of this class performs processing for HTTP requests and responses with multipart form data content.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MultipartHttp()

Method Summary

Modifier and Type	Method and Description
static Datum	getBinaryPart(javax.servlet.http.Part part, java.io.File file) Get the content of a large binary part as a datum.
static byte[]	getBytesPart(javax.servlet.http.Part part) Get the content of a part as an array of bytes
static java.util.Map<java.lang.String,java.util.List<Datum>>	getMultipartDatums(javax.servlet.http.HttpServletRequest request, java.util.Set<java.io.File> tempFiles) Get datums from the parts of an HTTP request with multipart form data content.
static java.util.Map<java.lang.String,Datum>	getMultipartUniqueDatums(javax.servlet.http.HttpServletRequest request, java.util.Set<java.io.File> tempFiles) Get unique datums from the parts of an HTTP request with multipart form data content.
static java.lang.String	getStringPart(javax.servlet.http.Part part) Get the content of a part as a string.
static Datum	getTextPart(javax.servlet.http.Part part, java.io.File file) Get the content of a large text part as a datum.
static boolean	isText(java.lang.String contentType) Determine whether a content type is a text content type.
Response	makeJsonWithBinaryRequest(java.lang.String requestURL, java.util.Map<java.lang.String,Datum> values, java.util.Map<java.lang.String,java.lang.String> meta, java.lang.String refurl, java.lang.String oneTimeKey) Make a request with multipart form encoded content conveying a set of values, optionally some metadata, optionally a reference URL, and optionally a one-time key.
Response	makeMultipartRequest(java.lang.String requestURL, java.util.Map<java.lang.String,Datum> partDatums) Make an HTTP POST request with multipart form encoded content
void	makeMultipartResponse(java.util.Map<java.lang.String,Datum> result, javax.servlet.http.HttpServletResponse response) Add multipart content to an HTTP response.

Methods inherited from class java.lang.Object

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

Constructor Detail

MultipartHttp

public MultipartHttp()

Method Detail

makeJsonWithBinaryRequest

public Response makeJsonWithBinaryRequest(java.lang.String requestURL,
                                          java.util.Map<java.lang.String,Datum> values,
                                          java.util.Map<java.lang.String,java.lang.String> meta,
                                          java.lang.String refurl,
                                          java.lang.String oneTimeKey)
                                   throws java.lang.Exception

Make a request with multipart form encoded content conveying a set of values, optionally some metadata, optionally a reference URL, and optionally a one-time key. One of the parts is named 'json' and is a utf8 string representation of a JSON object. Each binary value is represented in the request by a string of the form bn where n is an integer. There is then a part named bn with application/octet-stream encoding that contains the binary value. Each non-binary value is represented by a JSON object with two attributes: type and value. If metadata is supplied, then there is a part named 'meta' that contains it. If a reference URL is supplied, then there is a part named 'refurl' that contains it. If a one-time key is supplied, then there is a part named 'one-time-key' that contains it.

Parameters:

requestURL - the URL to which the request is to be made

values - the values to be conveyed.

meta - the metadata to be conveyed, in the form of a set of name-value pairs.

refUrl - a reference URL from which data can be obtained, or null. (This is often the requesting system's API URL.)

key - a one-time key, or null

Returns:

the response returned by the request, including the status code and text.

Throws:

java.lang.Exception

makeMultipartRequest

public Response makeMultipartRequest(java.lang.String requestURL,
                                     java.util.Map<java.lang.String,Datum> partDatums)
                              throws java.lang.Exception

Make an HTTP POST request with multipart form encoded content

Parameters:

requestURL - the URL to which the request is to be made

parts - the content of the request. Each name-datum pair of the map is to be a part of the multipart request.

Returns:

the response returned by the request, including the status code and text.

Throws:

java.lang.Exception

makeMultipartResponse

public void makeMultipartResponse(java.util.Map<java.lang.String,Datum> result,
                                  javax.servlet.http.HttpServletResponse response)
                           throws java.lang.Exception

Add multipart content to an HTTP response.

Parameters:

result - the data to include in the response, supplied as a String-Datum map. For each entry, a part will be generated with the same name as the entry, and with content whose type is application/octet-stream if the datum is a Binary datum, and text/plain with utf8 encoding otherwise.

response - the response to which the content is to be added.

Throws:

java.lang.Exception

getMultipartUniqueDatums

public static java.util.Map<java.lang.String,Datum> getMultipartUniqueDatums(javax.servlet.http.HttpServletRequest request,
                                                                             java.util.Set<java.io.File> tempFiles)
                                                                      throws java.lang.Exception

Get unique datums from the parts of an HTTP request with multipart form data content. If there is more than one part with a particular name, the datums cannot be unique, and an exception is thrown.

Parameters:

request - an HTTP request with multipart form data content.

tempFiles - a set of temporary files to contain the content of large parts of the input content.

Returns:

a map containing an entry for each part name. The key of the entry is the part name. The value of the entry is a datum containing the content of the unique part with that name.

Throws:

java.lang.Exception

getMultipartDatums

public static java.util.Map<java.lang.String,java.util.List<Datum>> getMultipartDatums(javax.servlet.http.HttpServletRequest request,
                                                                                       java.util.Set<java.io.File> tempFiles)
                                                                                throws java.lang.Exception

Get datums from the parts of an HTTP request with multipart form data content.

Parameters:

request - an HTTP request with multipart form data content.

tempFiles - a set of temporary files to contain the content of large parts of the input content.

Returns:

a map containing an entry for each part name. The key of the entry is the part name. The value of the entry is a list of datums, each containing the content of a part with that name.

Throws:

java.lang.Exception

isText

public static boolean isText(java.lang.String contentType)

Determine whether a content type is a text content type. A content type is assumed to be a text type if it starts with "text/" or if it is "application/javascript" or "application/json". Otherwise it is assumed not to be a text content type.

Parameters:

contentType - a content type.

Returns:

whether the content type is a text content type.

getBytesPart

public static byte[] getBytesPart(javax.servlet.http.Part part)
                           throws java.io.IOException

Get the content of a part as an array of bytes

Parameters:

part - a part of multipart content

Returns:

a byte array containing the content of the part.

Throws:

java.io.IOException

getStringPart

public static java.lang.String getStringPart(javax.servlet.http.Part part)
                                      throws java.io.IOException

Get the content of a part as a string.

Parameters:

part - a part of multipart content

Returns:

a string containing the content of the part.

Throws:

java.io.IOException

getBinaryPart

public static Datum getBinaryPart(javax.servlet.http.Part part,
                                  java.io.File file)
                           throws java.lang.Exception

Get the content of a large binary part as a datum.

Parameters:

part - a binary part of multipart content

file - a file to contain the content of the part

Returns:

a binary file datum containing the content of the part.

Throws:

java.lang.Exception

getTextPart

public static Datum getTextPart(javax.servlet.http.Part part,
                                java.io.File file)
                         throws java.lang.Exception

Get the content of a large text part as a datum.

Parameters:

part - a text part of multipart content

file - a file to contain the content of the part

Returns:

a text file datum containing the content of the part.

Throws:

java.lang.Exception