refactor(generic-api): adding throwsApiExcetion method as default error handler

yue9944882 · yue9944882 · commit 1065775e6017 · 2020-09-15T16:47:31.000+08:00
diff --git a/docs/generate-model-from-third-party-resources.md b/docs/generate-model-from-third-party-resources.md
@@ -122,8 +122,9 @@ customObjectsApi.createNamespacedCustomObject(
 // alternatively use generic kubernetes api, the generic api is aimed to address the drawbacks
 // from the CustomObjectsApi.
 GenericKubernetesApi<V1CronTab, V1CronTabList> crontabClient =
-    new GenericKubernetesApi<>(V1CronTab.class, V1CronTabList.class, "com.example.stable", "v1", "crontabs", apiClient);
-KubernetesApiResponse<V1CronTab> createResponse = crontabClient.create(crontab);
+    new GenericKubernetesApi<>(V1CronTab.class, V1CronTabList.class, "com.example.stable", "v1", "crontabs", apiClient)
+        .create(crontab)
+        .throwsApiException();
 ```
 
 
diff --git a/examples/src/main/java/io/kubernetes/client/examples/GenericClientExample.java b/examples/src/main/java/io/kubernetes/client/examples/GenericClientExample.java
@@ -14,7 +14,6 @@
 
 import io.kubernetes.client.custom.V1Patch;
 import io.kubernetes.client.openapi.ApiClient;
-import io.kubernetes.client.openapi.ApiException;
 import io.kubernetes.client.openapi.models.V1Container;
 import io.kubernetes.client.openapi.models.V1ObjectMeta;
 import io.kubernetes.client.openapi.models.V1Pod;
@@ -40,15 +39,7 @@ public static void main(String[] args) throws Exception {
     GenericKubernetesApi<V1Pod, V1PodList> podClient =
         new GenericKubernetesApi<>(V1Pod.class, V1PodList.class, "", "v1", "pods", apiClient);
 
-    V1Pod latestPod =
-        podClient
-            .create(pod)
-            .onFailure(
-                errorStatus -> {
-                  System.out.println("Not Created!");
-                  throw new ApiException(errorStatus.toString());
-                })
-            .getObject();
+    V1Pod latestPod = podClient.create(pod).throwsApiException().getObject();
     System.out.println("Created!");
 
     V1Pod patchedPod =
@@ -58,23 +49,11 @@ public static void main(String[] args) throws Exception {
                 "foo",
                 V1Patch.PATCH_FORMAT_STRATEGIC_MERGE_PATCH,
                 new V1Patch("{\"metadata\":{\"finalizers\":[\"example.io/foo\"]}}"))
-            .onFailure(
-                errorStatus -> {
-                  System.out.println("Not Patched!");
-                  throw new ApiException(errorStatus.toString());
-                })
+            .throwsApiException()
             .getObject();
     System.out.println("Patched!");
 
-    V1Pod deletedPod =
-        podClient
-            .delete("default", "foo")
-            .onFailure(
-                errorStatus -> {
-                  System.out.println("Not Deleted!");
-                  throw new ApiException(errorStatus.toString());
-                })
-            .getObject();
+    V1Pod deletedPod = podClient.delete("default", "foo").throwsApiException().getObject();
     if (deletedPod != null) {
       System.out.println(
           "Received after-deletion status of the requested object, will be deleting in background!");
diff --git a/examples/src/main/java/io/kubernetes/client/examples/PromOpExample.java b/examples/src/main/java/io/kubernetes/client/examples/PromOpExample.java
@@ -15,13 +15,14 @@
 import com.coreos.monitoring.models.V1Prometheus;
 import com.coreos.monitoring.models.V1PrometheusList;
 import com.coreos.monitoring.models.V1PrometheusSpec;
+import io.kubernetes.client.openapi.ApiException;
 import io.kubernetes.client.openapi.models.V1ObjectMeta;
 import io.kubernetes.client.util.ClientBuilder;
 import io.kubernetes.client.util.generic.GenericKubernetesApi;
 import java.io.IOException;
 
 public class PromOpExample {
-  public static void main(String[] args) throws IOException {
+  public static void main(String[] args) throws IOException, ApiException {
     GenericKubernetesApi<V1Prometheus, V1PrometheusList> prometheusApi =
         new GenericKubernetesApi<>(
             V1Prometheus.class,
@@ -30,11 +31,13 @@ public static void main(String[] args) throws IOException {
             "v1",
             "prometheuses",
             ClientBuilder.defaultClient());
-    prometheusApi.create(
-        new V1Prometheus()
-            .metadata(new V1ObjectMeta().namespace("default").name("my-prometheus"))
-            .kind("Prometheus")
-            .apiVersion("monitoring.coreos.com/v1")
-            .spec(new V1PrometheusSpec()));
+    prometheusApi
+        .create(
+            new V1Prometheus()
+                .metadata(new V1ObjectMeta().namespace("default").name("my-prometheus"))
+                .kind("Prometheus")
+                .apiVersion("monitoring.coreos.com/v1")
+                .spec(new V1PrometheusSpec()))
+        .throwsApiException();
   }
 }
diff --git a/extended/src/main/java/io/kubernetes/client/extended/kubectl/KubectlAnnotate.java b/extended/src/main/java/io/kubernetes/client/extended/kubectl/KubectlAnnotate.java
@@ -46,27 +46,13 @@ public ApiType execute() throws KubectlException {
     final ApiType currentObj;
     if (isNamespaced(apiTypeClass)) {
       try {
-        currentObj =
-            getGenericApi()
-                .get(namespace, name)
-                .onFailure(
-                    errorStatus -> {
-                      throw new ApiException(errorStatus.toString());
-                    })
-                .getObject();
+        currentObj = getGenericApi().get(namespace, name).throwsApiException().getObject();
       } catch (ApiException e) {
         throw new KubectlException(e);
       }
     } else {
       try {
-        currentObj =
-            getGenericApi()
-                .get(name)
-                .onFailure(
-                    errorStatus -> {
-                      throw new ApiException(errorStatus.toString());
-                    })
-                .getObject();
+        currentObj = getGenericApi().get(name).throwsApiException().getObject();
       } catch (ApiException e) {
         throw new KubectlException(e);
       }
@@ -76,13 +62,7 @@ public ApiType execute() throws KubectlException {
 
     final KubernetesApiResponse<ApiType> updateResponse;
     try {
-      return getGenericApi()
-          .update(currentObj)
-          .onFailure(
-              errorStatus -> {
-                throw new ApiException(errorStatus.toString());
-              })
-          .getObject();
+      return getGenericApi().update(currentObj).throwsApiException().getObject();
     } catch (ApiException e) {
       throw new KubectlException(e);
     }
diff --git a/extended/src/main/java/io/kubernetes/client/extended/kubectl/KubectlApply.java b/extended/src/main/java/io/kubernetes/client/extended/kubectl/KubectlApply.java
@@ -92,10 +92,7 @@ private KubernetesObject executeServerSideApply() throws KubectlException {
                 V1Patch.PATCH_FORMAT_APPLY_YAML,
                 new V1Patch(apiClient.getJSON().serialize(targetObj)),
                 patchOptions)
-            .onFailure(
-                errorStatus -> {
-                  throw new ApiException(errorStatus.toString());
-                })
+            .throwsApiException()
             .getObject();
       } catch (ApiException e) {
         throw new KubectlException(e);
@@ -107,10 +104,7 @@ private KubernetesObject executeServerSideApply() throws KubectlException {
                 V1Patch.PATCH_FORMAT_APPLY_YAML,
                 new V1Patch(apiClient.getJSON().serialize(targetObj)),
                 patchOptions)
-            .onFailure(
-                errorStatus -> {
-                  throw new ApiException(errorStatus.toString());
-                })
+            .throwsApiException()
             .getObject();
       } catch (ApiException e) {
         throw new KubectlException(e);
diff --git a/extended/src/main/java/io/kubernetes/client/extended/kubectl/KubectlCordon.java b/extended/src/main/java/io/kubernetes/client/extended/kubectl/KubectlCordon.java
@@ -42,10 +42,7 @@ protected V1Node performCordon() throws KubectlException {
     try {
       return getGenericApi()
           .patch(name, V1Patch.PATCH_FORMAT_JSON_PATCH, new V1Patch(patch))
-          .onFailure(
-              errorStatus -> {
-                throw new ApiException(errorStatus.toString());
-              })
+          .throwsApiException()
           .getObject();
     } catch (ApiException e) {
       throw new KubectlException(e);
diff --git a/extended/src/main/java/io/kubernetes/client/extended/kubectl/KubectlCreate.java b/extended/src/main/java/io/kubernetes/client/extended/kubectl/KubectlCreate.java
@@ -51,22 +51,14 @@ public KubernetesObject execute() throws KubectlException {
                   : targetObj.getMetadata().getNamespace();
       try {
         return api.create(targetNamespace, targetObj, new CreateOptions())
-            .onFailure(
-                errorStatus -> {
-                  throw new ApiException(errorStatus.toString());
-                })
+            .throwsApiException()
             .getObject();
       } catch (ApiException e) {
         throw new KubectlException(e);
       }
     } else {
       try {
-        return api.create(targetObj, new CreateOptions())
-            .onFailure(
-                errorStatus -> {
-                  throw new ApiException(errorStatus.toString());
-                })
-            .getObject();
+        return api.create(targetObj, new CreateOptions()).throwsApiException().getObject();
       } catch (ApiException e) {
         throw new KubectlException(e);
       }
diff --git a/extended/src/main/java/io/kubernetes/client/extended/kubectl/KubectlDelete.java b/extended/src/main/java/io/kubernetes/client/extended/kubectl/KubectlDelete.java
@@ -33,25 +33,13 @@ public ApiType execute() throws KubectlException {
 
     if (isNamespaced(apiTypeClass)) {
       try {
-        return getGenericApi()
-            .delete(namespace, name)
-            .onFailure(
-                errorStatus -> {
-                  throw new ApiException(errorStatus.toString());
-                })
-            .getObject();
+        return getGenericApi().delete(namespace, name).throwsApiException().getObject();
       } catch (ApiException e) {
         throw new KubectlException(e);
       }
     } else {
       try {
-        return getGenericApi()
-            .delete(name)
-            .onFailure(
-                errorStatus -> {
-                  throw new ApiException(errorStatus.toString());
-                })
-            .getObject();
+        return getGenericApi().delete(name).throwsApiException().getObject();
       } catch (ApiException e) {
         throw new KubectlException(e);
       }
diff --git a/extended/src/main/java/io/kubernetes/client/extended/kubectl/KubectlGet.java b/extended/src/main/java/io/kubernetes/client/extended/kubectl/KubectlGet.java
@@ -64,23 +64,10 @@ public List<ApiType> execute() throws KubectlException {
     try {
       if (isNamespaced()) {
         return (List<ApiType>)
-            api.list(namespace, listOptions)
-                .onFailure(
-                    errorStatus -> {
-                      throw new ApiException(errorStatus.toString());
-                    })
-                .getObject()
-                .getItems();
+            api.list(namespace, listOptions).throwsApiException().getObject().getItems();
 
       } else {
-        return (List<ApiType>)
-            api.list(listOptions)
-                .onFailure(
-                    errorStatus -> {
-                      throw new ApiException(errorStatus.toString());
-                    })
-                .getObject()
-                .getItems();
+        return (List<ApiType>) api.list(listOptions).throwsApiException().getObject().getItems();
       }
     } catch (ApiException e) {
       throw new KubectlException(e);
@@ -113,19 +100,11 @@ public ApiType execute() throws KubectlException {
       try {
         if (isNamespaced()) {
           return api.get(KubectlGetSingle.this.namespace, KubectlGetSingle.this.name)
-              .onFailure(
-                  errorStatus -> {
-                    throw new ApiException(errorStatus.toString());
-                  })
+              .throwsApiException()
               .getObject();
 
         } else {
-          return api.get(KubectlGetSingle.this.name)
-              .onFailure(
-                  errorStatus -> {
-                    throw new ApiException(errorStatus.toString());
-                  })
-              .getObject();
+          return api.get(KubectlGetSingle.this.name).throwsApiException().getObject();
         }
       } catch (ApiException e) {
         throw new KubectlException(e);
diff --git a/extended/src/main/java/io/kubernetes/client/extended/kubectl/KubectlLabel.java b/extended/src/main/java/io/kubernetes/client/extended/kubectl/KubectlLabel.java
@@ -45,27 +45,13 @@ public ApiType execute() throws KubectlException {
     final ApiType currentObj;
     if (isNamespaced(apiTypeClass)) {
       try {
-        currentObj =
-            getGenericApi()
-                .get(namespace, name)
-                .onFailure(
-                    errorStatus -> {
-                      throw new ApiException(errorStatus.toString());
-                    })
-                .getObject();
+        currentObj = getGenericApi().get(namespace, name).throwsApiException().getObject();
       } catch (ApiException e) {
         throw new KubectlException(e);
       }
     } else {
       try {
-        currentObj =
-            getGenericApi()
-                .get(name)
-                .onFailure(
-                    errorStatus -> {
-                      throw new ApiException(errorStatus.toString());
-                    })
-                .getObject();
+        currentObj = getGenericApi().get(name).throwsApiException().getObject();
       } catch (ApiException e) {
         throw new KubectlException(e);
       }
@@ -74,13 +60,7 @@ public ApiType execute() throws KubectlException {
     Labels.addLabels(currentObj, addingLabels);
 
     try {
-      return getGenericApi()
-          .update(currentObj)
-          .onFailure(
-              errorStatus -> {
-                throw new ApiException(errorStatus.toString());
-              })
-          .getObject();
+      return getGenericApi().update(currentObj).throwsApiException().getObject();
     } catch (ApiException e) {
       throw new KubectlException(e);
     }
diff --git a/extended/src/main/java/io/kubernetes/client/extended/kubectl/KubectlReplace.java b/extended/src/main/java/io/kubernetes/client/extended/kubectl/KubectlReplace.java
@@ -46,25 +46,13 @@ public ApiType execute() throws KubectlException {
 
     if (isNamespaced(apiTypeClass)) {
       try {
-        return getGenericApi()
-            .update(updateObject, options)
-            .onFailure(
-                errorStatus -> {
-                  throw new ApiException(errorStatus.toString());
-                })
-            .getObject();
+        return getGenericApi().update(updateObject, options).throwsApiException().getObject();
       } catch (ApiException e) {
         throw new KubectlException(e);
       }
     } else {
       try {
-        return getGenericApi()
-            .update(updateObject, options)
-            .onFailure(
-                errorStatus -> {
-                  throw new ApiException(errorStatus.toString());
-                })
-            .getObject();
+        return getGenericApi().update(updateObject, options).throwsApiException().getObject();
       } catch (ApiException e) {
         throw new KubectlException(e);
       }
diff --git a/util/src/main/java/io/kubernetes/client/informer/SharedInformerFactory.java b/util/src/main/java/io/kubernetes/client/informer/SharedInformerFactory.java
@@ -213,10 +213,7 @@ public ApiListType list(CallGeneratorParams params) throws ApiException {
                     setTimeoutSeconds(params.timeoutSeconds);
                   }
                 })
-            .onFailure(
-                errorStatus -> {
-                  throw new ApiException(errorStatus.toString());
-                })
+            .throwsApiException()
             .getObject();
       }
 
diff --git a/util/src/main/java/io/kubernetes/client/util/generic/KubernetesApiResponse.java b/util/src/main/java/io/kubernetes/client/util/generic/KubernetesApiResponse.java
@@ -50,6 +50,27 @@ public boolean isSuccess() {
     return this.httpStatusCode < 400;
   }
 
+  /**
+   * Throws api exception kubernetes api response on failure. This is the recommended approach to
+   * deal with errors returned from server.
+   *
+   * @return the kubernetes api response
+   * @throws ApiException the api exception
+   */
+  public KubernetesApiResponse<DataType> throwsApiException() throws ApiException {
+    return onFailure(
+        errorStatus -> {
+          throw new ApiException(errorStatus.toString());
+        });
+  }
+
+  /**
+   * Calling errorStatusHandler upon errors from server..
+   *
+   * @param errorStatusHandler the error status handler
+   * @return the kubernetes api response
+   * @throws ApiException the api exception
+   */
   public KubernetesApiResponse<DataType> onFailure(ErrorStatusHandler errorStatusHandler)
       throws ApiException {
     if (!isSuccess()) {
