com.darwinsys.net.ConversationURL Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of darwinsys-api Show documentation
Ian Darwin's assorted Java stuff, assembled as an API.
There is a newer version: 1.8.0
package com.darwinsys.net;

import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.PrintWriter;
import java.net.HttpURLConnection;
import java.net.URL;
import java.net.URLConnection;
import java.util.Map;

import com.darwinsys.security.BasicAuth;

/**
 * Read a URL's data from a URLConnection
 */
public class ConversationURL {
	
	/** Run a conversation and return the result, with no
	 * postBody and no credentials.
	 * @param host The web service site address
	 * @param port the port number (usually 80)
	 * @param path The servlet or component path
	 * @return The result of the conversation.
	 * @throws IOException if the conversation failed
	 */
	 public static String converse(String host, int port, String path) throws IOException {
		 return converse(host, port, path, null, null, null);
	 }
	
	 /** Run a conversation and return the result, with
	  * the given postBody and no credentials.
	  * @param host The web service site address
	  * @param port the port number (usually 80)
	  * @param path The servlet or component path
	  * @param postBody The body to send (null == use GET)
	  * @param userName Credentials
	  * @param password Credentials
	  * @return The result of the conversation.
	  * @throws IOException if the conversation failed
	  */
	 public static String converse(String host, int port, String path, String postBody, String userName, String password) throws IOException {
		 URL url = port == 443 ? new URL("https", host, port, path) : new URL("http", host, port, path);
		 return converse(url, postBody, userName, password);
	 }
	
	 /** Run a conversation and return the result as a (long) String, with inputs
	  * the given postBody and credentials.
	  * @param url The URL for the restful web service
	  * @param postBody The body to send (null == use GET)
	  * @param userName Credentials
	  * @param password Credentials
	  * @return The result of the conversation.
	  * @throws IOException if the conversation failed
	  */
	 public static String converse(URL url, String postBody, String userName, String password) throws IOException {
		 InputStream converseStream = converseStream(url, postBody, userName, password);

		StringBuilder sb = new StringBuilder();
		BufferedReader in = new BufferedReader(
				new InputStreamReader(converseStream));
		String line;

		while ((line = in.readLine()) != null) {
			sb.append(line);
		}

		in.close();
		return sb.toString();
	}
	 
	/** 
	 * Hold a conversation given a URL and a list of headers
	 * @param url The URL for the restful web service
	 * @param postBody The body to send (null == use GET)
	 * @param headers The Http headers to send (e.g., Content-type, ...)
	 * @return The body sent in response to the request
	 */
	 public static String converse(URL url, String postBody, Map headers) {
		 try {
			 HttpURLConnection conn = (HttpURLConnection) url.openConnection();
			 boolean isPost = postBody != null;
			 if (isPost) {
				 conn.setRequestMethod("POST");
				 conn.setDoInput(true);
			 }
			 conn.setDoOutput(true);
			 conn.setAllowUserInteraction(true);

			 if (headers != null) {
				 for (String s : headers.keySet()) {
					 conn.addRequestProperty(s, headers.get(s));
				 }
			 }

			 conn.connect();

			 if (isPost) {
				 PrintWriter out = new PrintWriter(conn.getOutputStream());
				 out.println(postBody);
				 out.close();			// Important!
			 }

			 StringBuilder sb = new StringBuilder();
			 BufferedReader in = new BufferedReader(
					 new InputStreamReader(conn.getInputStream()));
			 String line;

			 while ((line = in.readLine()) != null) {
				 sb.append(line);
			 }

			 in.close();
			 return sb.toString();

		 } catch (IOException e) {
			 throw new RuntimeException("converse() failure: " + e, e);
		 }
	 }
	
	 /** Run a conversation and return the resulting InputStream, with inputs
	  * the given postBody and credentials.
	  * @param url The URL for the restful web service
	  * @param postBody The body to send (null == use GET)
	  * @param userName Credentials
	  * @param password Credentials
	  * @return The result of the conversation.
	  * @throws IOException if the conversation failed
	  */
	 public static InputStream converseStream(URL url, String postBody, String userName, String password) throws IOException {
		URLConnection conn = url.openConnection();
		conn.setRequestProperty("Authorization", BasicAuth.makeHeaderValue(userName, password));
		boolean post = postBody != null;
		if (post) {
			conn.setDoInput(true);
		}
		conn.setDoOutput(true);
		conn.setAllowUserInteraction(true);
		
		conn.connect();
		
		if (post) {
			PrintWriter out = new PrintWriter(conn.getOutputStream());
			out.println(postBody);
			out.close();
		}
		return conn.getInputStream();
	 }
}