Github/geoserver-manager
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge 5588d971fc into 3e580b73d1

Browse Source
This commit is contained in:
Jesse Eichar 2014-09-24 06:54:03 +00:00
commit 774ce027d9
3 changed files with 125 additions and 47 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
pom.xml
View File

@ -203,6 +203,7 @@
<properties> <properties>
<slf4j.version>1.5.11</slf4j.version> <slf4j.version>1.5.11</slf4j.version>
<encoding>UTF-8</encoding>
</properties> </properties>
<dependencies> <dependencies>

155
src/main/java/it/geosolutions/geoserver/rest/HTTPUtils.java
View File

@ -25,15 +25,6 @@
package it.geosolutions.geoserver.rest; package it.geosolutions.geoserver.rest;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.io.UnsupportedEncodingException;
import java.net.ConnectException;
import java.net.HttpURLConnection;
import java.net.MalformedURLException;
import java.net.URL;
import org.apache.commons.httpclient.Credentials; import org.apache.commons.httpclient.Credentials;
import org.apache.commons.httpclient.HttpClient; import org.apache.commons.httpclient.HttpClient;
import org.apache.commons.httpclient.HttpConnectionManager; import org.apache.commons.httpclient.HttpConnectionManager;
@ -52,6 +43,17 @@ import org.apache.commons.io.IOUtils;
import org.slf4j.Logger; import org.slf4j.Logger;
import org.slf4j.LoggerFactory; import org.slf4j.LoggerFactory;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.io.UnsupportedEncodingException;
import java.net.ConnectException;
import java.net.HttpURLConnection;
import java.net.MalformedURLException;
import java.net.URI;
import java.net.URISyntaxException;
import java.net.URL;
/** /**
* Low level HTTP utilities. * Low level HTTP utilities.
*/ */
@ -60,7 +62,7 @@ public class HTTPUtils {
/** /**
* Performs an HTTP GET on the given URL. * Performs an HTTP GET on the given URL.
* *
* @param url The URL where to connect to. * @param url The URL where to connect to.
* @return The HTTP response as a String if the HTTP response code was 200 * @return The HTTP response as a String if the HTTP response code was 200
* (OK). * (OK).
@ -73,7 +75,7 @@ public class HTTPUtils {
/** /**
* Performs an HTTP GET on the given URL. <BR> * Performs an HTTP GET on the given URL. <BR>
* Basic auth is used if both username and pw are not null. * Basic auth is used if both username and pw are not null.
* *
* @param url The URL where to connect to. * @param url The URL where to connect to.
* @param username Basic auth credential. No basic auth if null. * @param username Basic auth credential. No basic auth if null.
* @param pw Basic auth credential. No basic auth if null. * @param pw Basic auth credential. No basic auth if null.
@ -87,8 +89,9 @@ public class HTTPUtils {
HttpClient client = new HttpClient(); HttpClient client = new HttpClient();
HttpConnectionManager connectionManager = client.getHttpConnectionManager(); HttpConnectionManager connectionManager = client.getHttpConnectionManager();
try { try {
setAuth(client, url, username, pw); String encodedUrl = encodeUrl(url);
httpMethod = new GetMethod(url); setAuth(client, encodedUrl, username, pw);
httpMethod = new GetMethod(encodedUrl);
connectionManager.getParams().setConnectionTimeout(5000); connectionManager.getParams().setConnectionTimeout(5000);
int status = client.executeMethod(httpMethod); int status = client.executeMethod(httpMethod);
if (status == HttpStatus.SC_OK) { if (status == HttpStatus.SC_OK) {
@ -117,10 +120,62 @@ public class HTTPUtils {
return null; return null;
} }
static String encodeUrl(String url) {
// perform some simple encoding to the path names. This takes care of cases where
// layers or workspaces have illegal http characters.
// it cannot fix all
String protocol, authority, path, query, fragment = null;
String[] protocolPathParts = url.split("://", 2);
if (protocolPathParts.length == 1) {
// unexpected format so just try out url
return url;
}
protocol = protocolPathParts[0];
String[] pathQueryParts = protocolPathParts[1].split("\\?", 2);
path = pathQueryParts[0];
if (pathQueryParts.length == 1) {
query = null;
} else {
query = pathQueryParts[1];
}
if (query == null) {
String[] fragmentParts = path.split("#", 2);
if (fragmentParts.length > 1) {
path = fragmentParts[0];
fragment = fragmentParts[1];
}
} else {
String[] fragmentParts = query.split("#", 2);
if (fragmentParts.length > 1) {
query = fragmentParts[0];
fragment = fragmentParts[1];
}
}
int firstSlash = path.indexOf('/');
if (firstSlash > -1) {
authority = path.substring(0, firstSlash);
path = path.substring(firstSlash);
} else {
authority = path;
path = null;
}
try {
return new URI(protocol, authority, path, query, fragment).toString();
} catch (URISyntaxException e) {
// fallback to original string
return url;
}
}
/** /**
* PUTs a File to the given URL. <BR> * PUTs a File to the given URL. <BR>
* Basic auth is used if both username and pw are not null. * Basic auth is used if both username and pw are not null.
* *
* @param url The URL where to connect to. * @param url The URL where to connect to.
* @param file The File to be sent. * @param file The File to be sent.
* @param contentType The content-type to advert in the PUT. * @param contentType The content-type to advert in the PUT.
@ -138,7 +193,7 @@ public class HTTPUtils {
/** /**
* PUTs a String to the given URL. <BR> * PUTs a String to the given URL. <BR>
* Basic auth is used if both username and pw are not null. * Basic auth is used if both username and pw are not null.
* *
* @param url The URL where to connect to. * @param url The URL where to connect to.
* @param content The content to be sent as a String. * @param content The content to be sent as a String.
* @param contentType The content-type to advert in the PUT. * @param contentType The content-type to advert in the PUT.
@ -161,7 +216,7 @@ public class HTTPUtils {
/** /**
* PUTs a String representing an XML document to the given URL. <BR> * PUTs a String representing an XML document to the given URL. <BR>
* Basic auth is used if both username and pw are not null. * Basic auth is used if both username and pw are not null.
* *
* @param url The URL where to connect to. * @param url The URL where to connect to.
* @param content The XML content to be sent as a String. * @param content The XML content to be sent as a String.
* @param username Basic auth credential. No basic auth if null. * @param username Basic auth credential. No basic auth if null.
@ -178,7 +233,7 @@ public class HTTPUtils {
/** /**
* Performs a PUT to the given URL. <BR> * Performs a PUT to the given URL. <BR>
* Basic auth is used if both username and pw are not null. * Basic auth is used if both username and pw are not null.
* *
* @param url The URL where to connect to. * @param url The URL where to connect to.
* @param requestEntity The request to be sent. * @param requestEntity The request to be sent.
* @param username Basic auth credential. No basic auth if null. * @param username Basic auth credential. No basic auth if null.
@ -195,7 +250,7 @@ public class HTTPUtils {
/** /**
* POSTs a File to the given URL. <BR> * POSTs a File to the given URL. <BR>
* Basic auth is used if both username and pw are not null. * Basic auth is used if both username and pw are not null.
* *
* @param url The URL where to connect to. * @param url The URL where to connect to.
* @param file The File to be sent. * @param file The File to be sent.
* @param contentType The content-type to advert in the POST. * @param contentType The content-type to advert in the POST.
@ -213,7 +268,7 @@ public class HTTPUtils {
/** /**
* POSTs a String to the given URL. <BR> * POSTs a String to the given URL. <BR>
* Basic auth is used if both username and pw are not null. * Basic auth is used if both username and pw are not null.
* *
* @param url The URL where to connect to. * @param url The URL where to connect to.
* @param content The content to be sent as a String. * @param content The content to be sent as a String.
* @param contentType The content-type to advert in the POST. * @param contentType The content-type to advert in the POST.
@ -236,7 +291,7 @@ public class HTTPUtils {
/** /**
* POSTs a String representing an XML document to the given URL. <BR> * POSTs a String representing an XML document to the given URL. <BR>
* Basic auth is used if both username and pw are not null. * Basic auth is used if both username and pw are not null.
* *
* @param url The URL where to connect to. * @param url The URL where to connect to.
* @param content The XML content to be sent as a String. * @param content The XML content to be sent as a String.
* @param username Basic auth credential. No basic auth if null. * @param username Basic auth credential. No basic auth if null.
@ -253,7 +308,7 @@ public class HTTPUtils {
/** /**
* Performs a POST to the given URL. <BR> * Performs a POST to the given URL. <BR>
* Basic auth is used if both username and pw are not null. * Basic auth is used if both username and pw are not null.
* *
* @param url The URL where to connect to. * @param url The URL where to connect to.
* @param requestEntity The request to be sent. * @param requestEntity The request to be sent.
* @param username Basic auth credential. No basic auth if null. * @param username Basic auth credential. No basic auth if null.
@ -279,15 +334,16 @@ public class HTTPUtils {
* </UL> * </UL>
* are accepted as successful codes; in these cases the response string will * are accepted as successful codes; in these cases the response string will
* be returned. * be returned.
* *
* @return the HTTP response or <TT>null</TT> on errors. * @return the HTTP response or <TT>null</TT> on errors.
*/ */
private static String send(final EntityEnclosingMethod httpMethod, String url, private static String send(final EntityEnclosingMethod httpMethod, String url,
RequestEntity requestEntity, String username, String pw) { RequestEntity requestEntity, String username, String pw) {
HttpClient client = new HttpClient(); HttpClient client = new HttpClient();
HttpConnectionManager connectionManager = client.getHttpConnectionManager(); HttpConnectionManager connectionManager = client.getHttpConnectionManager();
String encodedUrl = encodeUrl(url);
try { try {
setAuth(client, url, username, pw); setAuth(client, encodedUrl, username, pw);
connectionManager.getParams().setConnectionTimeout(5000); connectionManager.getParams().setConnectionTimeout(5000);
if (requestEntity != null) if (requestEntity != null)
httpMethod.setRequestEntity(requestEntity); httpMethod.setRequestEntity(requestEntity);
@ -304,15 +360,15 @@ public class HTTPUtils {
return response; return response;
default: default:
LOGGER.warn("Bad response: code[" + status + "]" + " msg[" + httpMethod.getStatusText() + "]" LOGGER.warn("Bad response: code[" + status + "]" + " msg[" + httpMethod.getStatusText() + "]"
+ " url[" + url + "]" + " method[" + httpMethod.getClass().getSimpleName() + " url[" + encodedUrl + "]" + " method[" + httpMethod.getClass().getSimpleName()
+ "]: " + IOUtils.toString(httpMethod.getResponseBodyAsStream())); + "]: " + IOUtils.toString(httpMethod.getResponseBodyAsStream()));
return null; return null;
} }
} catch (ConnectException e) { } catch (ConnectException e) {
LOGGER.info("Couldn't connect to [" + url + "]"); LOGGER.info("Couldn't connect to [" + encodedUrl + "]");
return null; return null;
} catch (IOException e) { } catch (IOException e) {
LOGGER.error("Error talking to " + url + " : " + e.getLocalizedMessage()); LOGGER.error("Error talking to " + encodedUrl + " : " + e.getLocalizedMessage());
return null; return null;
} finally { } finally {
if (httpMethod != null) if (httpMethod != null)
@ -326,9 +382,10 @@ public class HTTPUtils {
DeleteMethod httpMethod = null; DeleteMethod httpMethod = null;
HttpClient client = new HttpClient(); HttpClient client = new HttpClient();
HttpConnectionManager connectionManager = client.getHttpConnectionManager(); HttpConnectionManager connectionManager = client.getHttpConnectionManager();
String encodedUrl = encodeUrl(url);
try { try {
setAuth(client, url, user, pw); setAuth(client, encodedUrl, user, pw);
httpMethod = new DeleteMethod(url); httpMethod = new DeleteMethod(encodedUrl);
connectionManager.getParams().setConnectionTimeout(5000); connectionManager.getParams().setConnectionTimeout(5000);
int status = client.executeMethod(httpMethod); int status = client.executeMethod(httpMethod);
String response = ""; String response = "";
@ -336,23 +393,23 @@ public class HTTPUtils {
InputStream is = httpMethod.getResponseBodyAsStream(); InputStream is = httpMethod.getResponseBodyAsStream();
response = IOUtils.toString(is); response = IOUtils.toString(is);
IOUtils.closeQuietly(is); IOUtils.closeQuietly(is);
if (response.trim().equals("")) { if (response.trim().equals("")) {
if (LOGGER.isDebugEnabled()) if (LOGGER.isDebugEnabled())
LOGGER LOGGER
.debug("ResponseBody is empty (this may be not an error since we just performed a DELETE call)"); .debug("ResponseBody is empty (this may be not an error since we just performed a DELETE call)");
return true; return true;
} }
if (LOGGER.isDebugEnabled()) if (LOGGER.isDebugEnabled())
LOGGER.debug("(" + status + ") " + httpMethod.getStatusText() + " -- " + url); LOGGER.debug("(" + status + ") " + httpMethod.getStatusText() + " -- " + encodedUrl);
return true; return true;
} else { } else {
LOGGER.info("(" + status + ") " + httpMethod.getStatusText() + " -- " + url); LOGGER.info("(" + status + ") " + httpMethod.getStatusText() + " -- " + encodedUrl);
LOGGER.info("Response: '" + response + "'"); LOGGER.info("Response: '" + response + "'");
} }
} catch (ConnectException e) { } catch (ConnectException e) {
LOGGER.info("Couldn't connect to [" + url + "]"); LOGGER.info("Couldn't connect to [" + encodedUrl + "]");
} catch (IOException e) { } catch (IOException e) {
LOGGER.info("Error talking to [" + url + "]", e); LOGGER.info("Error talking to [" + encodedUrl + "]", e);
} finally { } finally {
if (httpMethod != null) if (httpMethod != null)
httpMethod.releaseConnection(); httpMethod.releaseConnection();
@ -375,12 +432,13 @@ public class HTTPUtils {
HttpClient client = new HttpClient(); HttpClient client = new HttpClient();
HttpConnectionManager connectionManager = client.getHttpConnectionManager(); HttpConnectionManager connectionManager = client.getHttpConnectionManager();
try { try {
setAuth(client, url, username, pw); String encodedUrl = encodeUrl(url);
httpMethod = new GetMethod(url); setAuth(client, encodedUrl, username, pw);
httpMethod = new GetMethod(encodedUrl);
connectionManager.getParams().setConnectionTimeout(2000); connectionManager.getParams().setConnectionTimeout(2000);
int status = client.executeMethod(httpMethod); int status = client.executeMethod(httpMethod);
if (status != HttpStatus.SC_OK) { if (status != HttpStatus.SC_OK) {
LOGGER.warn("PING failed at '" + url + "': (" + status + ") " + httpMethod.getStatusText()); LOGGER.warn("PING failed at '" + encodedUrl + "': (" + status + ") " + httpMethod.getStatusText());
return false; return false;
} else { } else {
return true; return true;
@ -399,7 +457,7 @@ public class HTTPUtils {
/** /**
* Used to query for REST resources. * Used to query for REST resources.
* *
* @param url The URL of the REST resource to query about. * @param url The URL of the REST resource to query about.
* @param username * @param username
* @param pw * @param pw
@ -412,8 +470,9 @@ public class HTTPUtils {
HttpClient client = new HttpClient(); HttpClient client = new HttpClient();
HttpConnectionManager connectionManager = client.getHttpConnectionManager(); HttpConnectionManager connectionManager = client.getHttpConnectionManager();
try { try {
setAuth(client, url, username, pw); String encodedUrl = encodeUrl(url);
httpMethod = new GetMethod(url); setAuth(client, encodedUrl, username, pw);
httpMethod = new GetMethod(encodedUrl);
connectionManager.getParams().setConnectionTimeout(2000); connectionManager.getParams().setConnectionTimeout(2000);
int status = client.executeMethod(httpMethod); int status = client.executeMethod(httpMethod);
switch (status) { switch (status) {
@ -422,7 +481,7 @@ public class HTTPUtils {
case HttpStatus.SC_NOT_FOUND: case HttpStatus.SC_NOT_FOUND:
return false; return false;
default: default:
throw new RuntimeException("Unhandled response status at '" + url + "': (" + status + ") " throw new RuntimeException("Unhandled response status at '" + encodedUrl + "': (" + status + ") "
+ httpMethod.getStatusText()); + httpMethod.getStatusText());
} }
} catch (ConnectException e) { } catch (ConnectException e) {
@ -438,7 +497,9 @@ public class HTTPUtils {
private static void setAuth(HttpClient client, String url, String username, String pw) private static void setAuth(HttpClient client, String url, String username, String pw)
throws MalformedURLException { throws MalformedURLException {
URL u = new URL(url);
String encodedUrl = encodeUrl(url);
URL u = new URL(encodedUrl);
if (username != null && pw != null) { if (username != null && pw != null) {
Credentials defaultcreds = new UsernamePasswordCredentials(username, pw); Credentials defaultcreds = new UsernamePasswordCredentials(username, pw);
client.getState().setCredentials(new AuthScope(u.getHost(), u.getPort()), defaultcreds); client.getState().setCredentials(new AuthScope(u.getHost(), u.getPort()), defaultcreds);
@ -449,14 +510,14 @@ public class HTTPUtils {
// authentication // authentication
} else { } else {
if (LOGGER.isDebugEnabled()) { if (LOGGER.isDebugEnabled()) {
LOGGER.debug("Not setting credentials to access to " + url); LOGGER.debug("Not setting credentials to access to " + encodedUrl);
} }
} }
} }
/** /**
* @param geoserverURL * @param geoserverURL
* @return recursively remove ending slashes * @return recursively remove ending slashes
*/ */
public static String decurtSlash(String geoserverURL) { public static String decurtSlash(String geoserverURL) {
if (geoserverURL!=null && geoserverURL.endsWith("/")) { if (geoserverURL!=null && geoserverURL.endsWith("/")) {
@ -464,7 +525,7 @@ public class HTTPUtils {
} }
return geoserverURL; return geoserverURL;
} }
/** /**
* @param str a string array * @param str a string array
* @return create a StringBuilder appending all the passed arguments * @return create a StringBuilder appending all the passed arguments
@ -473,7 +534,7 @@ public class HTTPUtils {
if (str==null){ if (str==null){
return null; return null;
} }
StringBuilder buf=new StringBuilder(); StringBuilder buf=new StringBuilder();
for (String s: str){ for (String s: str){
if (s!=null) if (s!=null)
@ -481,7 +542,7 @@ public class HTTPUtils {
} }
return buf; return buf;
} }
/** /**
* Wrapper for {@link #append(String...)} * Wrapper for {@link #append(String...)}
* @param base base URL * @param base base URL
@ -492,7 +553,7 @@ public class HTTPUtils {
if (str==null){ if (str==null){
return append(base.toString()); return append(base.toString());
} }
StringBuilder buf=new StringBuilder(base.toString()); StringBuilder buf=new StringBuilder(base.toString());
for (String s: str){ for (String s: str){
if (s!=null) if (s!=null)

16
src/test/java/it/geosolutions/geoserver/rest/HTTPUtilsTest.java Normal file
View File

@ -0,0 +1,16 @@
package it.geosolutions.geoserver.rest;
import junit.framework.TestCase;
public class HTTPUtilsTest extends TestCase {
public void testEncodeUrl() throws Exception {
assertEquals("http://with%20spaces", HTTPUtils.encodeUrl("http://with spaces"));
assertEquals("http://with%20spaces?p1=v1", HTTPUtils.encodeUrl("http://with spaces?p1=v1"));
assertEquals("http://without/spaces?p1=v1", HTTPUtils.encodeUrl("http://without/spaces?p1=v1"));
assertEquals("http://without/spaces", HTTPUtils.encodeUrl("http://without/spaces"));
assertEquals("http://without/spaces#fragment", HTTPUtils.encodeUrl("http://without/spaces#fragment"));
assertEquals("http://without/spaces?p1=v1#fragment", HTTPUtils.encodeUrl("http://without/spaces?p1=v1#fragment"));
assertEquals("http://with%20spaces#fragment", HTTPUtils.encodeUrl("http://with spaces#fragment"));
assertEquals("brokenurl?p1=v1", HTTPUtils.encodeUrl("brokenurl?p1=v1"));
}
}