Skip to content

Commit 0fbb1a6

Browse files
committed
added error handling in docs
1 parent ef17daf commit 0fbb1a6

File tree

9 files changed

+106
-3
lines changed

9 files changed

+106
-3
lines changed

README.md

Lines changed: 41 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
[![Release](https://jitpack.io/v/com.github.imagekit-developer/imagekit-java.svg)](https://jitpack.io/#com.github.imagekit-developer/imagekit-java)
55
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
66
[![Twitter Follow](https://img.shields.io/twitter/follow/imagekitio?label=Follow&style=social)](https://twitter.com/ImagekitIo)
7-
7+
88
Java SDK for [ImageKit.io](https://imagekit.io/) that implements the new APIs and interface for performing different file
99
operations.
1010

@@ -22,6 +22,7 @@ Table of contents -
2222
* [File upload](#file-upload)
2323
* [File management](#file-management)
2424
* [Utility functions](#utility-functions)
25+
* [Handling errors](#handling-errors)
2526
* [Support](#support)
2627
* [Links](#links)
2728

@@ -1043,7 +1044,45 @@ cd imagekit-java
10431044
# You will find jar in "imagekit-sdk/build/libs/" directory.
10441045
```
10451046

1046-
## Support
1047+
## Handling errors
1048+
Catch and respond to invalid data, internal problems, and more.
1049+
1050+
Imagekit Java SDK raise exceptions for many reasons, such as not found, invalid parameters, authentication errors, and internal server error. We recommend writing code that gracefully handles all possible API exceptions.
1051+
1052+
#### Example:
1053+
1054+
```java
1055+
try {
1056+
// Use ImageKit's SDK to make requests...
1057+
} catch (BadRequestException e) {
1058+
// Missing or Invalid parameters were supplied to Imagekit.io's API
1059+
System.out.println("Status is: " + e.getResponseMetaData().getHttpStatusCode());
1060+
System.out.println("Message is: " + e.getMessage());
1061+
System.out.println("Headers are: " + e.getResponseMetaData().getHeaders());
1062+
System.out.println("Raw body is: " + e.getResponseMetaData().getRaw());
1063+
System.out.println("Mapped body is: " + e.getResponseMetaData().getMap());
1064+
} catch (UnauthorizedException e) {
1065+
// No valid API key was provided.
1066+
} catch (ForbiddenException e) {
1067+
// Can be for the following reasons:
1068+
// ImageKit could not authenticate your account with the keys provided.
1069+
// An expired key (public or private) was used with the request.
1070+
// The account is disabled.
1071+
// If you are using the upload API, the total storage limit (or upload limit) is exceeded.
1072+
} catch (TooManyRequestsException e) {
1073+
// Too many requests made to the API too quickly
1074+
} catch (InternalServerException e) {
1075+
// Something went wrong with ImageKit.io API.
1076+
} catch (PartialSuccessException e) {
1077+
// Error cases on partial success.
1078+
} catch (NotFoundException e) {
1079+
// If any of the field or parameter is not found in data
1080+
} catch (UnknownException e) {
1081+
// Something else happened, which can be unrelated to imagekit, reason will be indicated in the message field
1082+
}
1083+
```
1084+
1085+
## Supporttim
10471086
For any feedback or to report any issues or general implementation support, please reach out to [[email protected]]()
10481087

10491088

imagekit-sdk/src/main/java/io/imagekit/sdk/exceptions/BadRequestException.java

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,16 @@ public class BadRequestException extends Exception {
88
private String help;
99
private ResponseMetaData responseMetaData;
1010

11+
public ResponseMetaData getResponseMetaData() {
12+
return responseMetaData;
13+
}
14+
15+
public void setResponseMetaData(ResponseMetaData responseMetaData) {
16+
this.responseMetaData = responseMetaData;
17+
}
18+
1119
public BadRequestException(String message, Throwable cause, boolean enableSuppression, boolean writableStackTrace,
12-
String message1, String help, ResponseMetaData responseMetaData) {
20+
String message1, String help, ResponseMetaData responseMetaData) {
1321
super(message, cause, enableSuppression, writableStackTrace);
1422
this.message = message1;
1523
this.help = help;

imagekit-sdk/src/main/java/io/imagekit/sdk/exceptions/ForbiddenException.java

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,14 @@ public ForbiddenException(String message, Throwable cause, boolean enableSuppres
1616
this.responseMetaData = responseMetaData;
1717
}
1818

19+
public ResponseMetaData getResponseMetaData() {
20+
return responseMetaData;
21+
}
22+
23+
public void setResponseMetaData(ResponseMetaData responseMetaData) {
24+
this.responseMetaData = responseMetaData;
25+
}
26+
1927
@Override
2028
public String toString() {
2129
return "ForbiddenException{" + "message='" + message + '\'' + ", help='" + help + '\'' + ", responseMetaData="

imagekit-sdk/src/main/java/io/imagekit/sdk/exceptions/InternalServerException.java

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,14 @@ public InternalServerException(String message, Throwable cause, boolean enableSu
1616
this.responseMetaData = responseMetaData;
1717
}
1818

19+
public ResponseMetaData getResponseMetaData() {
20+
return responseMetaData;
21+
}
22+
23+
public void setResponseMetaData(ResponseMetaData responseMetaData) {
24+
this.responseMetaData = responseMetaData;
25+
}
26+
1927
@Override
2028
public String toString() {
2129
return "InternalServerException{" + "message='" + message + '\'' + ", help='" + help + '\''

imagekit-sdk/src/main/java/io/imagekit/sdk/exceptions/NotFoundException.java

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,14 @@ public NotFoundException(String message, Throwable cause, boolean enableSuppress
1616
this.responseMetaData = responseMetaData;
1717
}
1818

19+
public ResponseMetaData getResponseMetaData() {
20+
return responseMetaData;
21+
}
22+
23+
public void setResponseMetaData(ResponseMetaData responseMetaData) {
24+
this.responseMetaData = responseMetaData;
25+
}
26+
1927
@Override
2028
public String toString() {
2129
return "NotFoundException{" + "message='" + message + '\'' + ", help='" + help + '\'' + ", responseMetaData="

imagekit-sdk/src/main/java/io/imagekit/sdk/exceptions/PartialSuccessException.java

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,14 @@ public PartialSuccessException(String message, Throwable cause, boolean enableSu
1616
this.responseMetaData = responseMetaData;
1717
}
1818

19+
public ResponseMetaData getResponseMetaData() {
20+
return responseMetaData;
21+
}
22+
23+
public void setResponseMetaData(ResponseMetaData responseMetaData) {
24+
this.responseMetaData = responseMetaData;
25+
}
26+
1927
@Override
2028
public String toString() {
2129
return "PartialSuccessException{" + "message='" + message + '\'' + ", help='" + help + '\''

imagekit-sdk/src/main/java/io/imagekit/sdk/exceptions/TooManyRequestsException.java

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,14 @@ public TooManyRequestsException(String message, Throwable cause, boolean enableS
1616
this.responseMetaData = responseMetaData;
1717
}
1818

19+
public ResponseMetaData getResponseMetaData() {
20+
return responseMetaData;
21+
}
22+
23+
public void setResponseMetaData(ResponseMetaData responseMetaData) {
24+
this.responseMetaData = responseMetaData;
25+
}
26+
1927
@Override
2028
public String toString() {
2129
return "TooManyRequestsException{" + "message='" + message + '\'' + ", help='" + help + '\''

imagekit-sdk/src/main/java/io/imagekit/sdk/exceptions/UnauthorizedException.java

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,14 @@ public UnauthorizedException(String message, Throwable cause, boolean enableSupp
1616
this.responseMetaData = responseMetaData;
1717
}
1818

19+
public ResponseMetaData getResponseMetaData() {
20+
return responseMetaData;
21+
}
22+
23+
public void setResponseMetaData(ResponseMetaData responseMetaData) {
24+
this.responseMetaData = responseMetaData;
25+
}
26+
1927
@Override
2028
public String toString() {
2129
return "UnauthorizedException{" + "message='" + message + '\'' + ", help='" + help + '\''

imagekit-sdk/src/main/java/io/imagekit/sdk/exceptions/UnknownException.java

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,14 @@ public UnknownException(String message, Throwable cause, boolean enableSuppressi
2020
this.responseMetaData = responseMetaData;
2121
}
2222

23+
public ResponseMetaData getResponseMetaData() {
24+
return responseMetaData;
25+
}
26+
27+
public void setResponseMetaData(ResponseMetaData responseMetaData) {
28+
this.responseMetaData = responseMetaData;
29+
}
30+
2331
@Override
2432
public String toString() {
2533
return "UnknownException{" + "message='" + message + '\'' + ", help='" + help + '\'' + ", responseMetaData="

0 commit comments

Comments
 (0)