org.qbroker.common

Interface HTTPConnector

All Known Implementing Classes:

HTTPClient, HTTPConnector

public interface HTTPConnector

Field Summary

Fields

Modifier and Type	Field and Description
static int	ACTION_DELETE
static int	ACTION_GET
static int	ACTION_HEAD
static int	ACTION_POST
static int	ACTION_PUT

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()
boolean	isHTTPS()
boolean	isPost()
java.lang.String	reconnect() reconnects and returns null upon success or error msg otherwise

Field Detail

ACTION_HEAD

static final int ACTION_HEAD

See Also:

Constant Field Values

ACTION_GET

static final int ACTION_GET

See Also:

Constant Field Values

ACTION_PUT

static final int ACTION_PUT

See Also:

Constant Field Values

ACTION_POST

static final int ACTION_POST

See Also:

Constant Field Values

ACTION_DELETE

static final int ACTION_DELETE

See Also:

Constant Field Values

Method Detail

doGet

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.

Throws:

java.io.IOException

doGet

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

Throws:

java.io.IOException

doGet

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.

Throws:

java.io.IOException

doPost

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.

Throws:

java.io.IOException

doPost

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

Throws:

java.io.IOException

doPost

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.

Throws:

java.io.IOException

doPost

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

Throws:

java.io.IOException

doPost

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

Throws:

java.io.IOException

doPost

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

Throws:

java.io.IOException

doPut

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.

Throws:

java.io.IOException

doPut

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

Throws:

java.io.IOException

doHead

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.

Throws:

java.io.IOException

doHead

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

Throws:

java.io.IOException

doDelete

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.

Throws:

java.io.IOException

doDelete

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

Throws:

java.io.IOException

isPost

boolean isPost()

isHTTPS

boolean isHTTPS()

reconnect

java.lang.String reconnect()

reconnects and returns null upon success or error msg otherwise

isConnected

boolean isConnected()

getURI

java.lang.String getURI()

close

void close()