org.qbroker.net

Class HTTPClient

java.lang.Object

org.qbroker.net.HTTPClient

All Implemented Interfaces:

HTTPConnector

public class HTTPClient
extends java.lang.Object
implements HTTPConnector

HTTPClient is a wrapper of HttpClient to implement HTTPConnector.

Author:

yannanlu@yahoo.com

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.http.impl.client.CloseableHttpClient	client
protected java.lang.String	uri

Fields inherited from interface org.qbroker.common.HTTPConnector

ACTION_DELETE, ACTION_GET, ACTION_HEAD, ACTION_POST, ACTION_PUT

Constructor Summary

Constructors

Constructor and Description
HTTPClient(java.util.Map props) Creates new HTTPClient

Method Summary

Modifier and Type	Method and Description
void	close()
int	doDelete(java.lang.String urlStr, java.util.Map extra, java.lang.StringBuffer response) It sends a DELETE request to the HTTP server with urlStr and loads the response header to the provided StringBuffer.
int	doDelete(java.lang.String urlStr, java.lang.StringBuffer response)
int	doGet(java.lang.String urlStr, java.util.Map extra, java.lang.StringBuffer response, java.io.OutputStream out) It sends a GET request to the HTTP server with the urlStr and the extra request headers stored in the Map.
int	doGet(java.lang.String urlStr, java.lang.StringBuffer response) It sends a GET request to the HTTP server with the urlStr.
int	doGet(java.lang.String urlStr, java.lang.StringBuffer response, java.io.OutputStream out)
int	doHead(java.lang.String urlStr, java.util.Map extra, java.lang.StringBuffer response) It sends a HEAD request to the HTTP server with the urlStr and loads the response header to the provided StringBuffer.
int	doHead(java.lang.String urlStr, java.lang.StringBuffer response)
int	doPost(java.lang.String urlStr, BytesBuffer buf, java.lang.StringBuffer response) It sends a POST request to the HTTP server with the urlStr and the request content stored in the byte buffer.
int	doPost(java.lang.String urlStr, BytesBuffer buf, java.lang.StringBuffer response, java.io.OutputStream out)
int	doPost(java.lang.String urlStr, java.util.Map extra, BytesBuffer buf, java.lang.StringBuffer response)
int	doPost(java.lang.String urlStr, java.util.Map extra, BytesBuffer buf, java.lang.StringBuffer response, java.io.OutputStream out) It sends a POST request to the HTTP server with the urlStr and the extra request headers, as well as the content stored in the BytesBuffer.
int	doPost(java.lang.String urlStr, java.util.Map extra, java.lang.String line, java.lang.StringBuffer response)
int	doPost(java.lang.String urlStr, java.lang.String line, java.lang.StringBuffer response)
int	doPut(java.lang.String urlStr, BytesBuffer buf, java.lang.StringBuffer response, java.io.OutputStream out)
int	doPut(java.lang.String urlStr, java.util.Map extra, BytesBuffer buf, java.lang.StringBuffer response, java.io.OutputStream out) It sends a PUT request to the HTTP server with the urlStr and the extra request headers, as well as the content stored in the BytesBuffer.
java.lang.String	getURI()
boolean	isConnected() returns true since it is connectionless
boolean	isHTTPS()
boolean	isPost()
static void	main(java.lang.String[] args)
java.lang.String	reconnect() It reconnects and returns null or error message upon failure

Methods inherited from class java.lang.Object

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

Field Detail

client

protected org.apache.http.impl.client.CloseableHttpClient client

uri

protected java.lang.String uri

Constructor Detail

HTTPClient

public HTTPClient(java.util.Map props)

Creates new HTTPClient

Method Detail

doGet

public int doGet(java.lang.String urlStr,
                 java.util.Map extra,
                 java.lang.StringBuffer response,
                 java.io.OutputStream out)
          throws java.io.IOException

It sends a GET request to the HTTP server with the urlStr and the extra request headers stored in the Map. Upon success, it returns the status code of HTTP_OK with the response headers stored in the response buffer and the response content written into the output stream. Otherwise, it returns an error code defined in HttpURLConnection with the error message stored in the response buffer.

Specified by:

doGet in interface HTTPConnector

Throws:

java.io.IOException

doGet

public int doGet(java.lang.String urlStr,
                 java.lang.StringBuffer response,
                 java.io.OutputStream out)
          throws java.io.IOException

Specified by:

doGet in interface HTTPConnector

Throws:

java.io.IOException

doGet

public int doGet(java.lang.String urlStr,
                 java.lang.StringBuffer response)
          throws java.io.IOException

It sends a GET request to the HTTP server with the urlStr. Upon success, it returns the status code of HTTP_OK with the response content stored in the response buffer. Otherwise, it returns an error code defined in HttpURLConnection with the error message stored in the response buffer.

Specified by:

doGet in interface HTTPConnector

Throws:

java.io.IOException

doPost

public int doPost(java.lang.String urlStr,
                  java.util.Map extra,
                  BytesBuffer buf,
                  java.lang.StringBuffer response,
                  java.io.OutputStream out)
           throws java.io.IOException

It sends a POST request to the HTTP server with the urlStr and the extra request headers, as well as the content stored in the BytesBuffer. Upon success, it returns the status code of HTTP_OK with the response headers loaded to the provided StringBuffer and the response content written into the output stream. Otherwise, it returns an error code defined in HttpURLConnection with the error message stored in the response StringBuffer. The response buffer is used for both input and output. The byte buffer is for input only.

NB. urlStr is not supposed to contain any query string.

Specified by:

doPost in interface HTTPConnector

Throws:

java.io.IOException

doPost

public int doPost(java.lang.String urlStr,
                  BytesBuffer buf,
                  java.lang.StringBuffer response,
                  java.io.OutputStream out)
           throws java.io.IOException

Specified by:

doPost in interface HTTPConnector

Throws:

java.io.IOException

doPost

public int doPost(java.lang.String urlStr,
                  BytesBuffer buf,
                  java.lang.StringBuffer response)
           throws java.io.IOException

It sends a POST request to the HTTP server with the urlStr and the request content stored in the byte buffer. Upon success, it returns the status code of HTTP_OK with the response content stored in the response buffer. Otherwise, it returns an error code defined in HttpURLConnection with the error message stored in the response buffer.

Specified by:

doPost in interface HTTPConnector

Throws:

java.io.IOException

doPost

public int doPost(java.lang.String urlStr,
                  java.lang.String line,
                  java.lang.StringBuffer response)
           throws java.io.IOException

Specified by:

doPost in interface HTTPConnector

Throws:

java.io.IOException

doPost

public int doPost(java.lang.String urlStr,
                  java.util.Map extra,
                  BytesBuffer buf,
                  java.lang.StringBuffer response)
           throws java.io.IOException

Specified by:

doPost in interface HTTPConnector

Throws:

java.io.IOException

doPost

public int doPost(java.lang.String urlStr,
                  java.util.Map extra,
                  java.lang.String line,
                  java.lang.StringBuffer response)
           throws java.io.IOException

Specified by:

doPost in interface HTTPConnector

Throws:

java.io.IOException

doPut

public int doPut(java.lang.String urlStr,
                 java.util.Map extra,
                 BytesBuffer buf,
                 java.lang.StringBuffer response,
                 java.io.OutputStream out)
          throws java.io.IOException

It sends a PUT request to the HTTP server with the urlStr and the extra request headers, as well as the content stored in the BytesBuffer. Upon success, it returns the status code of HTTP_OK with the response headers loaded to the provided StringBuffer and the response content written into the output stream. Otherwise, it returns an error code defined in HttpURLConnection with the error message stored in the response StringBuffer. The response buffer is used for both input and output. The byte buffer is for input only.

Specified by:

doPut in interface HTTPConnector

Throws:

java.io.IOException

doPut

public int doPut(java.lang.String urlStr,
                 BytesBuffer buf,
                 java.lang.StringBuffer response,
                 java.io.OutputStream out)
          throws java.io.IOException

Specified by:

doPut in interface HTTPConnector

Throws:

java.io.IOException

doHead

public int doHead(java.lang.String urlStr,
                  java.util.Map extra,
                  java.lang.StringBuffer response)
           throws java.io.IOException

It sends a HEAD request to the HTTP server with the urlStr and loads the response header to the provided StringBuffer. Upon success, it returns the integer of HTTP_OK with the response header stored in the response buffer. Otherwise, it returns an error code defined in HttpURLConnection with the error message stored in the response buffer.

Specified by:

doHead in interface HTTPConnector

Throws:

java.io.IOException

doHead

public int doHead(java.lang.String urlStr,
                  java.lang.StringBuffer response)
           throws java.io.IOException

Specified by:

doHead in interface HTTPConnector

Throws:

java.io.IOException

doDelete

public int doDelete(java.lang.String urlStr,
                    java.util.Map extra,
                    java.lang.StringBuffer response)
             throws java.io.IOException

It sends a DELETE request to the HTTP server with urlStr and loads the response header to the provided StringBuffer. Upon success, it returns the integer of HTTP_OK with the response header stored in the response buffer. Otherwise, it returns an error code defined in HttpURLConnection with the error message stored in the response buffer.

Specified by:

doDelete in interface HTTPConnector

Throws:

java.io.IOException

doDelete

public int doDelete(java.lang.String urlStr,
                    java.lang.StringBuffer response)
             throws java.io.IOException

Specified by:

doDelete in interface HTTPConnector

Throws:

java.io.IOException

close

public void close()

Specified by:

close in interface HTTPConnector

isPost

public boolean isPost()

Specified by:

isPost in interface HTTPConnector

isHTTPS

public boolean isHTTPS()

Specified by:

isHTTPS in interface HTTPConnector

getURI

public java.lang.String getURI()

Specified by:

getURI in interface HTTPConnector

isConnected

public boolean isConnected()

returns true since it is connectionless

Specified by:

isConnected in interface HTTPConnector

reconnect

public java.lang.String reconnect()

It reconnects and returns null or error message upon failure

Specified by:

reconnect in interface HTTPConnector

main

public static void main(java.lang.String[] args)