Package com.oorian.apis

Class MultipartRequest

java.lang.Object

com.oorian.apis.ApiHttpRequest

com.oorian.apis.MultipartRequest

Direct Known Subclasses:

MultipartPostRequest, MultipartPutRequest

public abstract class MultipartRequest
extends ApiHttpRequest

Abstract base class for multipart HTTP requests that support form parameters and file uploads.

Builds multipart/form-data request bodies with automatically generated boundary strings. Subclasses specify the HTTP method (POST or PUT).

Field Summary

Fields inherited from class com.oorian.apis.ApiHttpRequest

DELETE, GET, POST, PUT

Constructor Summary

Constructors

Constructor	Description
MultipartRequest(int method, String url)	Creates a new multipart request with the specified HTTP method and URL.

Method Summary

Modifier and Type	Method	Description
FileParameter	addFile(File file)	Adds a file to this multipart request.
FileParameter	addFile(String paramName, File file)	Adds a file to this multipart request with a specified form field name.
FileParameter	addFile(String fileName, FileInputStream fileInputStream)	Adds a file to this multipart request from an input stream.
FileParameter	addFile(String paramName, String fileName, FileInputStream fileInputStream)	Adds a file to this multipart request from an input stream with a specified form field name.
RequestParameter	addParameter(String name, String value)	Adds a form parameter to this multipart request.
protected HttpRequest.BodyPublisher	getData()

Methods inherited from class com.oorian.apis.ApiHttpRequest

addHeader, addHeaders, getCharset, getHeaders, getResponse, getUrl, getUrlConnection, send, send, setCharset, setConnectTimeout, setContentType, setReadTimeout, setUrl

Methods inherited from class java.lang.Object

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

Constructor Details

MultipartRequest

public MultipartRequest(int method,
 String url)

Creates a new multipart request with the specified HTTP method and URL.

Parameters:

method - the HTTP method constant.

url - the target URL.

Method Details

addParameter

public RequestParameter addParameter(String name,
 String value)

Adds a form parameter to this multipart request.

Parameters:

name - the parameter name.

value - the parameter value.

Returns:

the created request parameter.

addFile

public FileParameter addFile(String paramName,
 File file)
                      throws FileNotFoundException

Adds a file to this multipart request with a specified form field name.

Parameters:

paramName - the form field name.

file - the file to upload.

Returns:

the created file parameter.

Throws:

FileNotFoundException - if the file does not exist.

addFile

public FileParameter addFile(File file)
                      throws FileNotFoundException

Adds a file to this multipart request.

Parameters:

file - the file to upload.

Returns:

the created file parameter.

Throws:

FileNotFoundException - if the file does not exist.

addFile

public FileParameter addFile(String paramName,
 String fileName,
 FileInputStream fileInputStream)

Adds a file to this multipart request from an input stream with a specified form field name.

Parameters:

paramName - the form field name.

fileName - the file name.

fileInputStream - the input stream containing the file data.

Returns:

the created file parameter.

addFile

public FileParameter addFile(String fileName,
 FileInputStream fileInputStream)

Adds a file to this multipart request from an input stream.

Parameters:

fileName - the file name.

fileInputStream - the input stream containing the file data.

Returns:

the created file parameter.

getData

protected HttpRequest.BodyPublisher getData()
                                     throws HttpRequestException

Specified by:

getData in class ApiHttpRequest

Throws:

HttpRequestException