Java Docs Update #730

sinhaashish · 2018-11-16T10:23:32Z

API.md is updated with methods present in http://minio.github.io/minio-java/

balamurugana · 2018-11-16T12:19:45Z

api/src/main/java/io/minio/MinioClient.java

   *     DeleteError error = errorResult.get();
   *     System.out.println("Failed to remove '" + error.objectName() + "'. Error:" + error.message());
   * } }</pre>
   *
   * @param bucketName Bucket name.
   * @param objectNames List of Object names in the bucket.
   */
-  public Iterable<Result<DeleteError>> removeObject(final String bucketName, final Iterable<String> objectNames) {
+  public Iterable<Result<DeleteError>> removeObjects(final String bucketName, final Iterable<String> objectNames) {


Is it agreed to change the name? If so, its a breaking change and you would need to bump up major version.

Is it agreed to change the name?
Checked with @kannappanr @deekoder before changing the name.

Only the public method name is changed. Made the changed in minio-java . Please tell what can break because of this? I can retrofit it in the PR.

Currently available http://minio.github.io/minio-java/io/minio/MinioClient.html#removeObject-java.lang.String-java.lang.Iterable- is removed and new method removeObjects() is available to do that same in next release. Already developed code of users using http://minio.github.io/minio-java/io/minio/MinioClient.html#removeObject-java.lang.String-java.lang.Iterable- will get an error for next release. This needs to be notified indirectly by bumping up major version.

We did discuss the impact of this breaking change with AB. I think we just have to call it out as a BREAKING CHANGE when we do a release with this PR.

balamurugana · 2018-11-16T12:22:30Z

api/src/main/java/io/minio/MinioClient.java

@@ -3413,7 +3413,7 @@ private String putObject(String bucketName, String objectName, int length,
   */
  private void putObject(String bucketName, String objectName, Long size, Object data,
      Map<String, String> headerMap, ServerSideEncryption sse)
-    throws InvalidBucketNameException, NoSuchAlgorithmException, InsufficientDataException, IOException,
+    throws InvalidBucketNameException, NoSuchAlgorithmException, IOException,


Isn't UnsufficentDataException going to be thrown any more for all the above methods?

InsufficientDataException was redundant in the signature, It was coming twice. So removed the extra one.

ebozduman · 2018-11-16T21:43:43Z

docs/API.md

+|        | ``ErrorResponseException`` : upon unsuccessful execution.            |
+|        | ``InternalException`` : upon internal library error.        |
+|        | ``InvalidArgumentException`` : upon invalid value is passed to a method.        |
+|        | ``InsufficientDataException`` : Thrown to indicate that reading given InputStream gets EOFException before reading given length. |


InsufficientDataException is removed up at the top.
Do we still throw this exception?

InsufficientDataException is still there in the method signature. I was just that InsufficientDataException was defined twice in the method signature. I removed one just to remove the redundancy.

ebozduman · 2018-11-16T21:46:37Z

docs/API.md

+|        | ``ErrorResponseException`` : upon unsuccessful execution.            |
+|        | ``InternalException`` : upon internal library error.        |
+|        | ``InvalidArgumentException`` : upon invalid value is passed to a method.        |
+|        | ``InsufficientDataException`` : Thrown to indicate that reading given InputStream gets EOFException before reading given length. |


InsufficientDataException is removed up at the top.
Do we still throw this exception?

InsufficientDataException is still there in the method signature. I was just that InsufficientDataException was defined twice in the method signature. I removed one just to remove the redundancy.

ebozduman · 2018-11-16T21:47:16Z

docs/API.md

 |        | ``org.xmlpull.v1.XmlPullParserException`` : upon parsing response XML.            |
 |        | ``ErrorResponseException`` : upon unsuccessful execution.            |
 |        | ``InternalException`` : upon internal library error.        |
-
+|        | ``InvalidArgumentException`` : upon invalid value is passed to a method.        |
+|        | ``InsufficientDataException`` : Thrown to indicate that reading given InputStream gets EOFException before reading given length. |


InsufficientDataException is removed up at the top.
Do we still throw this exception?

InsufficientDataException is still there in the method signature. I was just that InsufficientDataException was defined twice in the method signature. I removed one just to remove the redundancy.

ebozduman · 2018-11-19T20:16:57Z

api/src/main/java/io/minio/MinioClient.java

   *     DeleteError error = errorResult.get();
   *     System.out.println("Failed to remove '" + error.objectName() + "'. Error:" + error.message());
   * } }</pre>
   *
   * @param bucketName Bucket name.
   * @param objectNames List of Object names in the bucket.
   */
-  public Iterable<Result<DeleteError>> removeObject(final String bucketName, final Iterable<String> objectNames) {
+  public Iterable<Result<DeleteError>> removeObjects(final String bucketName, final Iterable<String> objectNames) {


All other SDKs, Go, JavaScript, Python, .NET, have 2 methods to remove objects:

removeObject() for single object removal

removeObjects() for multiple object removal

I think we need to stick with that approach for consistency purposes.

This is under discussion . @deekoder can you please confirm on this.

By the way, no matter which way we choose to go about renaming the method, Bala's point about breaking compatibility is going to be still valid.

docs/API.md

nitisht · 2018-11-27T15:44:46Z

I understand it is discussed with @abperiasamy now. @sinhaashish can you update on the conclusion

sinhaashish · 2018-11-28T07:22:12Z

I understand it is discussed with @abperiasamy now. @sinhaashish can you update on the conclusion

Results:

We will be going with removeObjects.
The already present methods Filter filter() and public void filter(Filter filter) will be present but with a depreacted tag which will be removed in 6 months.
Addition of getFilter() and getFilter() methods
Will update the PR as per the discussion.

api/src/main/java/io/minio/messages/QueueConfiguration.java

sinhaashish · 2018-12-06T06:05:59Z

@balamurugana @ebozduman PTAL

api/src/main/java/io/minio/MinioClient.java

api/src/main/java/io/minio/messages/QueueConfiguration.java

api/src/main/java/io/minio/MinioClient.java

ebozduman

LGTM

Java Docs been updated with adding the relevant exceptions, removing the deprecated code.

kannappanr · 2019-01-04T17:15:31Z

ping @balamurugana @ebozduman Can you please review again?

ebozduman

LGTM

yashchavan2001 · 2019-02-28T08:47:20Z

MinioClient minioClient = new MinioClient("https://play.minio.io:9000",9000, "Q3AM3UQ867SPQQA43P2F", "zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG",true);
2.boolean isExist = minioClient.bucketExists("asiatrip");

In java, There is error when I call line 2nd->
02-28 14:16:31.811 2766-2766/com.example.minio E/AndroidRuntime: FATAL EXCEPTION: main
Process: com.example.minio, PID: 2766
java.lang.NoClassDefFoundError: com.google.common.escape.Escaper$1
at com.google.common.escape.Escaper.(Escaper.java:85)
at com.google.common.escape.UnicodeEscaper.(UnicodeEscaper.java:59)
at com.google.common.net.PercentEscaper.(PercentEscaper.java:85)
at com.google.common.net.UrlEscapers.(UrlEscapers.java:78)
at com.google.common.net.UrlEscapers.urlPathSegmentEscaper(UrlEscapers.java:111)
at io.minio.S3Escaper.(S3Escaper.java:24)
at io.minio.S3Escaper.encode(S3Escaper.java:30)
at io.minio.MinioClient.createRequest(MinioClient.java:893)
at io.minio.MinioClient.executeReq(MinioClient.java:1075)
at io.minio.MinioClient.execute(MinioClient.java:1056)
at io.minio.MinioClient.updateRegionCache(MinioClient.java:1213)
at io.minio.MinioClient.getRegion(MinioClient.java:1258)
at io.minio.MinioClient.executeHead(MinioClient.java:1306)
at io.minio.MinioClient.bucketExists(MinioClient.java:3280)
at com.example.minio.MinioObject.uploadObject(MinioObject.java:27)
at com.example.minio.MainActivity.onActivityResult(MainActivity.java:151)
at android.app.Activity.dispatchActivityResult(Activity.java:6556)
at android.app.ActivityThread.deliverResults(ActivityThread.java:3814)
at android.app.ActivityThread.handleSendResult(ActivityThread.java:3861)
at android.app.ActivityThread.access$1500(ActivityThread.java:166)
at android.app.ActivityThread$H.handleMessage(ActivityThread.java:1463)
at android.os.Handler.dispatchMessage(Handler.java:102)
at android.os.Looper.loop(Looper.java:148)
at android.app.ActivityThread.main(ActivityThread.java:5619)
at java.lang.reflect.Method.invoke(Native Method)
at com.android.internal.os.ZygoteInit$MethodAndArgsCaller.run(ZygoteInit.java:853)
at com.android.internal.os.ZygoteInit.main(ZygoteInit.java:737)

nitisht · 2019-02-28T09:00:21Z

@yashchavan2001 please create a new issue with details like SDK version etc

nitisht requested review from balamurugana and ebozduman November 16, 2018 12:11

balamurugana reviewed Nov 16, 2018

View reviewed changes

sinhaashish force-pushed the DocsUpdate branch 2 times, most recently from cce7b64 to 877e42b Compare November 19, 2018 05:34

krisis added the blocked label Nov 19, 2018

ebozduman requested changes Nov 19, 2018

View reviewed changes

sinhaashish force-pushed the DocsUpdate branch from 877e42b to d6a8414 Compare November 20, 2018 04:54

nitisht removed the blocked label Nov 27, 2018

sinhaashish force-pushed the DocsUpdate branch 2 times, most recently from 4fded8f to 3e01a79 Compare November 29, 2018 09:46

ebozduman requested changes Dec 2, 2018

View reviewed changes

api/src/main/java/io/minio/messages/QueueConfiguration.java Outdated Show resolved Hide resolved

sinhaashish force-pushed the DocsUpdate branch 4 times, most recently from 5f84e4e to b38cde7 Compare December 6, 2018 04:37

balamurugana reviewed Dec 6, 2018

View reviewed changes

api/src/main/java/io/minio/MinioClient.java Outdated Show resolved Hide resolved

balamurugana reviewed Dec 6, 2018

View reviewed changes

api/src/main/java/io/minio/messages/QueueConfiguration.java Outdated Show resolved Hide resolved

balamurugana reviewed Dec 6, 2018

View reviewed changes

api/src/main/java/io/minio/messages/QueueConfiguration.java Outdated Show resolved Hide resolved

sinhaashish force-pushed the DocsUpdate branch 2 times, most recently from f39f98f to cae5a76 Compare December 7, 2018 07:43

balamurugana reviewed Dec 7, 2018

View reviewed changes

api/src/main/java/io/minio/MinioClient.java Outdated Show resolved Hide resolved

sinhaashish force-pushed the DocsUpdate branch 2 times, most recently from 1b9cd51 to fa8c0ae Compare December 8, 2018 01:45

ebozduman previously approved these changes Dec 12, 2018

View reviewed changes

sinhaashish dismissed ebozduman’s stale review via 08c7556 January 4, 2019 06:59

sinhaashish force-pushed the DocsUpdate branch 5 times, most recently from de86d0b to ff7ea89 Compare January 4, 2019 09:16

Update Java Docs

b9fa068

Java Docs been updated with adding the relevant exceptions, removing the deprecated code.

sinhaashish force-pushed the DocsUpdate branch from ff7ea89 to b9fa068 Compare January 4, 2019 09:37

ebozduman approved these changes Jan 4, 2019

View reviewed changes

balamurugana approved these changes Jan 5, 2019

View reviewed changes

nitisht merged commit 700f700 into minio:master Jan 5, 2019

sinhaashish deleted the DocsUpdate branch January 23, 2019 10:35

kannappanr mentioned this pull request Jan 30, 2019

Fix API documentation #723

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Java Docs Update #730

Java Docs Update #730

sinhaashish commented Nov 16, 2018

balamurugana Nov 16, 2018

sinhaashish Nov 17, 2018 •

edited

Loading

sinhaashish Nov 17, 2018

balamurugana Nov 17, 2018

deekoder Dec 14, 2018

balamurugana Nov 16, 2018

sinhaashish Nov 17, 2018

ebozduman Nov 16, 2018

sinhaashish Nov 20, 2018

ebozduman Nov 16, 2018

sinhaashish Nov 20, 2018

ebozduman Nov 16, 2018

sinhaashish Nov 20, 2018

ebozduman Nov 19, 2018

sinhaashish Nov 20, 2018

ebozduman Nov 20, 2018

nitisht commented Nov 27, 2018 •

edited

Loading

sinhaashish commented Nov 28, 2018 •

edited

Loading

sinhaashish commented Dec 6, 2018

ebozduman left a comment

kannappanr commented Jan 4, 2019

ebozduman left a comment

yashchavan2001 commented Feb 28, 2019

nitisht commented Feb 28, 2019

Java Docs Update #730

Java Docs Update #730

Conversation

sinhaashish commented Nov 16, 2018

Choose a reason for hiding this comment

sinhaashish Nov 17, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nitisht commented Nov 27, 2018 • edited Loading

sinhaashish commented Nov 28, 2018 • edited Loading

sinhaashish commented Dec 6, 2018

ebozduman left a comment

Choose a reason for hiding this comment

kannappanr commented Jan 4, 2019

ebozduman left a comment

Choose a reason for hiding this comment

yashchavan2001 commented Feb 28, 2019

nitisht commented Feb 28, 2019

sinhaashish Nov 17, 2018 •

edited

Loading

nitisht commented Nov 27, 2018 •

edited

Loading

sinhaashish commented Nov 28, 2018 •

edited

Loading