server/ServerAnswer.java

   1 package org.argeo.server;
   2
   3 import java.io.PrintWriter;
   4 import java.io.StringWriter;
   5
   6 import org.apache.commons.io.IOUtils;
   7 import org.argeo.ArgeoException;
   8
   9 /** Answer to an execution of a remote service which performed changes. */
  10 public class ServerAnswer {
  11         public final static String OK = "OK";
  12         public final static String ERROR = "ERROR";
  13
  14         private String status = OK;
  15         private String message = "";
  16
  17         // TODO: add an exception field
  18
  19         /** Canonical constructor */
  20         public ServerAnswer(String status, String message) {
  21                 setStatus(status);
  22                 if (message == null)
  23                         throw new ArgeoException("Message cannot be null");
  24                 this.message = message;
  25         }
  26
  27         /** Empty constructor */
  28         public ServerAnswer() {
  29         }
  30
  31         public String getStatus() {
  32                 return status;
  33         }
  34
  35         public void setStatus(String status) {
  36                 if (status == null || (!status.equals(OK) && !status.equals(ERROR)))
  37                         throw new ArgeoException("Bad status format: " + status);
  38                 this.status = status;
  39         }
  40
  41         public String getMessage() {
  42                 return message;
  43         }
  44
  45         public void setMessage(String message) {
  46                 this.message = message;
  47         }
  48
  49         public Boolean isOk() {
  50                 return status.equals(OK);
  51         }
  52
  53         public Boolean isError() {
  54                 return status.equals(ERROR);
  55         }
  56
  57         public static ServerAnswer error(String message) {
  58                 return new ServerAnswer(ERROR, message);
  59         }
  60
  61         public static ServerAnswer error(Throwable e) {
  62                 StringWriter writer = new StringWriter();
  63                 try {
  64                         e.printStackTrace(new PrintWriter(writer));
  65                         return new ServerAnswer(ERROR, writer.toString());
  66                 } finally {
  67                         IOUtils.closeQuietly(writer);
  68                 }
  69         }
  70
  71         public static ServerAnswer ok(String message) {
  72                 return new ServerAnswer(OK, message);
  73         }
  74
  75         @Override
  76         public String toString() {
  77                 return "ServerAnswer{status:" + status + ", message:" + message + "}";
  78         }
  79
  80 }