com.y0ga.Networking

Class WebClient

java.lang.Object

com.y0ga.Networking.WebClient

public class WebClient
extends java.lang.Object

The client object that can perform http requests.

Constructor Summary

Constructors

Constructor and Description
WebClient()

Method Summary

Modifier and Type	Method and Description
void	downloadData(java.net.URL url, java.io.OutputStream output) Sends a GET request.
AsyncTask	downloadDataAsync(java.net.URL url, java.io.OutputStream output) Asynchronously sends a GET request.
void	downloadFile(java.net.URL url, java.io.File localFile) Sends a GET request.
AsyncTask	downloadFileAsync(java.net.URL remoteFileUrl, java.io.File localFile) Asynchronously sends a GET request.
java.lang.String	downloadString(java.net.URL url) Sends a GET request.
AsyncTask<java.lang.String>	downloadStringAsync(java.net.URL url) Asynchronously sends a GET request.
int	getRunningTaskCount()
java.util.HashMap<java.lang.String,java.lang.String>	Headers()
boolean	isBusy()
void	setBufferSize(int bufferSize) Defines the size in bytes of the buffer that is used to copy streams in both upload/download operations.
void	setDownloadBandwidthLimit(BandwidthLimitation downloadLimit) Defines the maximum bytes per second limit for download operations.
void	setEncoding(java.nio.charset.Charset charset) Sets the encoding used to encode and decode strings.
void	setLimitationMode(LimitationMode mode) Sets the bandwidth limitation mode.
void	setUploadBandwidthLimit(BandwidthLimitation uploadLimit) Defines the maximum bytes per second limit for upload operations.
void	setUserAgent(java.lang.String userAgent) Sets the "User-Agent" header value in every request.
void	uploadData(java.net.URL url, java.io.InputStream data, java.io.OutputStream output) Sends a POST request.
AsyncTask	uploadDataAsync(java.net.URL url, java.io.InputStream input, java.io.OutputStream output) Asynchronously sends a POST request.
java.lang.String	uploadString(java.net.URL url, java.lang.String string) Sends a POST request.
AsyncTask<java.lang.String>	uploadStringAsync(java.net.URL url, java.lang.String string) Asynchronously sends a POST request.

Methods inherited from class java.lang.Object

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

Constructor Detail

WebClient

public WebClient()

Method Detail

setDownloadBandwidthLimit

public void setDownloadBandwidthLimit(BandwidthLimitation downloadLimit)
                               throws IllegalBandwidthException

Defines the maximum bytes per second limit for download operations. Default is unlimited.

Throws:

IllegalBandwidthException

setUploadBandwidthLimit

public void setUploadBandwidthLimit(BandwidthLimitation uploadLimit)
                             throws IllegalBandwidthException

Defines the maximum bytes per second limit for upload operations. Default is unlimited.

Throws:

IllegalBandwidthException

setBufferSize

public void setBufferSize(int bufferSize)
                   throws InvalidBufferSizeException

Defines the size in bytes of the buffer that is used to copy streams in both upload/download operations. Default size is 4096 bytes .

Throws:

InvalidBufferSizeException - If the bufferSize parameter is not a power of 2.

setUserAgent

public void setUserAgent(java.lang.String userAgent)

Sets the "User-Agent" header value in every request.

setEncoding

public void setEncoding(java.nio.charset.Charset charset)

Sets the encoding used to encode and decode strings.

setLimitationMode

public void setLimitationMode(LimitationMode mode)

Sets the bandwidth limitation mode.

Headers

public java.util.HashMap<java.lang.String,java.lang.String> Headers()

Returns:

A HashMap containing the "additional" headers that will be sent for every request.

isBusy

public boolean isBusy()

Returns:

A boolean that indicates if the current WebClient instance is working on any kind of task.

See Also:

getRunningTaskCount()

getRunningTaskCount

public int getRunningTaskCount()

Returns:

The count of asynchronous and synchronous tasks running within the current WebClient instance.

See Also:

isBusy()

downloadData

public void downloadData(java.net.URL url,
                         java.io.OutputStream output)
                  throws java.io.IOException

Sends a GET request.

Parameters:

output - The output stream to which the response bytes will be written.

Throws:

java.io.IOException

downloadString

public java.lang.String downloadString(java.net.URL url)
                                throws java.io.IOException

Sends a GET request.

Returns:

The response content as a string.

Throws:

java.io.IOException

downloadFile

public void downloadFile(java.net.URL url,
                         java.io.File localFile)
                  throws java.io.IOException

Sends a GET request.

Parameters:

localFile - The local file to which the response bytes will be written.

Throws:

java.io.IOException

uploadData

public void uploadData(java.net.URL url,
                       java.io.InputStream data,
                       java.io.OutputStream output)
                throws java.io.IOException

Sends a POST request.

Parameters:

data - The input stream containing the POST request content.

output - The output stream that will contain the POST response content.

Throws:

java.io.IOException

uploadString

public java.lang.String uploadString(java.net.URL url,
                                     java.lang.String string)
                              throws java.io.IOException

Sends a POST request.

Parameters:

string - The input string used as the POST request content. * @return

Throws:

java.io.IOException

downloadDataAsync

public AsyncTask downloadDataAsync(java.net.URL url,
                                   java.io.OutputStream output)

Asynchronously sends a GET request.

Parameters:

output - The output stream to which the response bytes will be written.

Returns:

A typeless AsyncTask that can be awaited.

downloadStringAsync

public AsyncTask<java.lang.String> downloadStringAsync(java.net.URL url)

Asynchronously sends a GET request.

Returns:

The response content as a string wrapped in an AsyncTask that can be awaited.

downloadFileAsync

public AsyncTask downloadFileAsync(java.net.URL remoteFileUrl,
                                   java.io.File localFile)

Asynchronously sends a GET request.

Parameters:

localFile - The local file to which the response bytes will be written.

Returns:

A typeless AsyncTask that can be awaited.

uploadDataAsync

public AsyncTask uploadDataAsync(java.net.URL url,
                                 java.io.InputStream input,
                                 java.io.OutputStream output)

Asynchronously sends a POST request.

Parameters:

input - The input stream containing the POST request content.

output - The output stream that will contain the POST response content.

Returns:

A typeless AsyncTask that can be awaited.

uploadStringAsync

public AsyncTask<java.lang.String> uploadStringAsync(java.net.URL url,
                                                     java.lang.String string)

Asynchronously sends a POST request.

Parameters:

string - The input string used as the POST request content.

Returns:

The response content as a string wrapped in an AsyncTask that can be awaited.