diff --git a/README.md b/README.md index beb8326..b35764a 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,100 @@ A Java API for the truly excellent backblaze B2 storage Usable, however still a work in progress... (YMMV) + +# Dependency Management + +> Note that the latest version can be found [https://bintray.com/synapticloop/maven/backblaze-b2-java-api/view](https://bintray.com/synapticloop/maven/backblaze-b2-java-api/view) + +Include the dependency + +## maven + +this comes from the jcenter bintray, to set up your repository: + + + + + + + + + false + + central + bintray + http://jcenter.bintray.com + + + + + + false + + central + bintray-plugins + http://jcenter.bintray.com + + + bintray + + + + bintray + + + +And now for the dependency + + + synapticloop + backblaze-b2-java-api + v1.0.0 + jar + + + +## gradle + +Repository + + repositories { + maven { + url "http://jcenter.bintray.com" + } + } + + or just + + repositories { + jcenter() + } + +and then include the dependency: + + runtime(group: 'synapticloop', name: 'backblaze-b2-java-api', version: 'v1.0.0', ext: 'jar') + + compile(group: 'synapticloop', name: 'backblaze-b2-java-api', version: 'v1.0.0', ext: 'jar') + +or + + runtime 'synapticloop:backblaze-b2-java-api:v1.0.0' + + compile 'synapticloop:backblaze-b2-java-api:v1.0.0' + +## Other + +You may either download the files from [https://bintray.com/synapticloop/maven/backblaze-b2-java-api/](https://bintray.com/synapticloop/maven/backblaze-b2-java-api/) or from [https://github.com/synapticloop/backblaze-b2-java-api/releases](https://github.com/synapticloop/backblaze-b2-java-api/releases) + +You will also need the dependencies: + + - runtime 'org.apache.httpcomponents:httpclient:4.3.4' + - runtime 'commons-io:commons-io:2.4' + - runtime 'org.json:json:20090211' + - runtime 'org.slf4j:slf4j-api:1.7.13' + +which can be found by searching here: [http://mvnrepository.com/](http://mvnrepository.com/) + # Running the Tests `gradled --info test` diff --git a/src/main/java/synapticloop/b2/B2ApiClient.java b/src/main/java/synapticloop/b2/B2ApiClient.java index 4497085..3c4e22d 100644 --- a/src/main/java/synapticloop/b2/B2ApiClient.java +++ b/src/main/java/synapticloop/b2/B2ApiClient.java @@ -137,8 +137,8 @@ public List listBuckets() throws B2ApiException { * * @param fileId the file ID to retrieve the information on * - * @return the File Response - * @throws B2ApiException + * @return the File Response + * @throws B2ApiException if something went wrong */ public B2FileResponse getFileInfo(String fileId) throws B2ApiException { return(new B2GetFileInfoRequest(getB2AuthorizeAccountResponse(), fileId).getResponse()); diff --git a/src/main/java/synapticloop/b2/exception/B2ApiException.java b/src/main/java/synapticloop/b2/exception/B2ApiException.java index 359cc4d..9d66956 100644 --- a/src/main/java/synapticloop/b2/exception/B2ApiException.java +++ b/src/main/java/synapticloop/b2/exception/B2ApiException.java @@ -57,7 +57,8 @@ public B2ApiException(String message, Throwable cause) { /** * Create a new B2Api Exception with a root cause - * @param cause + * + * @param cause The root cause of the exception */ public B2ApiException(Throwable cause) { super(cause); diff --git a/src/main/java/synapticloop/b2/request/B2HeadFileByIdRequest.java b/src/main/java/synapticloop/b2/request/B2HeadFileByIdRequest.java index fd56424..5970655 100644 --- a/src/main/java/synapticloop/b2/request/B2HeadFileByIdRequest.java +++ b/src/main/java/synapticloop/b2/request/B2HeadFileByIdRequest.java @@ -29,10 +29,11 @@ public B2HeadFileByIdRequest(B2AuthorizeAccountResponse b2AuthorizeAccountRespon } /** - * R + * Return the response for the HEAD request * - * @return - * @throws B2ApiException + * @return the download file response - note that this does not contain any body content + * + * @throws B2ApiException if something went wrong */ public B2DownloadFileResponse getResponse() throws B2ApiException { return(new B2DownloadFileResponse(executeHead())); diff --git a/src/main/java/synapticloop/b2/request/B2UploadFileRequest.java b/src/main/java/synapticloop/b2/request/B2UploadFileRequest.java index 9c8b3ce..4d6c760 100644 --- a/src/main/java/synapticloop/b2/request/B2UploadFileRequest.java +++ b/src/main/java/synapticloop/b2/request/B2UploadFileRequest.java @@ -67,8 +67,6 @@ public B2UploadFileRequest(B2AuthorizeAccountResponse b2AuthorizeAccountResponse * @param b2GetUploadUrlResponse the upload URL for this request * @param fileName the name of the file * @param file the file to upload - * @param mimeType the mimeTyp (optional, will default to 'b2/x-auto' which - * backblaze will attempt to determine automatically) * @param fileInfo the file info map which are passed through as headers * prefixed by "X-Bz-Info-" */ @@ -84,8 +82,8 @@ public B2UploadFileRequest(B2AuthorizeAccountResponse b2AuthorizeAccountResponse * @param b2GetUploadUrlResponse the upload URL for this request * @param fileName the name of the file * @param file the file to upload - * @param fileInfo the file info map which are passed through as headers - * prefixed by "X-Bz-Info-" + * @param mimeType the mimeTyp (optional, will default to 'b2/x-auto' which + * backblaze will attempt to determine automatically) */ public B2UploadFileRequest(B2AuthorizeAccountResponse b2AuthorizeAccountResponse, B2GetUploadUrlResponse b2GetUploadUrlResponse, String fileName, File file, String mimeType) { this(b2AuthorizeAccountResponse, b2GetUploadUrlResponse, fileName, file, mimeType, null);