Rename ErrorCode

Author: duhengforever

openmessaging-api/src/main/java/io/openmessaging/Error.java

@@ -18,18 +18,22 @@
 package io.openmessaging;
 
 /**
+ * <p>
  * A {@code Future} represents the result of an asynchronous computation.  Methods are provided to check if the
  * computation is complete, to wait for its completion, and to retrieve the result of the computation.  The result can
  * only be retrieved using method {@code get} when the computation has completed, blocking if necessary until it is
  * ready. Additional methods are provided to determine if the task completed normally or was cancelled.
+ * </p>
+ * <p>
+ * The reason for adding this future is mainly to satisfy the old version of jdk, such as jdk 1.6.
+ * </p>
  *
  * @version OMS 1.0.0
  * @since OMS 1.0.0
  */
 public interface Future<V> {
     /**
-     * Returns {@code true} if this task was cancelled before it completed
-     * normally.
+     * Returns {@code true} if this task was cancelled before it completed normally.
      *
      * @return {@code true} if this task was cancelled before it completed
      */
@@ -38,34 +42,32 @@ public interface Future<V> {
     /**
      * Returns {@code true} if this task completed.
      * <p>
-     * Completion may be due to normal termination, an exception, or
-     * cancellation -- in all of these cases, this method will return
-     * {@code true}.
+     * Completion may be due to normal termination, an exception, or cancellation -- in all of these cases, this method
+     * will return {@code true}.
      *
      * @return {@code true} if this task completed
      */
     boolean isDone();
 
     /**
-     * Waits if necessary for the computation to complete, and then
-     * retrieves its result.
+     * Waits if necessary for the computation to complete, and then retrieves its result.
      *
      * @return the computed result
      */
     V get();
 
     /**
-     * Waits if necessary for at most the given time for the computation
-     * to complete, and then retrieves its result, if available.
+     * Waits if necessary for at most the given time for the computation to complete, and then retrieves its result, if
+     * available.
      *
      * @param timeout the maximum time to wait
      * @return the computed result <p> if the computation was cancelled
      */
     V get(long timeout);
 
     /**
-     * Adds the specified listener to this future. The specified listener is notified when this future is done. If
-     * this future is already completed, the specified listener will be notified immediately.
+     * Adds the specified listener to this future. The specified listener is notified when this future is done. If this
+     * future is already completed, the specified listener will be notified immediately.
      *
      * @param listener FutureListener
      */

openmessaging-api/src/main/java/io/openmessaging/Future.java

@@ -0,0 +1,130 @@
+package io.openmessaging;
+
+import io.openmessaging.exception.OMSRuntimeException;
+
+/**
+ * This class defined OpenMessaging response status code:
+ * <p>
+ * 110x: The request was received, continuing process
+ * </p>
+ * <p>
+ * 120x: The request was successfully received, understood, and accepted
+ * </p>
+ * <p>
+ * 130x: Further action needs to be taken in order to complete the request
+ * </p>
+ * <p>
+ * 140x: The request contains bad syntax or cannot be fulfilled
+ * </p>
+ * <p>
+ * 150x: The server failed to fulfill an apparently valid request
+ * </p>
+ * <p>
+ * 1000x: OpenMessaging internal status code for create {@link MessagingAccessPoint}
+ * </p>
+ */
+public enum OMSResponseStatus {
+    STATUS_1101(1101, "Unsupported Version"),
+
+    STATUS_1200(1200, "Success"),
+
+    STATUS_1400(1400, "Bad Request"),
+
+    STATUS_1401(1401, "Unauthorized"),
+
+    STATUS_1402(1402, "Message body Required"),
+
+    STATUS_1403(1403, "Forbidden"),
+
+    STATUS_1404(1404, "Destination Not Found"),
+
+    STATUS_1405(1405, "Namespace Not Found"),
+
+    STATUS_1406(1406, "Destination Already Exists"),
+
+    STATUS_1407(1407, "Namespace Already Exists"),
+
+    STATUS_1408(1408, "ConsumerId Already Exists"),
+
+    STATUS_1409(1409, "ProducerId Already Exists"),
+
+    STATUS_1410(1410, "Request Timeout"),
+
+    STATUS_1411(1411, "Message Attributes Too Large"),
+
+    STATUS_1412(1412, "Message Header Too Large"),
+
+    STATUS_1413(1413, "Message Body Too Large"),
+
+    STATUS_1414(1414, "No New Message Found"),
+
+    STATUS_1415(1415, "Max Topics Reached"),
+
+    STATUS_1416(1416, "Max Queues Reached"),
+
+    STATUS_1417(1417, "Max Namespaces Reached"),
+
+    STATUS_1418(1418, "Bad Parameter"),
+
+    STATUS_1500(1500, "Server STATUS"),
+
+    STATUS_1501(1501, "Storage Service STATUS"),
+
+    STATUS_1502(1502, "Storage Service Busy"),
+
+    STATUS_1503(1503, "Service Not Available"),
+
+    STATUS_1504(1504, "Flush Disk Timeout"),
+
+    STATUS_10000(10000, "Can't construct a MessagingAccessPoint instance from the given OMS driver URL [%s]."),
+
+    STATUS_10001(10001, "The OMS driver URL [%s] is illegal."),
+
+    STATUS_10002(10002, "The implementation version [%s] is illegal."),
+
+    STATUS_10003(10003, "The implementation version [%s] isn't compatible with the specification version [%s].");
+
+    private int statusCode;
+
+    private String reasonPhrase;
+
+    private String reasonLocation;
+
+    private static final String refBase = "http://openmessaging.cloud/internal/code";
+
+    OMSResponseStatus(int statusCode, String reasonPhrase) {
+        this.statusCode = statusCode;
+
+        this.reasonPhrase = reasonPhrase;
+
+        this.reasonLocation = generateReasonLocation(statusCode, reasonPhrase);
+    }
+
+    public int getStatusCode() {
+        return statusCode;
+    }
+
+    public String getReasonLocation() {
+        return reasonLocation;
+    }
+
+    public String getReasonPhrase() {
+        return reasonPhrase;
+    }
+
+    public static OMSRuntimeException generateException(OMSResponseStatus status, String... messageArgs) {
+        return new OMSRuntimeException(status.getStatusCode(), String.format(status.getReasonLocation(), (Object[]) messageArgs));
+    }
+
+    public static OMSRuntimeException generateException(OMSResponseStatus status) {
+        return new OMSRuntimeException(status.getStatusCode(), status.getReasonLocation());
+    }
+
+    public static OMSRuntimeException generateException(int statusCode, String reasonPhrase) {
+        return new OMSRuntimeException(statusCode, reasonPhrase);
+    }
+
+    public static String generateReasonLocation(int statusCode, String reasonPhrase) {
+        return reasonPhrase + "\nFor more information, please visit the URL, " + refBase + "#" + statusCode;
+    }
+}

openmessaging-api/src/main/java/io/openmessaging/OMSResponseStatus.java

@@ -17,9 +17,9 @@
 
 package io.openmessaging.internal;
 
-import io.openmessaging.Error;
+import io.openmessaging.OMSResponseStatus;
 
-import static io.openmessaging.Error.generateException;
+import static io.openmessaging.OMSResponseStatus.generateException;
 
 /**
  * Represents a <a href="https://github.com/openmessaging/specification/blob/master/oms_access_point_schema.md">AccessPoint String</a>.
@@ -95,7 +95,7 @@ public String getRegion() {
 
     private void validateAccessPointString(String accessPointString) {
         if (!accessPointString.matches(PATTERN)) {
-            throw generateException(Error.ERROR_10001, accessPointString);
+            throw generateException(OMSResponseStatus.STATUS_10001, accessPointString);
         }
     }
 }

openmessaging-api/src/main/java/io/openmessaging/internal/AccessPointURI.java

@@ -21,11 +21,11 @@
 import io.openmessaging.MessagingAccessPoint;
 import io.openmessaging.OMS;
 import io.openmessaging.OMSBuiltinKeys;
-import io.openmessaging.Error;
+import io.openmessaging.OMSResponseStatus;
 import io.openmessaging.exception.OMSRuntimeException;
 import java.lang.reflect.Constructor;
 
-import static io.openmessaging.Error.generateException;
+import static io.openmessaging.OMSResponseStatus.generateException;
 
 /**
  * The {@code MessagingAccessPointAdapter} provides a common implementation to create a specified {@code
@@ -59,7 +59,7 @@ public static MessagingAccessPoint getMessagingAccessPoint(String url, KeyValue
             checkSpecVersion(OMS.specVersion, vendorImpl.version());
             return vendorImpl;
         } catch (Throwable e) {
-            throw generateException(Error.ERROR_10000, url);
+            throw generateException(OMSResponseStatus.STATUS_10000, url);
         }
     }
 
@@ -76,10 +76,10 @@ private static void checkSpecVersion(final String specVersion, final String impl
         try {
             majorVerOfImpl = implVersion.substring(0, implVersion.indexOf('.', implVersion.indexOf('.') + 1));
         } catch (Throwable e) {
-            throw generateException(Error.ERROR_10002, implVersion);
+            throw generateException(OMSResponseStatus.STATUS_10002, implVersion);
         }
         if (!majorVerOfSpec.equals(majorVerOfImpl)) {
-            throw generateException(Error.ERROR_10003, implVersion, specVersion);
+            throw generateException(OMSResponseStatus.STATUS_10003, implVersion, specVersion);
         }
     }
 }