com.aftia.plugin.helpers

Class HttpUtils

java.lang.Object

com.aftia.plugin.helpers.HttpUtils

public class HttpUtils
extends Object

A helper class which contains helper methods related to HTTP calls

Author:

Guillaume

Field Summary

Fields

Modifier and Type	Field and Description
static String	HTTP_PREFIX
static String	HTTPS_PREFIX

Constructor Summary

Constructors

Constructor and Description
HttpUtils()

Method Summary

Modifier and Type	Method and Description
static org.apache.http.entity.mime.MultipartEntity	buildMultipartRequest(Map<String,org.apache.sling.api.request.RequestParameter[]> params) Takes a map of parameters, and adds them to a multipart entity that can be used
static HttpURLConnection	cloneConnection(HttpURLConnection httpURLConnection) Deprecated. - Not in use
static HttpURLConnection	cloneConnection(String remoteHostUri, String basicAuthToken, javax.servlet.http.HttpServletRequest httpServletRequest) A connection clone method.
static String	createQueryString(Map<String,String> params)
static String	getBasicAuthToken(String username, String password) Create a new Basic Authentication token for use in an Authorization header
static void	httpRequest(HttpsURLConnection httpsURLConnection, OutputStream outputStream) A helper to handle submitting custom HttpsURLConnection
static void	httpRequest(HttpURLConnection httpsURLConnection, OutputStream outputStream) A helper to handle submitting custom HttpURLConnection
static void	httpRequest(String requestURL, String basicAuthToken, String method, OutputStream outputStream) A convenience request handler to submit generic GET/POST requests to endpoints
static Map<String,org.apache.sling.api.request.RequestParameter[]>	parseMultipartParams(org.apache.sling.api.SlingHttpServletRequest request) Parses multipart parameters and returns a map or RequestParameters
static void	proxyRequest(String remoteHostUri, String basicAuthToken, String acceptedResponse, boolean enforceSSL, org.apache.sling.api.SlingHttpServletRequest request, org.apache.sling.api.SlingHttpServletResponse response) A method used to request delegation.

Methods inherited from class java.lang.Object

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

Field Detail

HTTPS_PREFIX

public static final String HTTPS_PREFIX

See Also:

Constant Field Values

HTTP_PREFIX

public static final String HTTP_PREFIX

See Also:

Constant Field Values

Constructor Detail

HttpUtils

public HttpUtils()

Method Detail

getBasicAuthToken

public static String getBasicAuthToken(String username,
                                       String password)

Create a new Basic Authentication token for use in an Authorization header

Parameters:

username -

password -

Returns:

string

createQueryString

public static String createQueryString(Map<String,String> params)
                                throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

httpRequest

public static void httpRequest(String requestURL,
                               String basicAuthToken,
                               String method,
                               OutputStream outputStream)
                        throws ServerException,
                               IOException

A convenience request handler to submit generic GET/POST requests to endpoints

Parameters:

requestURL -

basicAuthToken -

method -

outputStream -

Throws:

ServerException

IOException

httpRequest

public static void httpRequest(HttpsURLConnection httpsURLConnection,
                               OutputStream outputStream)
                        throws ServerException,
                               IOException

A helper to handle submitting custom HttpsURLConnection

Parameters:

httpsURLConnection -

basicAuthToken -

method -

outputStream -

Throws:

ServerException

IOException

httpRequest

public static void httpRequest(HttpURLConnection httpsURLConnection,
                               OutputStream outputStream)
                        throws ServerException,
                               IOException

A helper to handle submitting custom HttpURLConnection

Parameters:

httpsURLConnection -

basicAuthToken -

method -

outputStream -

Throws:

ServerException

IOException

proxyRequest

public static void proxyRequest(String remoteHostUri,
                                String basicAuthToken,
                                String acceptedResponse,
                                boolean enforceSSL,
                                org.apache.sling.api.SlingHttpServletRequest request,
                                org.apache.sling.api.SlingHttpServletResponse response)
                         throws ServerException,
                                IOException,
                                javax.servlet.ServletException

A method used to request delegation. This method will instantiate a new request to a remote host and stream it's contents to the provided response, therefore acting as a basic proxy. NOTE: This method will commit the provided response. A committed response can no longer be modified.

Parameters:

remoteHostUri -

basicAuthToken -

enforceSSL -

request -

response -

Throws:

ServerException

IOException

javax.servlet.ServletException

buildMultipartRequest

public static org.apache.http.entity.mime.MultipartEntity buildMultipartRequest(Map<String,org.apache.sling.api.request.RequestParameter[]> params)
                                                                         throws IOException

Takes a map of parameters, and adds them to a multipart entity that can be used

Parameters:

params -

Returns:

MultipartEntity

Throws:

IOException

parseMultipartParams

public static Map<String,org.apache.sling.api.request.RequestParameter[]> parseMultipartParams(org.apache.sling.api.SlingHttpServletRequest request)
                                                                                        throws javax.servlet.ServletException

Parses multipart parameters and returns a map or RequestParameters

Parameters:

request -

Returns:

params

Throws:

javax.servlet.ServletException

cloneConnection

public static HttpURLConnection cloneConnection(HttpURLConnection httpURLConnection)
                                         throws IOException

Deprecated. - Not in use

A connection clone method. This method will take all connection settings and readable request properties and map them to a new connection object. This clone will not commit the new connection object, and will leave the object open for the caller to close. Non string properties will not be cloned, and an exception will be thrown if such a property is cloned.

Parameters:

httpURLConnection -

Returns:

cloneConnection

Throws:

IOException

cloneConnection

public static HttpURLConnection cloneConnection(String remoteHostUri,
                                                String basicAuthToken,
                                                javax.servlet.http.HttpServletRequest httpServletRequest)
                                         throws IOException,
                                                javax.servlet.ServletException

A connection clone method. This method will take all connection settings and readable request properties and map them to a new connection object. This clone will not commit the new connection object, and will leave the object open for the caller to close. Non string properties will not be cloned, and an exception will be thrown if such a property is cloned.

Parameters:

httpServletRequest -

Returns:

Throws:

IOException

javax.servlet.ServletException