com.hellosign.sdk.http

Class HttpPostRequest

java.lang.Object

com.hellosign.sdk.http.AbstractHttpRequest

com.hellosign.sdk.http.HttpPostRequest

Direct Known Subclasses:

HttpPutRequest

public class HttpPostRequest
extends AbstractHttpRequest

This utility class provides an abstraction layer for sending multipart HTTP POST requests to a web server.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	method

Fields inherited from class com.hellosign.sdk.http.AbstractHttpRequest

auth, DEFAULT_ENCODING, url, USER_AGENT

Constructor Summary

Constructors

Constructor and Description
HttpPostRequest(String url) Constructor
HttpPostRequest(String url, Authentication auth) Constructor
HttpPostRequest(String url, Map<String,Serializable> fields) Constructor
HttpPostRequest(String url, Map<String,Serializable> fields, Authentication auth) Constructor

Method Summary

Modifier and Type	Method and Description
int	getHttpResponseCode() Performs a field-less POST request to the provided URL using basic auth and returns the HTTP code.
org.json.JSONObject	getJsonResponse() Performs a POST request to the given URL, using the authentication details and POST fields provided.

Methods inherited from class com.hellosign.sdk.http.AbstractHttpRequest

convertStreamToString, validate

Methods inherited from class java.lang.Object

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

Field Detail

method

protected String method

Constructor Detail

HttpPostRequest

public HttpPostRequest(String url)
                throws HelloSignException

Constructor

Parameters:

url - String

Throws:

HelloSignException - thrown if there is a problem making the HTTP request or processing the response

HttpPostRequest

public HttpPostRequest(String url,
                       Authentication auth)
                throws HelloSignException

Constructor

Parameters:

url - String

auth - Authentication

Throws:

HelloSignException - thrown if there is a problem making the HTTP request or processing the response

HttpPostRequest

public HttpPostRequest(String url,
                       Map<String,Serializable> fields)
                throws HelloSignException

Constructor

Parameters:

url - String

fields - Map

Throws:

HelloSignException - thrown if there is a problem making the HTTP request or processing the response

HttpPostRequest

public HttpPostRequest(String url,
                       Map<String,Serializable> fields,
                       Authentication auth)
                throws HelloSignException

Constructor

Parameters:

url - String

fields - Map

auth - Authentication

Throws:

HelloSignException - thrown if there is a problem making the HTTP request or processing the response

Method Detail

getJsonResponse

public org.json.JSONObject getJsonResponse()
                                    throws HelloSignException

Performs a POST request to the given URL, using the authentication details and POST fields provided.

Returns:

JSONObject

Throws:

HelloSignException - thrown if there is a problem making the HTTP request or processing the result

getHttpResponseCode

public int getHttpResponseCode()
                        throws HelloSignException

Performs a field-less POST request to the provided URL using basic auth and returns the HTTP code.

Returns:

int HTTP status code

Throws:

HelloSignException - thrown if there is a problem making the HTTP request or processing the result