Skip to content

Commit

Permalink
Added get/post methods used for multipart file push and read
Browse files Browse the repository at this point in the history
  • Loading branch information
Jennifer Hickey authored and Ryan Morgan committed Mar 4, 2010
1 parent 9dfbdc8 commit 74f707c
Show file tree
Hide file tree
Showing 2 changed files with 114 additions and 96 deletions.
11 changes: 6 additions & 5 deletions src/org/hyperic/hq/hqapi1/Connection.java
View file
Expand Up @@ -6,7 +6,8 @@

public interface Connection {

//<T> T doGet(String path, Map<String, String[]> params, File targetFile, Class<T> resultClass) throws IOException;
<T> T doGet(String path, Map<String, String[]> params, File targetFile, Class<T> resultClass)
throws IOException;

/**
* Issue a GET against the API.
Expand Down Expand Up @@ -44,8 +45,8 @@ <T> T doGet(String path, Map<String, String[]> params, Class<T> resultClass)
* @throws IOException
* If a network error occurs during the request.
*/
//<T> T doPost(String path, Map<String, String[]> params, Class<T> resultClass)
// throws IOException;
<T> T doPost(String path, Map<String, String[]> params, Class<T> resultClass)
throws IOException;

/**
* Issue a POST against the API.
Expand All @@ -63,8 +64,8 @@ <T> T doGet(String path, Map<String, String[]> params, Class<T> resultClass)
* @throws IOException
* If a network error occurs during the request.
*/
// <T> T doPost(String path, Map<String, String> params, File file,
// Class<T> resultClass) throws IOException;
<T> T doPost(String path, Map<String, String> params, File file,
Class<T> resultClass) throws IOException;

/**
* Issue a POST against the API.
Expand Down
199 changes: 108 additions & 91 deletions src/org/hyperic/hq/hqapi1/HQConnection.java
View file
@@ -1,32 +1,34 @@
/*
*
* NOTE: This copyright does *not* cover user programs that use HQ
* program services by normal system calls through the application
* program interfaces provided as part of the Hyperic Plug-in Development
* Kit or the Hyperic Client Development Kit - this is merely considered
* normal use of the program, and does *not* fall under the heading of
* "derived work".
*
* Copyright (C) [2008, 2009], Hyperic, Inc.
* This file is part of HQ.
*
* HQ is free software; you can redistribute it and/or modify
* it under the terms version 2 of the GNU General Public License as
* published by the Free Software Foundation. This program is distributed
* in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
* even the implied warranty of MERCHANTABILITY or FITNESS FOR A
* PARTICULAR PURPOSE. See the GNU General Public License for more
* details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
* USA.
*
* NOTE: This copyright does *not* cover user programs that use HQ program
* services by normal system calls through the application program interfaces
* provided as part of the Hyperic Plug-in Development Kit or the Hyperic Client
* Development Kit - this is merely considered normal use of the program, and
* does *not* fall under the heading of "derived work". Copyright (C) [2008,
* 2009], Hyperic, Inc. This file is part of HQ. HQ is free software; you can
* redistribute it and/or modify it under the terms version 2 of the GNU General
* Public License as published by the Free Software Foundation. This program is
* distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
* without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
* PARTICULAR PURPOSE. See the GNU General Public License for more details. You
* should have received a copy of the GNU General Public License along with this
* program; if not, write to the Free Software Foundation, Inc., 59 Temple
* Place, Suite 330, Boston, MA 02111-1307 USA.
*/

package org.hyperic.hq.hqapi1;

import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.IOException;
import java.net.SocketException;
import java.net.URL;
import java.net.URLEncoder;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;

import javax.xml.bind.JAXBException;

import org.apache.commons.httpclient.Credentials;
import org.apache.commons.httpclient.DefaultHttpMethodRetryHandler;
import org.apache.commons.httpclient.HttpClient;
Expand All @@ -37,6 +39,7 @@
import org.apache.commons.httpclient.auth.AuthScope;
import org.apache.commons.httpclient.methods.GetMethod;
import org.apache.commons.httpclient.methods.PostMethod;
import org.apache.commons.httpclient.methods.multipart.FilePart;
import org.apache.commons.httpclient.methods.multipart.MultipartRequestEntity;
import org.apache.commons.httpclient.methods.multipart.Part;
import org.apache.commons.httpclient.methods.multipart.StringPart;
Expand All @@ -45,33 +48,29 @@
import org.apache.commons.logging.LogFactory;
import org.hyperic.hq.hqapi1.types.ServiceError;

import javax.xml.bind.JAXBException;
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.IOException;
import java.net.SocketException;
import java.net.URL;
import java.net.URLEncoder;
import java.util.Map;

class HQConnection implements Connection {

private static Log _log = LogFactory.getLog(HQConnection.class);

private String _host;
private int _port;
private String _host;
private int _port;
private boolean _isSecure;
private String _user;
private String _password;
private String _user;
private String _password;

private final ResponseHandler xmlResponseHandler;

HQConnection(String host, int port, boolean isSecure, String user,
String password, ResponseHandler xmlResponseHandler) {
_host = host;
_port = port;
HQConnection(String host,
int port,
boolean isSecure,
String user,
String password,
ResponseHandler xmlResponseHandler)
{
_host = host;
_port = port;
_isSecure = isSecure;
_user = user;
_user = user;
_password = password;

if (_isSecure) {
Expand All @@ -81,42 +80,36 @@ class HQConnection implements Connection {
this.xmlResponseHandler = xmlResponseHandler;
}


private String urlEncode(String s)
throws IOException
{
private String urlEncode(String s) throws IOException {
return URLEncoder.encode(s, "UTF-8");
}

/**
* Issue a GET against the API.
*
*
* @param path The web service endpoint.
* @param params A Map of key value pairs that are converted into query
* arguments.
* arguments.
* @param resultClass The response object type.
* @return The response object from the operation. This response will be of
* the type given in the resultClass argument.
* @return The response object from the operation. This response will be of
* the type given in the resultClass argument.
* @throws IOException If a network error occurs during the request.
*/
public <T> T doGet(String path, Map<String, String[]> params, Class<T> resultClass)
throws IOException
{
public <T> T doGet(String path, Map<String, String[]> params, Class<T> resultClass) throws IOException {
GetMethod method = new GetMethod();
method.setDoAuthentication(true);
return runMethod(method, buildUri(path,params), resultClass, xmlResponseHandler);
return runMethod(method, buildUri(path, params), resultClass, xmlResponseHandler);
}

private String buildUri(String path, Map<String, String[]> params)
throws IOException {

private String buildUri(String path, Map<String, String[]> params) throws IOException {
StringBuffer uri = new StringBuffer(path);
if (uri.charAt(uri.length() - 1) != '?') {
uri.append("?");
}

boolean append = false;

for (Map.Entry<String,String[]> e : params.entrySet()) {
for (Map.Entry<String, String[]> e : params.entrySet()) {
for (String val : e.getValue()) {
if (val != null) {
if (append) {
Expand All @@ -130,29 +123,63 @@ private String buildUri(String path, Map<String, String[]> params)
return uri.toString();
}

public <T> T doGet(String path, Map<String, String[]> params, File targetFile, Class<T> resultClass) throws IOException
{
GetMethod method = new GetMethod();
method.setDoAuthentication(true);
return runMethod(method, buildUri(path, params), resultClass, new FileResponseHandler(targetFile));
}

public <T> T doPost(String path, Map<String, String[]> params, Class<T> resultClass) throws IOException {
PostMethod method = new PostMethod();
method.setDoAuthentication(true);
return runMethod(method, buildUri(path, params), resultClass, xmlResponseHandler);
}

public <T> T doGet(String path, Map<String, String[]> params,
File targetFile, Class<T> resultClass) throws IOException {
GetMethod method = new GetMethod();
method.setDoAuthentication(true);
return runMethod(method, buildUri(path, params), resultClass,
new FileResponseHandler(targetFile));
/**
* Issue a POST against the API.
*
* @param path
* The web service endpoint
* @param params
* A Map of key value pairs that are added to the post data
* @param file
* The file to post
* @param resultClass
* The result object type.
* @return The response object from the operation. This response will be of
* the type given in the resultClass argument.
* @throws IOException
* If a network error occurs during the request.
*/
public <T> T doPost(String path, Map<String, String> params, File file,
Class<T> resultClass) throws IOException {
PostMethod method = new PostMethod();
method.setDoAuthentication(true);
final List<Part> parts = new ArrayList<Part>();
parts.add(new FilePart("filename", file.getName(), file));
for (Map.Entry<String, String> paramEntry : params.entrySet()) {
parts
.add(new StringPart(paramEntry.getKey(), paramEntry
.getValue()));
}
method.setRequestEntity(new MultipartRequestEntity(parts
.toArray(new Part[parts.size()]), method.getParams()));
return runMethod(method, path, resultClass, xmlResponseHandler);
}

/**
* Issue a POST against the API.
*
*
* @param path The web service endpoint
* @param o The object to POST. This object will be serialized into XML
* prior to being sent.
* @param o The object to POST. This object will be serialized into XML
* prior to being sent.
* @param resultClass The result object type.
* @return The response object from the operation. This response will be
* of the type given in the resultClass argument.
* @return The response object from the operation. This response will be of
* the type given in the resultClass argument.
* @throws IOException If a network error occurs during the request.
*/
public <T> T doPost(String path, Object o, Class<T> resultClass)
throws IOException
{
public <T> T doPost(String path, Object o, Class<T> resultClass) throws IOException {
PostMethod method = new PostMethod();
method.setDoAuthentication(true);

Expand All @@ -168,20 +195,15 @@ public <T> T doPost(String path, Object o, Class<T> resultClass)
}
return xmlResponseHandler.getErrorResponse(resultClass, error);
}

Part[] parts = {
new StringPart("postdata", bos.toString())
};

method.setRequestEntity(new MultipartRequestEntity(parts,
method.getParams()));
Part[] parts = { new StringPart("postdata", bos.toString()) };

method.setRequestEntity(new MultipartRequestEntity(parts, method.getParams()));

return runMethod(method, path, resultClass, xmlResponseHandler);
}

private <T> T runMethod(HttpMethodBase method, String uri,
Class<T> resultClass, ResponseHandler responseHandler)
throws IOException
private <T> T runMethod(HttpMethodBase method, String uri, Class<T> resultClass, ResponseHandler responseHandler) throws IOException
{
String protocol = _isSecure ? "https" : "http";
ServiceError error;
Expand All @@ -208,19 +230,14 @@ private <T> T runMethod(HttpMethodBase method, String uri,

// Set Basic auth creds
client.getParams().setAuthenticationPreemptive(true);
Credentials defaultcreds = new UsernamePasswordCredentials(_user,
_password);
Credentials defaultcreds = new UsernamePasswordCredentials(_user, _password);
client.getState().setCredentials(AuthScope.ANY, defaultcreds);

// Disable re-tries
DefaultHttpMethodRetryHandler retryhandler =
new DefaultHttpMethodRetryHandler(0, true);
client.getParams().setParameter(HttpMethodParams.RETRY_HANDLER,
retryhandler);

DefaultHttpMethodRetryHandler retryhandler = new DefaultHttpMethodRetryHandler(0, true);
client.getParams().setParameter(HttpMethodParams.RETRY_HANDLER, retryhandler);
int responseCode = client.executeMethod(method);
return responseHandler.handleResponse(responseCode, method,
resultClass);
return responseHandler.handleResponse(responseCode, method, resultClass);
} catch (SocketException e) {
throw new HttpException("Error issuing request", e);
} finally {
Expand Down

0 comments on commit 74f707c

Please sign in to comment.