com.hellosign.sdk.http

Class AbstractHttpRequest

java.lang.Object

com.hellosign.sdk.http.AbstractHttpRequest

Direct Known Subclasses:

HttpDeleteRequest, HttpGetRequest, HttpOptionsRequest, HttpPostRequest

public abstract class AbstractHttpRequest
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected Authentication	auth
static String	DEFAULT_ENCODING
protected Integer	lastHttpStatusCode
protected InputStream	lastResponseStream
protected String	url
static String	USER_AGENT

Constructor Summary

Constructors

Constructor and Description
AbstractHttpRequest()

Method Summary

Modifier and Type	Method and Description
void	execute() Executes this HTTP request and preserves the response stream and HTTP response code for processing.
protected abstract HttpURLConnection	getConnection() The method class will create the appropriate connection with an endpoint, parameters, etc.
protected static HttpURLConnection	getProxiedConnection(String url) Creates an HTTP connection.
long	getResponseAsFile(File f) Write the last response to a file.
String	getResponseBody() Returns the last response stream as a string.
Integer	getResponseCode() Returns the last HTTP response code.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ENCODING

public static final String DEFAULT_ENCODING

See Also:

Constant Field Values

USER_AGENT

public static final String USER_AGENT

url

protected String url

auth

protected Authentication auth

lastHttpStatusCode

protected Integer lastHttpStatusCode

lastResponseStream

protected InputStream lastResponseStream

Constructor Detail

AbstractHttpRequest

public AbstractHttpRequest()

Method Detail

execute

public void execute()
             throws HelloSignException

Executes this HTTP request and preserves the response stream and HTTP response code for processing.

Throws:

HelloSignException - Thrown if there is an error while making the HTTP request to the HelloSign API.

getResponseCode

public Integer getResponseCode()

Returns the last HTTP response code.

Returns:

Integer response code

getResponseBody

public String getResponseBody()

Returns the last response stream as a string.

Returns:

String

getProxiedConnection

protected static HttpURLConnection getProxiedConnection(String url)
                                                 throws MalformedURLException,
                                                        IOException

Creates an HTTP connection. Optionally checks for proxy parameters and creates a proxied connection using the system properties: "hellosign.proxy.url" - the URL of the HTTP proxy "hellosign.proxy.port" - the port of the HTTP proxy

Parameters:

url - String URL to connect to

Returns:

HttpUrlConnection the (proxied) connection to the URL

Throws:

MalformedURLException - thrown if the URL is invalid

IOException - thrown if IO cannot be established with the URL

getConnection

protected abstract HttpURLConnection getConnection()
                                            throws HelloSignException

The method class will create the appropriate connection with an endpoint, parameters, etc.

Returns:

HttpURLConnection

Throws:

HelloSignException - Thrown if a connection cannot be created

getResponseAsFile

public long getResponseAsFile(File f)
                       throws HelloSignException

Write the last response to a file.

Parameters:

f - File

Returns:

long bytes written

Throws:

HelloSignException - Thrown if an exception occurs during the copy of the response stream to the given file.