de.xima.fc.http

Class PostRequestBuilder

java.lang.Object

de.xima.fc.http.PostRequestBuilder

Direct Known Subclasses:

PostRequestHelper

public class PostRequestBuilder
extends Object

Constructor Summary

Constructors

Constructor and Description
PostRequestBuilder(String requestURL, String inCharset, String outCharset, boolean useSinglePart) This constructor initializes a new HTTP POST request with content type is set to multipart/form-data
PostRequestBuilder(String requestURL, String inCharset, String outCharset, Proxy proxy, String proxyAuthLogin, String proxyAuthPwd, boolean useSinglePart) This constructor initializes a new HTTP POST request with content type is set to multipart/form-data and uses a proxy server
PostRequestBuilder(String requestURL, String inCharset, String outCharset, String basicAuthLogin, String basicAuthPwd, Proxy proxy, String proxyAuthLogin, String proxyAuthPwd, boolean useSinglePart) This constructor initializes a new HTTP POST request with content type is set to multipart/form-data and uses a proxy server

Method Summary

Modifier and Type	Method and Description
PostRequestBuilder	addFilePart(String fieldName, byte[] uploadFile, String fileName, String contentType) Adds a upload file section to the request
PostRequestBuilder	addFormField(String name, String value) Adds a form field to the request
PostRequestResult	build() Completes the request and receives response from the server.
PostRequestResult	finish() Deprecated. use build(), always return null !!!
boolean	isMaskAmp()
PostRequestBuilder	setMaskAmp(boolean maskAmp)

Methods inherited from class java.lang.Object

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

Constructor Detail

PostRequestBuilder

public PostRequestBuilder(String requestURL,
                          String inCharset,
                          String outCharset,
                          boolean useSinglePart)
                   throws IOException

This constructor initializes a new HTTP POST request with content type is set to multipart/form-data

Parameters:

requestURL - the request URL

inCharset - the charset to user for the input

outCharset - the charset to user for the output

useSinglePart - Boolean if the post should be done as singeplart

Throws:

IOException - on errors during the post request

PostRequestBuilder

public PostRequestBuilder(String requestURL,
                          String inCharset,
                          String outCharset,
                          Proxy proxy,
                          String proxyAuthLogin,
                          String proxyAuthPwd,
                          boolean useSinglePart)
                   throws IOException

This constructor initializes a new HTTP POST request with content type is set to multipart/form-data and uses a proxy server

Parameters:

requestURL - the request URL

inCharset - the charset to user for the input

outCharset - the charset to user for the output

proxy - the Proxy to user

proxyAuthLogin - the login name for the proxy

proxyAuthPwd - the login password for the proxy

useSinglePart - Boolean if the post should be done as singeplart

Throws:

IOException - on errors during the post request

PostRequestBuilder

public PostRequestBuilder(String requestURL,
                          String inCharset,
                          String outCharset,
                          String basicAuthLogin,
                          String basicAuthPwd,
                          Proxy proxy,
                          String proxyAuthLogin,
                          String proxyAuthPwd,
                          boolean useSinglePart)
                   throws IOException

This constructor initializes a new HTTP POST request with content type is set to multipart/form-data and uses a proxy server

Parameters:

requestURL - the request URL

inCharset - the charset to user for the input

outCharset - the charset to user for the output

basicAuthLogin - the basicAuth login name

basicAuthPwd - the basicAuth password

proxy - the Proxy to user

proxyAuthLogin - the login name for the proxy

proxyAuthPwd - the login password for the proxy

useSinglePart - Boolean if the post should be done as singeplart

Throws:

IOException - on errors during the post request

Method Detail

isMaskAmp

public boolean isMaskAmp()

setMaskAmp

public PostRequestBuilder setMaskAmp(boolean maskAmp)

addFormField

public PostRequestBuilder addFormField(String name,
                                       String value)

Adds a form field to the request

Parameters:

name - field name

value - field value

addFilePart

public PostRequestBuilder addFilePart(String fieldName,
                                      byte[] uploadFile,
                                      String fileName,
                                      String contentType)
                               throws IOException

Adds a upload file section to the request

Parameters:

fieldName - name attribute in

uploadFile - a File to be uploaded

Throws:

IOException - on errors when writing the file part to the OutputStream

build

public PostRequestResult build()
                        throws IOException

Completes the request and receives response from the server.

Returns:

a list of Strings as response in case the server returned status OK, otherwise an exception is thrown.

Throws:

IOException - on errors during building the request

finish

@Deprecated
public PostRequestResult finish()
                                     throws IOException

Deprecated. use build(), always return null !!!

Throws:

IOException