Polish exception and errorcode implementation

Author: duhengforever

openmessaging-api-samples/src/main/java/io/openmessaging/samples/consumer/PullConsumerApp.java

@@ -1,10 +1,9 @@
 package io.openmessaging.samples.consumer;
 
+import io.openmessaging.Message;
 import io.openmessaging.MessagingAccessPoint;
 import io.openmessaging.OMS;
-import io.openmessaging.common.Result;
 import io.openmessaging.consumer.Consumer;
-import io.openmessaging.consumer.ReceiveResult;
 import io.openmessaging.manager.ResourceManager;
 
 public class PullConsumerApp {
@@ -15,33 +14,23 @@ public static void main(String[] args) {
 
         //Fetch a ResourceManager to create Queue resource.
         ResourceManager resourceManager = messagingAccessPoint.resourceManager();
-        Result createQueueResult = resourceManager.createQueue("NS://HELLO_QUEUE");
-        if (createQueueResult.isSuccess()) {
-            //Start a PullConsumer to receive messages from the specific queue.
-            final Consumer consumer = messagingAccessPoint.createConsumer();
-            consumer.startup();
+        resourceManager.createQueue("NS://HELLO_QUEUE");
 
-            //Register a shutdown hook to close the opened endpoints.
-            Runtime.getRuntime().addShutdownHook(new Thread(new Runnable() {
-                @Override
-                public void run() {
-                    consumer.shutdown();
-                }
-            }));
+        //Start a PullConsumer to receive messages from the specific queue.
+        final Consumer consumer = messagingAccessPoint.createConsumer();
+        consumer.start();
 
-            Result bindQueueResult = consumer.bindQueue("NS://HELLO_QUEUE");
-            if (bindQueueResult.isSuccess()) {
-                ReceiveResult receiveResult = consumer.receive(1000);
-                if (receiveResult.isSuccess()) {
-                    System.out.println("Received message: " + receiveResult.message());
-                    //Acknowledge the consumed message
-                    consumer.ack(receiveResult.message().headers().getMessageId());
-                }
-            } else {
-                System.out.println("Error: " + bindQueueResult.getError().getErrorCode() + " error message: " + bindQueueResult.getError().getErrorMessage());
+        //Register a shutdown hook to close the opened endpoints.
+        Runtime.getRuntime().addShutdownHook(new Thread(new Runnable() {
+            @Override
+            public void run() {
+                consumer.stop();
             }
-        } else {
-            System.out.println("Error: " + createQueueResult.getError().getErrorCode() + " error message: " + createQueueResult.getError().getErrorMessage());
-        }
+        }));
+        consumer.bindQueue("NS://HELLO_QUEUE");
+        Message message = consumer.receive(1000);
+        System.out.println("Received message: " + message);
+        //Acknowledge the consumed message
+        consumer.ack(message.headers().getMessageId());
     }
 }

openmessaging-api-samples/src/main/java/io/openmessaging/samples/consumer/PushConsumerApp.java

@@ -20,7 +20,6 @@
 import io.openmessaging.Message;
 import io.openmessaging.MessagingAccessPoint;
 import io.openmessaging.OMS;
-import io.openmessaging.common.Result;
 import io.openmessaging.consumer.Consumer;
 import io.openmessaging.consumer.MessageListener;
 import io.openmessaging.manager.ResourceManager;
@@ -35,36 +34,32 @@ public static void main(String[] args) {
         ResourceManager resourceManager = messagingAccessPoint.resourceManager();
         resourceManager.createNamespace("NS://XXXX");
         final Consumer consumer = messagingAccessPoint.createConsumer();
-        consumer.startup();
+        consumer.start();
 
         //Register a shutdown hook to close the opened endpoints.
         Runtime.getRuntime().addShutdownHook(new Thread(new Runnable() {
             @Override
             public void run() {
-                consumer.shutdown();
+                consumer.stop();
             }
         }));
 
         //Consume messages from a simple queue.
         String simpleQueue = "NS://HELLO_QUEUE";
-        Result result = resourceManager.createQueue(simpleQueue);
+        resourceManager.createQueue(simpleQueue);
         //This queue doesn't has a source queue, so only the message delivered to the queue directly can
         //be consumed by this consumer.
-        if (result.isSuccess()){
-            consumer.bindQueue(simpleQueue, new MessageListener() {
-                @Override
-                public void onReceived(Message message, Context context) {
-                    System.out.println("Received one message: " + message);
-                    context.ack();
-                }
+        consumer.bindQueue(simpleQueue, new MessageListener() {
+            @Override
+            public void onReceived(Message message, Context context) {
+                System.out.println("Received one message: " + message);
+                context.ack();
+            }
 
-            });
-        }else {
-            System.out.println("error: " + result.getError().getErrorCode() + " error message: " + result );
-        }
+        });
 
         consumer.unbindQueue(simpleQueue);
 
-        consumer.shutdown();
+        consumer.stop();
     }
 }

openmessaging-api-samples/src/main/java/io/openmessaging/samples/producer/ProducerApp.java

@@ -35,7 +35,7 @@ public static void main(String[] args) {
             OMS.getMessagingAccessPoint("oms:rocketmq://alice@rocketmq.apache.org/us-east");
 
         final Producer producer = messagingAccessPoint.createProducer();
-        producer.startup();
+        producer.start();
         ProducerInterceptor interceptor = new ProducerInterceptor() {
             @Override
             public void preSend(Message message, Context attributes) {
@@ -51,27 +51,21 @@ public void postSend(Message message, Context attributes) {
         Runtime.getRuntime().addShutdownHook(new Thread(new Runnable() {
             @Override
             public void run() {
-                producer.shutdown();
+                producer.stop();
             }
         }));
 
         //Sends a message to the specified destination synchronously.
         Message message = producer.createMessage(
             "NS://HELLO_QUEUE", "HELLO_BODY".getBytes(Charset.forName("UTF-8")));
         SendResult sendResult = producer.send(message);
-
-        if (sendResult.isSuccess()) {
-            System.out.println("Send sync message OK, message id is: " + sendResult.messageId());
-        } else {
-            System.out.println("Error: " + sendResult.getError().getErrorCode() + " error message: " + sendResult.getError().getErrorMessage());
-        }
+        System.out.println("SendResult: " + sendResult);
 
         //Sends a message to the specified destination async.
         Future<SendResult> sendResultFuture = producer.sendAsync(message);
         sendResult = sendResultFuture.get(1000);
-        if (sendResult.isSuccess()) {
-            System.out.println("Send message async: " + sendResult);
-        }
+        System.out.println("SendResult: " + sendResult);
+
         //Sends a message to the specified destination in one way mode.
         producer.sendOneway(message);
 
@@ -83,6 +77,6 @@ public void run() {
         }
         producer.send(messages);
         producer.removeInterceptor(interceptor);
-        producer.shutdown();
+        producer.stop();
     }
 }

openmessaging-api-samples/src/main/java/io/openmessaging/samples/producer/TransactionProducerApp.java

@@ -35,13 +35,13 @@ public static void main(String[] args) {
 
             }
         });
-        producer.startup();
+        producer.start();
 
         //Register a shutdown hook to close the opened endpoints.
         Runtime.getRuntime().addShutdownHook(new Thread(new Runnable() {
             @Override
             public void run() {
-                producer.shutdown();
+                producer.stop();
             }
         }));
 
@@ -52,7 +52,7 @@ public void run() {
         TransactionalResult result = producer.prepare(message);
         executeLocalTransaction(result);
         result.commit();
-        producer.shutdown();
+        producer.stop();
         System.out.println("Send transaction message OK, message id is: " + result.messageId());
     }
 

openmessaging-api-samples/src/main/java/io/openmessaging/samples/routing/RoutingApp.java

@@ -26,7 +26,7 @@
 import io.openmessaging.producer.Producer;
 
 public class RoutingApp {
-    public static void main(String[] args)  {
+    public static void main(String[] args) {
         //Load and start the vendor implementation from a specific OMS driver URL.
         final MessagingAccessPoint messagingAccessPoint =
             OMS.getMessagingAccessPoint("oms:rocketmq://alice@rocketmq.apache.org/us-east");
@@ -42,11 +42,11 @@ public static void main(String[] args)  {
         resourceManager.createQueue(sourceQueue);
 
         resourceManager.routing(sourceQueue, destinationQueue);
-        resourceManager.filter(destinationQueue,"name = 'kaka'");
+        resourceManager.filter(destinationQueue, "name = 'kaka'");
 
         //Send messages to the source queue ahead of the routing
         final Producer producer = messagingAccessPoint.createProducer();
-        producer.startup();
+        producer.start();
 
         Message message = producer.createMessage(sourceQueue, "RED_COLOR".getBytes());
         message.properties().put("color", "green").put("shape", "round");
@@ -55,7 +55,7 @@ public static void main(String[] args)  {
 
         //Consume messages from the queue behind the routing.
         final Consumer consumer = messagingAccessPoint.createConsumer();
-        consumer.startup();
+        consumer.start();
 
         consumer.bindQueue(destinationQueue, new MessageListener() {
             @Override
@@ -72,9 +72,10 @@ public void onReceived(Message message, Context context) {
         Runtime.getRuntime().addShutdownHook(new Thread(new Runnable() {
             @Override
             public void run() {
-                producer.shutdown();
-                consumer.shutdown();
+                producer.stop();
+                consumer.stop();
             }
         }));
+
     }
 }

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

@@ -0,0 +1,127 @@
+package io.openmessaging;
+
+import io.openmessaging.exception.OMSRuntimeException;
+
+/**
+ * This class defined error code existed in OpenMessaging:
+ * <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>
+ */
+public enum Error {
+    ERROR_1101(1101, "Unsupported Version"),
+
+    ERROR_1200(1200, "Success"),
+
+    ERROR_1400(1400, "Bad Request"),
+
+    ERROR_1401(1401, "Unauthorized"),
+
+    ERROR_1402(1402, "Message body Required"),
+
+    ERROR_1403(1403, "Forbidden"),
+
+    ERROR_1404(1404, "Destination Not Found"),
+
+    ERROR_1405(1405, "Namespace Not Fount"),
+
+    ERROR_1406(1406, "Destination Already Exists"),
+
+    ERROR_1407(1407, "Namespace Already Exists"),
+
+    ERROR_1408(1408, "ConsumerId Already Exists"),
+
+    ERROR_1409(1409, "ProducerId Already Exists"),
+
+    ERROR_1410(1410, "Request Timeout"),
+
+    ERROR_1411(1411, "Message Attributes Too Large"),
+
+    ERROR_1412(1412, "Message Header Too Large"),
+
+    ERROR_1413(1413, "Message Body Too Large"),
+
+    ERROR_1414(1414, "No New Message Found"),
+
+    ERROR_1415(1415, "Max Topics Reached"),
+
+    ERROR_1416(1416, "Max Queues Reached"),
+
+    ERROR_1417(1417, "Max Namespaces Reached"),
+
+    ERROR_1418(1418, "Bad Parameter"),
+
+    ERROR_1500(1500, "Server ERROR"),
+
+    ERROR_1501(1501, "Storage Service ERROR"),
+
+    ERROR_1502(1502, "Storage Service Busy"),
+
+    ERROR_1503(1503, "Service Not Available"),
+
+    ERROR_1504(1504, "Flush Disk Timeout"),
+
+    ERROR_10000(10000, "Can't construct a MessagingAccessPoint instance from the given OMS driver URL [%s]."),
+
+    ERROR_10001(10001, "The OMS driver URL [%s] is illegal."),
+
+    ERROR_10002(10002, "The implementation version [%s] is illegal."),
+
+    ERROR_10003(10003, "The implementation version [%s] isn't compatible with the specification version [%s].");
+
+    private int errorCode;
+
+    private String errorMessage;
+
+    private String detailErrorMessage;
+
+    private static final String refBase = "http://openmessaging.cloud/internal/code";
+
+    Error(int errorCode, String errorMessage) {
+        this.errorCode = errorCode;
+
+        this.errorMessage = errorMessage;
+
+        this.detailErrorMessage = generateDetailErrorMessage(errorCode, errorMessage);
+    }
+
+    public int getErrorCode() {
+        return errorCode;
+    }
+
+    public String getErrorMessage() {
+        return errorMessage;
+    }
+
+    public String getDetailErrorMessage() {
+        return detailErrorMessage;
+    }
+
+    public static OMSRuntimeException generateException(Error error, String... messageArgs) {
+        return new OMSRuntimeException(error.getErrorCode(), String.format(error.getDetailErrorMessage(), (Object[]) messageArgs));
+    }
+
+    public static OMSRuntimeException generateException(Error error) {
+        return new OMSRuntimeException(error.getErrorCode(), error.getDetailErrorMessage());
+    }
+
+    public static OMSRuntimeException generateException(int errorCode, String errorMessage) {
+        return new OMSRuntimeException(errorCode, errorMessage);
+    }
+
+    public static String generateDetailErrorMessage(int errorCode, String errorMessage) {
+        return errorMessage + "\nFor more information, please visit the URL, " + refBase + "#" + errorCode;
+    }
+}

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

@@ -22,19 +22,20 @@
 /**
  * A factory interface for creating {@code Message} objects.
  *
+ * @version OMS 1.0.0
+ * @since OMS 1.0.0
  */
 public interface MessageFactory {
     /**
-     * Creates a {@code Message} object. A {@code Message} object is used to send a message containing a
-     * stream of uninterpreted bytes.
+     * Creates a {@code Message} object. A {@code Message} object is used to send a message containing a stream of
+     * uninterpreted bytes.
      * <p>
      * The returned {@code Message} object only can be sent to the specified queue.
      *
      * @param queueName the target queue to send
      * @param body the body data for a message
      * @return the created {@code Message} object
      * @throws OMSMessageFormatException when body exceed the maximum length or others.
-     *
      */
     Message createMessage(String queueName, byte[] body);
 }