com.hellosign.sdk.http

Class HttpGetRequest

java.lang.Object

com.hellosign.sdk.http.AbstractHttpRequest

com.hellosign.sdk.http.HttpGetRequest

public class HttpGetRequest
extends AbstractHttpRequest

Field Summary

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

auth, DEFAULT_ENCODING, url, USER_AGENT

Constructor Summary

Constructors

Constructor and Description
HttpGetRequest(String url) Constructor
HttpGetRequest(String url, Authentication auth) Constructor
HttpGetRequest(String url, Map<String,String> parameters) Constructor
HttpGetRequest(String url, Map<String,String> parameters, Authentication auth) Constructor

Method Summary

Modifier and Type	Method and Description
File	getFileResponse(String filename) Execute the GET request and process the response as a file.
org.json.JSONObject	getJsonResponse() Executes the GET request and converts the response to a JSON object.

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

convertStreamToString, getConnection, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpGetRequest

public HttpGetRequest(String url)
               throws HelloSignException

Constructor

Parameters:

url - String

Throws:

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

HttpGetRequest

public HttpGetRequest(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

HttpGetRequest

public HttpGetRequest(String url,
                      Map<String,String> parameters)
               throws HelloSignException

Constructor

Parameters:

url - String

parameters - Map

Throws:

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

HttpGetRequest

public HttpGetRequest(String url,
                      Map<String,String> parameters,
                      Authentication auth)
               throws HelloSignException

Constructor

Parameters:

url - String

parameters - 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

Executes the GET request and converts the response to a JSON object.

Returns:

JSONObject

Throws:

HelloSignException - thrown if there is a problem making the HTTP request.

getFileResponse

public File getFileResponse(String filename)
                     throws HelloSignException

Execute the GET request and process the response as a file. The file will be stored as a temporary file with the given filename, but using the File.createTemporaryFile() method. This file will append a timestamp to the filename.

Parameters:

filename - String

Returns:

File

Throws:

HelloSignException - thrown if there is a problem creating the file