com.mgnt.lifecycle.management.httpclient

Class HttpClient

java.lang.Object

com.mgnt.lifecycle.management.httpclient.HttpClient

public class HttpClient
extends java.lang.Object

This class is meant to be a parent class to any class that wants to implement an http access to a particular cite. In this case the extending class may inherit from this class, set a predefined connectionUrl property and then simply add some methods that would be used to contact some different sub-urls with the same url base. Those methods may receive some parameters that would enable to build final url based on pre-set base url. However this class may be used on its own as well. All you will need to do is to set a value for content type using method setContentType(String) if needed, or/and any other request property using method setRequestProperty(String, String) and then just call method sendHttpRequest(String, HttpMethod) or sendHttpRequest(String, HttpMethod, String) (or if the reply is expected to be binary such as image then call the methods sendHttpRequestForBinaryResponse(String, HttpMethod) or sendHttpRequestForBinaryResponse(String, HttpMethod, String))

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HttpClient.HttpMethod

Constructor Summary

Constructors

Constructor and Description
HttpClient()

Method Summary

Modifier and Type	Method and Description
void	clearAllRequestProperties() This method clears all request properties.
java.lang.String	getConnectionUrl() This method is a getter for connectionUrl property which only makes sense if that property was set.
java.lang.String	getContentType() This is getter method for content type property.
protected java.lang.String	getDefaultContentType() This method is intended to be overridden by extending classes if those classes provide methods that send requests with the same content type
protected java.net.HttpURLConnection	openHttpUrlConnection(java.lang.String url, HttpClient.HttpMethod method) This method creates and opens HttpURLConnection to specified URL The connection's property doOutput is set to false
protected java.net.HttpURLConnection	openHttpUrlConnection(java.lang.String url, HttpClient.HttpMethod method, boolean doOutput) This method creates and opens HttpURLConnection to specified URL.
java.lang.String	removeRequestProperty(java.lang.String propertyName) This method removes request property
java.lang.String	sendHttpRequest(HttpClient.HttpMethod callMethod) This method sends HTTP request to pre-set URL.
java.lang.String	sendHttpRequest(HttpClient.HttpMethod callMethod, java.lang.String data) This method sends HTTP request to pre-set URL.
java.lang.String	sendHttpRequest(java.lang.String requestUrl, HttpClient.HttpMethod callMethod) This method sends HTTP request to specified URL and uses specified HTTP method.
java.lang.String	sendHttpRequest(java.lang.String requestUrl, HttpClient.HttpMethod callMethod, java.lang.String data) This method sends HTTP request to specified URL, uses specified HTTP method and sends data through request body.
java.nio.ByteBuffer	sendHttpRequestForBinaryResponse(HttpClient.HttpMethod callMethod) This method sends HTTP request to pre-set URL.
java.nio.ByteBuffer	sendHttpRequestForBinaryResponse(HttpClient.HttpMethod callMethod, java.lang.String data) This method sends HTTP request to pre-set URL.
java.nio.ByteBuffer	sendHttpRequestForBinaryResponse(java.lang.String requestUrl, HttpClient.HttpMethod callMethod) This method is the same as sendHttpRequest(String, HttpMethod) except that it returns ByteBuffer that holds binary info.
java.nio.ByteBuffer	sendHttpRequestForBinaryResponse(java.lang.String requestUrl, HttpClient.HttpMethod callMethod, java.lang.String data) This method is the same as sendHttpRequest(String, HttpMethod, String) except that it returns ByteBuffer that holds binary info.
void	setConnectionUrl(java.lang.String connectionUrl) Setter for connectionUrl property.
void	setContentType(java.lang.String contentType) This is setter method for content type property.
void	setRequestProperty(java.lang.String propertyName, java.lang.String value) This method is a general request property setter.

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpClient

public HttpClient()

Method Detail

getConnectionUrl

public java.lang.String getConnectionUrl()

This method is a getter for connectionUrl property which only makes sense if that property was set. Setting this property is intended for extending classes if such class provides several methods contacting urls based on the same base url. In this case building the final url for each such method can use base url that is common for them

Returns:

String that holds common URL prefix

setConnectionUrl

public void setConnectionUrl(java.lang.String connectionUrl)

Setter for connectionUrl property. This method is intended for use by extending classes if they provide methods that contact URLs that have common prefix

Parameters:

connectionUrl -

sendHttpRequest

public java.lang.String sendHttpRequest(HttpClient.HttpMethod callMethod)
                                 throws java.io.IOException

This method sends HTTP request to pre-set URL. It uses method getConnectionUrl() to get the URL and uses specified HTTP method. Obviously it is expected that user should set connectionUrl property by invoking method setConnectionUrl(String) beforehand. It returns response that is expected to be textual such as a String. This method does not send any info through request body. It may send parameters through URL. So this method fits perfectly for using HTTP GET method. If HTTP request uses method POST, PUT or any other methods that allow passing info in the request body and there is some info to be sent then use method sendHttpRequest(HttpMethod, String)

Parameters:

callMethod - HttpClient.HttpMethod that specifies which HTTP method is to be used

Returns:

String that holds response from the URL

Throws:

java.io.IOException

sendHttpRequest

public java.lang.String sendHttpRequest(java.lang.String requestUrl,
                                        HttpClient.HttpMethod callMethod)
                                 throws java.io.IOException

This method sends HTTP request to specified URL and uses specified HTTP method. It returns response that is expected to be textual such as a String. This method does not send any info through request body. It may send parameters through URL. So this method fits perfectly for using HTTP GET method. If HTTP request uses method POST, PUT or any other methods that allow passing info in the request body and there is some info to be sent then use method sendHttpRequest(String, HttpMethod, String)

Parameters:

requestUrl - URL to which request is to be sent

callMethod - HttpClient.HttpMethod that specifies which HTTP method is to be used

Returns:

String that holds response from the URL

Throws:

java.io.IOException

sendHttpRequest

public java.lang.String sendHttpRequest(HttpClient.HttpMethod callMethod,
                                        java.lang.String data)
                                 throws java.io.IOException

This method sends HTTP request to pre-set URL. It uses method getConnectionUrl() to get the URL and uses specified HTTP method and sends data through request body. Obviously it is expected that user should set connectionUrl property by invoking method setConnectionUrl(String) beforehand. It returns response that is expected to be textual such as a String. This method fits for using HTTP methods POST, PUT or any other methods that allow passing info in the body request and there is some info to be sent. If you don't need to send any info as request body, consider using method sendHttpRequest(HttpMethod)

Parameters:

callMethod - HttpClient.HttpMethod that specifies which HTTP method is to be used

data - String that holds the data to be sent as request body

Returns:

String that holds response from the URL

Throws:

java.io.IOException

sendHttpRequest

public java.lang.String sendHttpRequest(java.lang.String requestUrl,
                                        HttpClient.HttpMethod callMethod,
                                        java.lang.String data)
                                 throws java.io.IOException

This method sends HTTP request to specified URL, uses specified HTTP method and sends data through request body. It returns response that is expected to be textual such as a String. This method fits for using HTTP methods POST, PUT or any other methods that allow passing info in the body request and there is some info to be sent. If you don't need to send any info as request body, consider using method sendHttpRequest(String, HttpMethod)

Parameters:

requestUrl - URL to which request is to be sent

callMethod - HttpClient.HttpMethod that specifies which HTTP method is to be used

data - String that holds the data to be sent as request body

Returns:

String that holds response from the URL

Throws:

java.io.IOException

sendHttpRequestForBinaryResponse

public java.nio.ByteBuffer sendHttpRequestForBinaryResponse(HttpClient.HttpMethod callMethod)
                                                     throws java.io.IOException

This method sends HTTP request to pre-set URL. It uses method getConnectionUrl() to get the URL and uses specified HTTP method. Obviously it is expected that user should set connectionUrl property by invoking method setConnectionUrl(String) beforehand. This method is the same as sendHttpRequest(HttpMethod) except that it returns ByteBuffer that holds binary info. So this methods fits for retrieving binary response such as Image, Video, Audio or any other info in binary format.

Parameters:

callMethod - HttpClient.HttpMethod that specifies which HTTP method is to be used

Returns:

ByteBuffer that holds response from URL

Throws:

java.io.IOException

sendHttpRequestForBinaryResponse

public java.nio.ByteBuffer sendHttpRequestForBinaryResponse(java.lang.String requestUrl,
                                                            HttpClient.HttpMethod callMethod)
                                                     throws java.io.IOException

This method is the same as sendHttpRequest(String, HttpMethod) except that it returns ByteBuffer that holds binary info. So this methods fits for retrieving binary response such as Image, Video, Audio or any other info in binary format.

Parameters:

requestUrl - URL to which request is to be sent

callMethod - HttpClient.HttpMethod that specifies which HTTP method is to be used

Returns:

ByteBuffer that holds response from URL

Throws:

java.io.IOException

sendHttpRequestForBinaryResponse

public java.nio.ByteBuffer sendHttpRequestForBinaryResponse(HttpClient.HttpMethod callMethod,
                                                            java.lang.String data)
                                                     throws java.io.IOException

This method sends HTTP request to pre-set URL. It uses method getConnectionUrl() to get the URL and uses specified HTTP method. Obviously it is expected that user should set connectionUrl property by invoking method setConnectionUrl(String) beforehand. This method is the same as sendHttpRequest(HttpMethod, String) except that it returns ByteBuffer that holds binary info. So this methods fits for retrieving binary response such as Image, Video, Audio or any other info in binary format.

Parameters:

callMethod - HttpClient.HttpMethod that specifies which HTTP method is to be used

data - String that holds the data to be sent as request body

Returns:

ByteBuffer that holds response from URL

Throws:

java.io.IOException

sendHttpRequestForBinaryResponse

public java.nio.ByteBuffer sendHttpRequestForBinaryResponse(java.lang.String requestUrl,
                                                            HttpClient.HttpMethod callMethod,
                                                            java.lang.String data)
                                                     throws java.io.IOException

This method is the same as sendHttpRequest(String, HttpMethod, String) except that it returns ByteBuffer that holds binary info. So this methods fits for retrieving binary response such as Image, Video, Audio or any other info in binary format.

Parameters:

requestUrl - URL to which request is to be sent

callMethod - HttpClient.HttpMethod that specifies which HTTP method is to be used

data - String that holds the data to be sent as request body

Returns:

ByteBuffer that holds response from URL

Throws:

java.io.IOException

getDefaultContentType

protected java.lang.String getDefaultContentType()

This method is intended to be overridden by extending classes if those classes provide methods that send requests with the same content type

Returns:

default content type (See getContentType())

getContentType

public java.lang.String getContentType()

This is getter method for content type property. Returns default value if the property was not set. This method intended for use in extending classes

Returns:

content type property value or default value if the property was not set

setRequestProperty

public void setRequestProperty(java.lang.String propertyName,
                               java.lang.String value)

This method is a general request property setter.

Parameters:

propertyName - if the value of property name is blank or null this method does nothing

value - Holds the value for the property

removeRequestProperty

public java.lang.String removeRequestProperty(java.lang.String propertyName)

This method removes request property

Parameters:

propertyName - if the value of propertyName is blank or null this method does nothing and returns null

Returns:

the value that has been removed or null if the propertyName key was not present in the properties

clearAllRequestProperties

public void clearAllRequestProperties()

This method clears all request properties.

setContentType

public void setContentType(java.lang.String contentType)

This is setter method for content type property. This method intended for use in extending classes

Parameters:

contentType - holds content type value

openHttpUrlConnection

protected java.net.HttpURLConnection openHttpUrlConnection(java.lang.String url,
                                                           HttpClient.HttpMethod method)
                                                    throws java.io.IOException

This method creates and opens HttpURLConnection to specified URL The connection's property doOutput is set to false

Parameters:

url - Url to be connected to

method - HttpClient.HttpMethod that specifies which HTTP Method to use

Returns:

opened HttpURLConnection

Throws:

java.io.IOException

openHttpUrlConnection

protected java.net.HttpURLConnection openHttpUrlConnection(java.lang.String url,
                                                           HttpClient.HttpMethod method,
                                                           boolean doOutput)
                                                    throws java.io.IOException

This method creates and opens HttpURLConnection to specified URL.

Parameters:

url - Url to be connected to

method - HttpClient.HttpMethod that specifies which HTTP Method to use

doOutput - boolean value that specifies how to set connection's doOutput property

Returns:

opened HttpURLConnection

Throws:

java.io.IOException