added HEAD method

Author: Synapticloop

README.md

@@ -0,0 +1,24 @@
+A Java API for the truly excellent backblaze B2 storage
+
+Usable, however still a work in progress... (YMMV)
+
+# Running the Tests
+
+`gradled --info test`
+
+Which will also print out the logging
+
+if you do not have gradle installed, try:
+
+`gradlew --info test`
+
+**!!!   IMPORTANT   !!!** 
+
+You **MUST** have the following environment variables set:
+
+```
+export B2_ACCOUNT_ID="your-account-id"
+export B2_APPLICATION_KEY="your-application-key"
+```
+
+**WARNING:** These tests make API calls against your account which contribute to your call limits, which may lead to a cost.

src/main/java/synapticloop/b2/B2ApiClient.java

@@ -18,6 +18,7 @@
 import synapticloop.b2.request.B2DownloadFileByNameRequest;
 import synapticloop.b2.request.B2GetFileInfoRequest;
 import synapticloop.b2.request.B2GetUploadUrlRequest;
+import synapticloop.b2.request.B2HeadFileByIdRequest;
 import synapticloop.b2.request.B2ListBucketsRequest;
 import synapticloop.b2.request.B2ListFileNamesRequest;
 import synapticloop.b2.request.B2ListFileVersionsRequest;
@@ -382,6 +383,10 @@ public B2DownloadFileResponse downloadFileById(String fileId) throws B2ApiExcept
 		return(new B2DownloadFileByIdRequest(getB2AuthorizeAccountResponse(), fileId).getResponse());
 	}
 
+	public B2DownloadFileResponse headFileById(String fileId) throws B2ApiException {
+		return(new B2HeadFileByIdRequest(getB2AuthorizeAccountResponse(), fileId).getResponse());
+	}
+
 	private synchronized B2AuthorizeAccountResponse getB2AuthorizeAccountResponse() throws B2ApiException {
 		if(null == b2AuthorizeAccountResponse) {
 			b2AuthorizeAccountResponse = new B2AuthorizeAccountRequest(accountId, applicationKey).getResponse();

src/main/java/synapticloop/b2/request/B2AuthorizeAccountRequest.java

@@ -10,9 +10,10 @@
  * used for account-level operations, and a URL that should be used as the base 
  * URL for subsequent API calls.</p>
  * 
+ * This is the interaction class for the <strong>b2_authorize_account</strong> api 
+ * calls, this was generated from the backblaze api documentation - which can be 
+ * found here:
  * 
- * This is the interaction class for the <strong>b2_authorize_account</strong> api calls, this was
- * generated from the backblaze api documentation - which can be found here:
  * <a href="http://www.backblaze.com/b2/docs/b2_authorize_account.html">http://www.backblaze.com/b2/docs/b2_authorize_account.html</a>
  * 
  * @author synapticloop

src/main/java/synapticloop/b2/request/B2CreateBucketRequest.java

@@ -12,9 +12,10 @@
  * use a bucket with the same name. Buckets are assigned a unique bucketId 
  * which is used when uploading, downloading, or deleting files.</p>
  * 
+ * This is the interaction class for the <strong>b2_create_bucket</strong> api 
+ * calls, this was generated from the backblaze api documentation - which can 
+ * be found here:
  * 
- * This is the interaction class for the <strong>b2_create_bucket</strong> api calls, this was
- * generated from the backblaze api documentation - which can be found here:
  * <a href="http://www.backblaze.com/b2/docs/b2_create_bucket.html">http://www.backblaze.com/b2/docs/b2_create_bucket.html</a>
  * 
  * @author synapticloop
@@ -27,8 +28,14 @@ public class B2CreateBucketRequest extends BaseB2Request {
 	 * Instantiate a new create bucket request
 	 * 
 	 * @param b2AuthorizeAccountResponse the authorize account response
-	 * @param bucketName the name of the bucket to craete
-	 * @param bucketType the type of bucket to create
+	 * @param bucketName The name to give the new bucket.  Bucket names must be 
+	 *     a minimum of 6 and a maximum of 50 characters long, and must be globally 
+	 *     unique; two different B2 accounts cannot have buckets with the same name. 
+	 *     Bucket names can consist of: letters, digits, and "-". Bucket names cannot 
+	 *     start with "b2-"; these are reserved for internal Backblaze use.
+	 * @param bucketType the type of bucket to create.  Either "allPublic", meaning 
+	 *     that files in this bucket can be downloaded by anybody, or "allPrivate", 
+	 *     meaning that you need a bucket authorization token to download the files.
 	 */
 	public B2CreateBucketRequest(B2AuthorizeAccountResponse b2AuthorizeAccountResponse, String bucketName, BucketType bucketType) {
 		super(b2AuthorizeAccountResponse);

src/main/java/synapticloop/b2/request/B2DeleteBucketRequest.java

@@ -7,9 +7,10 @@
 /**
  * <p>Deletes the bucket specified. Only buckets that contain no version of any files can be deleted.</p>
  * 
+ * This is the interaction class for the <strong>b2_delete_bucket</strong> api 
+ * calls, this was generated from the backblaze api documentation - which can 
+ * be found here:
  * 
- * This is the interaction class for the <strong>b2_delete_bucket</strong> api calls, this was
- * generated from the backblaze api documentation - which can be found here:
  * <a href="http://www.backblaze.com/b2/docs/b2_delete_bucket.html">http://www.backblaze.com/b2/docs/b2_delete_bucket.html</a>
  * 
  * @author synapticloop

src/main/java/synapticloop/b2/request/B2DeleteFileVersionRequest.java

@@ -25,7 +25,8 @@ public class B2DeleteFileVersionRequest extends BaseB2Request {
 	 * 
 	 * @param b2AuthorizeAccountResponse the authorize account response
 	 * @param fileName the name of the file to delete
-	 * @param fileId the id of the file to delete
+	 * @param fileId The ID of the file, as returned by {@link B2UploadFileRequest}, 
+	 *     {@link B2ListFileNamesRequest}, or {@link B2ListFileVersionsRequest}..
 	 */
 	public B2DeleteFileVersionRequest(B2AuthorizeAccountResponse b2AuthorizeAccountResponse, String fileName, String fileId) {
 		super(b2AuthorizeAccountResponse);
@@ -35,6 +36,13 @@ public B2DeleteFileVersionRequest(B2AuthorizeAccountResponse b2AuthorizeAccountR
 		stringData.put(KEY_FILE_ID, fileId);
 	}
 
+	/**
+	 * Return the http response for the call
+	 * 
+	 * @return the delete file version response
+	 * 
+	 * @throws B2ApiException if there was an error with the call
+	 */
 	public B2DeleteFileVersionResponse getResponse() throws B2ApiException {
 		return(new B2DeleteFileVersionResponse(executePost()));
 	}

src/main/java/synapticloop/b2/request/B2HeadFileByIdRequest.java

@@ -0,0 +1,40 @@
+package synapticloop.b2.request;
+
+import synapticloop.b2.exception.B2ApiException;
+import synapticloop.b2.response.B2AuthorizeAccountResponse;
+import synapticloop.b2.response.B2DownloadFileResponse;
+
+/**
+ * <p>Downloads one file from B2.</p>
+ * 
+ * <p>The response contains the following headers, which contain the same information they did when the file was uploaded:</p>
+ * 
+ * 
+ * This is the interaction class for the <strong>b2_download_file_by_id</strong> 
+ * api calls, this was generated from the backblaze api documentation - which 
+ * can be found here:
+ * 
+ * <a href="http://www.backblaze.com/b2/docs/b2_download_file_by_id.html">http://www.backblaze.com/b2/docs/b2_download_file_by_id.html</a>
+ * 
+ * @author synapticloop
+ */
+
+public class B2HeadFileByIdRequest extends BaseB2Request {
+	private static final String B2_DOWNLOAD_FILE_BY_ID = BASE_API_VERSION + "b2_download_file_by_id";
+
+	public B2HeadFileByIdRequest(B2AuthorizeAccountResponse b2AuthorizeAccountResponse, String fileId) {
+		super(b2AuthorizeAccountResponse);
+		url = b2AuthorizeAccountResponse.getDownloadUrl() + B2_DOWNLOAD_FILE_BY_ID;
+		parameters.put(KEY_FILE_ID, fileId);
+	}
+
+	/**
+	 * R
+	 * 
+	 * @return
+	 * @throws B2ApiException
+	 */
+	public B2DownloadFileResponse getResponse() throws B2ApiException {
+		return(new B2DownloadFileResponse(executeHead()));
+	}
+}

src/main/java/synapticloop/b2/request/B2UploadFileRequest.java

@@ -45,6 +45,7 @@ public B2UploadFileRequest(B2AuthorizeAccountResponse b2AuthorizeAccountResponse
 		super(b2AuthorizeAccountResponse);
 		this.fileName = fileName;
 		this.url = b2GetUploadUrlResponse.getUploadUrl();
+		headers.put(REQUEST_PROPERTY_AUTHORIZATION, b2GetUploadUrlResponse.getAuthorizationToken());
 		this.file = file;
 		this.mimeType = mimeType;
 

src/main/java/synapticloop/b2/request/BaseB2Request.java

@@ -11,6 +11,7 @@
 
 import org.apache.http.client.methods.CloseableHttpResponse;
 import org.apache.http.client.methods.HttpGet;
+import org.apache.http.client.methods.HttpHead;
 import org.apache.http.client.methods.HttpPost;
 import org.apache.http.client.methods.HttpRequestBase;
 import org.apache.http.client.utils.URIBuilder;
@@ -42,7 +43,7 @@ public class BaseB2Request {
 	protected static final String HEADER_CONTENT_TYPE = "Content-Type";
 	protected static final String HEADER_X_BZ_CONTENT_SHA1 = "X-Bz-Content-Sha1";
 	protected static final String HEADER_X_BZ_FILE_NAME = "X-Bz-File-Name";
-	protected static final String HEADER_X_BZ_INFO_PREFIX = "X-Bz-Info-";
+	protected static final String HEADER_X_BZ_INFO_PREFIX = "x-bz-info-";
 
 	protected static final String KEY_ACCOUNT_ID = "accountId";
 	protected static final String KEY_BUCKET_ID = "bucketId";
@@ -116,6 +117,38 @@ protected String convertPostData() throws B2ApiException {
 		return(jsonObject.toString());
 	}
 
+	protected CloseableHttpResponse executeHead() throws B2ApiException {
+		CloseableHttpClient closeableHttpClient = HttpClients.createDefault();
+
+		try {
+			URI uri = new URIBuilder(url).build();
+			LOG.debug("HEAD request to URL '{}'", url);
+
+			Iterator<String> iterator = parameters.keySet().iterator();
+			while (iterator.hasNext()) {
+				String key = (String) iterator.next();
+				// @TODO - this is kind of wasteful - refactor
+				uri = new URIBuilder(uri).addParameter(key, parameters.get(key)).build();
+			}
+
+			HttpHead httpHead = new HttpHead(uri);
+			setHeaders(httpHead);
+
+			CloseableHttpResponse httpResponse = closeableHttpClient.execute(httpHead);
+			int statusCode = httpResponse.getStatusLine().getStatusCode();
+
+			LOG.debug("Received status code of:{}, for HEAD request to url '{}'", statusCode, uri);
+
+			if(statusCode != 200) {
+				throw new B2ApiException("Received status code of " + statusCode + " for request.");
+			} else {
+				return(httpResponse);
+			}
+		} catch (IOException | URISyntaxException ex) {
+			throw new B2ApiException(ex);
+		}
+	}
+
 	protected String executeGet() throws B2ApiException {
 		CloseableHttpClient closeableHttpClient = HttpClients.createDefault();
 		HttpGet httpGet = new HttpGet(url);
@@ -141,6 +174,7 @@ protected String executeGet() throws B2ApiException {
 		}
 	}
 
+
 	protected CloseableHttpResponse executeGetWithData() throws B2ApiException {
 		CloseableHttpClient closeableHttpClient = HttpClients.createDefault();
 

src/main/java/synapticloop/b2/response/B2DownloadFileResponse.java

@@ -3,27 +3,44 @@
 import java.io.IOException;
 import java.io.InputStream;
 import java.util.HashMap;
+import java.util.HashSet;
 import java.util.Map;
+import java.util.Set;
 
 import org.apache.http.Header;
 import org.apache.http.client.methods.CloseableHttpResponse;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 import synapticloop.b2.exception.B2ApiException;
 
 public class B2DownloadFileResponse extends BaseB2Response {
+	private static final Logger LOG = LoggerFactory.getLogger(B2DownloadFileResponse.class);
+
 	private static final int HEADER_CONTENT_LENGTH = 0;
 	private static final int HEADER_CONTENT_TYPE = 1;
 	private static final int HEADER_X_BZ_FILE_ID = 2;
 	private static final int HEADER_X_BZ_FILE_NAME = 3;
 	private static final int HEADER_X_BZ_CONTENT_SHA1 = 4;
 
+	// headers are all lowercase for lookup
 	private static final Map<String, Integer> headerLookup = new HashMap<String, Integer>();
 	static {
-		headerLookup.put("Content-Length", HEADER_CONTENT_LENGTH);
-		headerLookup.put("Content-Type", HEADER_CONTENT_TYPE);
-		headerLookup.put("X-Bz-File-Id", HEADER_X_BZ_FILE_ID);
-		headerLookup.put("X-Bz-File-Name", HEADER_X_BZ_FILE_NAME);
-		headerLookup.put("X-Bz-Content-Sha1", HEADER_X_BZ_CONTENT_SHA1);
+		headerLookup.put("content-length", HEADER_CONTENT_LENGTH);
+		headerLookup.put("content-type", HEADER_CONTENT_TYPE);
+		headerLookup.put("x-bz-file-id", HEADER_X_BZ_FILE_ID);
+		headerLookup.put("x-bz-file-name", HEADER_X_BZ_FILE_NAME);
+		headerLookup.put("x-bz-content-sha1", HEADER_X_BZ_CONTENT_SHA1);
+	}
+
+	private static final Set<String> ignoredHeaders = new HashSet<String>();
+	static {
+		ignoredHeaders.add("server");
+		ignoredHeaders.add("x-content-type-options");
+		ignoredHeaders.add("x-xss-protection");
+		ignoredHeaders.add("x-frame-options");
+		ignoredHeaders.add("cache-control");
+		ignoredHeaders.add("date");
 	}
 
 	private InputStream content = null;
@@ -37,7 +54,10 @@ public class B2DownloadFileResponse extends BaseB2Response {
 
 	public B2DownloadFileResponse(CloseableHttpResponse closeableHttpResponse) throws B2ApiException {
 		try {
-			content = closeableHttpResponse.getEntity().getContent();
+			// HEAD responses do not have an entity
+			if(null != closeableHttpResponse.getEntity()) {
+				content = closeableHttpResponse.getEntity().getContent();
+			}
 			parseHeaders(closeableHttpResponse);
 
 		} catch (IllegalStateException | IOException ex) {
@@ -51,8 +71,8 @@ private void parseHeaders(CloseableHttpResponse closeableHttpResponse) throws B2
 		for (Header header : allHeaders) {
 			String headerName = header.getName();
 			String headerValue = header.getValue();
-			if(headerLookup.containsKey(headerName)) {
-				switch (headerLookup.get(headerName)) {
+			if(headerLookup.containsKey(headerName.toLowerCase())) {
+				switch (headerLookup.get(headerName.toLowerCase())) {
 				case HEADER_CONTENT_LENGTH:
 					contentLength = Integer.parseInt(headerValue);
 					break;
@@ -76,13 +96,18 @@ private void parseHeaders(CloseableHttpResponse closeableHttpResponse) throws B2
 				// headers
 				if(headerName.startsWith(HEADER_X_BZ_INFO_PREFIX)) {
 					fileInfo.put(headerName.substring(HEADER_X_BZ_INFO_PREFIX.length()), headerValue);
+				} else {
+					if(!ignoredHeaders.contains(headerName.toLowerCase())) {
+						LOG.warn("Found a header named '{}' with value '{}', that was not mapped", headerName, headerValue);
+					}
 				}
 			}
 		}
 	}
 
 	/**
-	 * Get the content of the downloaded file
+	 * Get the content of the downloaded file, if this was a HEAD request, then 
+	 * this will return null.
 	 * 
 	 * @return the downloaded file
 	 */