com.github.dannil.scbjavaclient.communication.http.requester

Class AbstractRequester

java.lang.Object

com.github.dannil.scbjavaclient.communication.http.requester.AbstractRequester

Direct Known Subclasses:

GETRequester, POSTRequester

public abstract class AbstractRequester
extends Object

Class which contains the logic for sending URL requests to a specified address.

Since:

1.2.0

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractRequester() Default constructor.
protected	AbstractRequester(Charset charset) Overloaded constructor.

Method Summary

Modifier and Type	Method and Description
Charset	getCharset() Getter for charset.
protected URLConnection	getConnection(String url) Retrieves the URLConnection that represents the specified URL.
abstract HttpResponse	getResponse(String url) Retrieves the response from the specified URL.
protected HttpResponse	getResponse(URLConnection connection) Retrieves the response from the specified URLConnection.
void	setCharset(Charset charset) Setter for charset.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractRequester

protected AbstractRequester()

Default constructor. Specifies the charset to be used for requests as UTF-8.

AbstractRequester

protected AbstractRequester(Charset charset)

Overloaded constructor. Loads the request properties and other data needed for the requesters.

Parameters:

charset - the charset to use when doing a request

Method Detail

getConnection

protected URLConnection getConnection(String url)
                               throws IOException

Retrieves the URLConnection that represents the specified URL. This method sets the request properties for the URLConnection being retrieved.

Parameters:

url - the URL

Returns:

a URLConnection

Throws:

IOException - if an exception occurred when creating the URLConnection

getResponse

protected HttpResponse getResponse(URLConnection connection)
                            throws IOException

Retrieves the response from the specified URLConnection.

Parameters:

connection - the URLConnection

Returns:

the response as an Response

Throws:

IOException - if an exception occurred while retrieving the Response

getResponse

public abstract HttpResponse getResponse(String url)

Retrieves the response from the specified URL.

Parameters:

url - the URL to call

Returns:

the response as an Response

getCharset

public final Charset getCharset()

Getter for charset.

Returns:

the charset

setCharset

public final void setCharset(Charset charset)

Setter for charset.

Parameters:

charset - the charset