com.linkedin.multipart

Class MultiPartMIMEStreamRequestFactory

java.lang.Object

com.linkedin.multipart.MultiPartMIMEStreamRequestFactory

public final class MultiPartMIMEStreamRequestFactory
extends java.lang.Object

A wrapper to enforce creating a proper multipart mimeStreamRequest.

Method Summary

Modifier and Type	Method and Description
static com.linkedin.r2.message.stream.StreamRequest	generateMultiPartMIMEStreamRequest(java.net.URI uri, java.lang.String mimeSubType, MultiPartMIMEWriter writer) Create a StreamRequest using the specified parameters.
static com.linkedin.r2.message.stream.StreamRequest	generateMultiPartMIMEStreamRequest(java.net.URI uri, java.lang.String mimeSubType, MultiPartMIMEWriter writer, java.util.Map<java.lang.String,java.lang.String> contentTypeParameters) Create a StreamRequest using the specified parameters.
static com.linkedin.r2.message.stream.StreamRequest	generateMultiPartMIMEStreamRequest(java.net.URI uri, java.lang.String mimeSubType, MultiPartMIMEWriter writer, java.util.Map<java.lang.String,java.lang.String> contentTypeParameters, java.lang.String method, java.util.Map<java.lang.String,java.lang.String> headers, java.util.List<java.lang.String> cookies) Create a StreamRequest using the specified parameters.

Methods inherited from class java.lang.Object

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

Method Detail

generateMultiPartMIMEStreamRequest

public static com.linkedin.r2.message.stream.StreamRequest generateMultiPartMIMEStreamRequest(java.net.URI uri,
                                                                                              java.lang.String mimeSubType,
                                                                                              MultiPartMIMEWriter writer)

Create a StreamRequest using the specified parameters. This API should be used if the user does not have a need to define a StreamRequestBuilder in advance. The result of this method will generate a StreamRequest using the specified URI, an HTTP method of com.linkedin.r2.message.rest.RestMethod#POST, a single header representing the generated Content-Type and no cookies.

Parameters:

uri - the target URI to be used.

mimeSubType - the mime subtype of the multipart to be used. For example, 'mixed' would result in a Content-Type of 'multipart/mixed'. It is generally good practice to use subtypes described in RFC 1341, although this API does not enforce this.

writer - the MultiPartMIMEWriter to use for the payload of the request.

Returns:

the newly created StreamRequest.

generateMultiPartMIMEStreamRequest

public static com.linkedin.r2.message.stream.StreamRequest generateMultiPartMIMEStreamRequest(java.net.URI uri,
                                                                                              java.lang.String mimeSubType,
                                                                                              MultiPartMIMEWriter writer,
                                                                                              java.util.Map<java.lang.String,java.lang.String> contentTypeParameters)

Create a StreamRequest using the specified parameters. This API should be used if the user does not have a need to define a StreamRequestBuilder in advance. The result of this method will generate a StreamRequest using the specified URI, an HTTP method of com.linkedin.r2.message.rest.RestMethod#POST, a single header representing the generated Content-Type and no cookies.

Parameters:

uri - the target URI to be used.

mimeSubType - the mime subtype of the multipart to be used. For example, 'mixed' would result in a Content-Type of 'multipart/mixed'. It is generally good practice to use subtypes described in RFC 1341, although this API does not enforce this.

writer - the MultiPartMIMEWriter to use for the payload of the request.

contentTypeParameters - any additional parameters (i.e "charset") needed when constructing the Content-Type header. These parameters are added after the following prefix: "multipart/; boundary=;". For more details please refer to RFC 822.

Returns:

the newly created StreamRequest.

generateMultiPartMIMEStreamRequest

public static com.linkedin.r2.message.stream.StreamRequest generateMultiPartMIMEStreamRequest(java.net.URI uri,
                                                                                              java.lang.String mimeSubType,
                                                                                              MultiPartMIMEWriter writer,
                                                                                              java.util.Map<java.lang.String,java.lang.String> contentTypeParameters,
                                                                                              java.lang.String method,
                                                                                              java.util.Map<java.lang.String,java.lang.String> headers,
                                                                                              java.util.List<java.lang.String> cookies)

Create a StreamRequest using the specified parameters. This API should be used if the user has a need to specify custom HTTP method, headers or cookies in advance. The exception to this rule is the Content-Type header which this API will override.

Parameters:

uri - the target URI to be used.

mimeSubType - the mime subtype of the multipart to be used. For example, 'mixed' would result in a Content-Type of 'multipart/mixed'. It is generally good practice to use subtypes described in RFC 1341, although this API does not enforce this.

writer - the MultiPartMIMEWriter to use for the payload of the request.

contentTypeParameters - any additional parameters (i.e "charset") needed when constructing the Content-Type header. These parameters are added after the following prefix: "multipart/; boundary=;". For more details please refer to RFC 822.

method - the HTTP method to use for the request. Details can be found at com.linkedin.r2.message.rest.RestMethod.

headers - a Map specifying the headers to be a part of the final StreamRequest.

cookies - a List of cookies to be placed in the request.

Returns:

the newly created StreamRequest.