errorcode.java

java开源的企业总线.xmlBlaster

      );

   public static final ErrorCode COMMUNICATION_NOCONNECTION_SERVERDENY = new ErrorCode("communication.noConnection.serverDeny",
         "Thrown by the server if no connection is accepted, usually on startup when the server is not ready for it (standby mode).",
         new ResourceInfo[] {
            new ResourceInfo(ResourceInfo.REQ, "run level requirement", "engine.runlevel")
         }
      );

   public static final ErrorCode COMMUNICATION_NOCONNECTION_CALLBACKSERVER_NOTAVAILABLE = new ErrorCode("communication.noConnection.callbackServer.notavailable",
         "The callback server is not available, this usually happens when the callback server is shutdown on client side",
         new ResourceInfo[] {
            new ResourceInfo(ResourceInfo.REQ, "interface.update", "interface.update")
         }
      );

   public static final ErrorCode COMMUNICATION_NOCONNECTION_POLLING = new ErrorCode("communication.noConnection.polling",
         "The remote connection is not established and we are currently polling for it.",
         new ResourceInfo[] {
            new ResourceInfo(ResourceInfo.REQ, "interface.connect", "interface.connect"),
            new ResourceInfo(ResourceInfo.API, "client queue configuration", "org.xmlBlaster.util.qos.address.Address"),
            new ResourceInfo(ResourceInfo.API, "callback queue configuration", "org.xmlBlaster.util.qos.address.CallbackAddress")
         }
      );

   public static final ErrorCode COMMUNICATION_NOCONNECTION_DEAD = new ErrorCode("communication.noConnection.dead",
         "The remote connection is not established and we have given up to poll for it.",
         new ResourceInfo[] {
            new ResourceInfo(ResourceInfo.REQ, "interface.connect", "interface.connect"),
            new ResourceInfo(ResourceInfo.REQ, "client.configuration", "client.configuration"),
            new ResourceInfo(ResourceInfo.REQ, "client.failsafe", "client.failsafe"),
            new ResourceInfo(ResourceInfo.API, "client queue configuration", "org.xmlBlaster.util.qos.address.Address"),
            new ResourceInfo(ResourceInfo.API, "callback queue configuration", "org.xmlBlaster.util.qos.address.CallbackAddress")
         }
      );

   // The dispatch framework reacts specific for communication exceptions
   public static final ErrorCode COMMUNICATION_USER_HOLDBACK = new ErrorCode("communication.user.holdback",
         "See USER_UPDATE_HOLDBACK.",
         new ResourceInfo[] {
         }
      );

   public static final ErrorCode USER = new ErrorCode("user",
         "This category stands for wrong usage by the programmer using xmlBlaster.",
         new ResourceInfo[] {
         }
      );

   // TODO: Replace by finer adjusting possibilities (like retry timeouts etc.)
   public static final ErrorCode USER_UPDATE_HOLDBACK = new ErrorCode("user.update.holdback",
         "You can throw this on client side in your update() method: Like this the server queues the message and sets the dispatcActive to false. You need to manually activate the dispatcher again.",
         new ResourceInfo[] {
         }
      );

   public static final ErrorCode USER_WRONG_API_USAGE = new ErrorCode("user.wrongApiUsage",
         "Please check your client code.",
         new ResourceInfo[] {
         }
      );

   public static final ErrorCode USER_CONFIGURATION = new ErrorCode("user.configuration",
         "Login to xmlBlaster failed due to configuration problems.",
         new ResourceInfo[] {
            new ResourceInfo(ResourceInfo.REQ, "client.configuration", "client.configuration"),
            new ResourceInfo(ResourceInfo.REQ, "client.failsafe", "client.failsafe"),
            new ResourceInfo(ResourceInfo.REQ, "interface.connect", "interface.connect")
         }
      );

   public static final ErrorCode USER_CONFIGURATION_MAXSESSION = new ErrorCode("user.configuration.maxSession",
         "Login to xmlBlaster failed due to maximum sessions of a subject reached.",
         new ResourceInfo[] {
            new ResourceInfo(ResourceInfo.REQ, "client.failsafe", "client.failsafe"),
            new ResourceInfo(ResourceInfo.REQ, "interface.connect", "interface.connect")
         }
      );

   public static final ErrorCode USER_CONFIGURATION_IDENTICALCLIENT = new ErrorCode("user.configuration.identicalClient",
         "Login to xmlBlaster failed, reconnect for other client instance on existing public session is switched off, see connect QoS reconnectSameClientOnly=true setting.",
         new ResourceInfo[] {
            new ResourceInfo(ResourceInfo.REQ, "client.failsafe", "client.failsafe"),
            new ResourceInfo(ResourceInfo.REQ, "interface.connect", "interface.connect")
         }
      );

   public static final ErrorCode USER_SECURITY_AUTHENTICATION = new ErrorCode("user.security.authentication",
	         "Login to xmlBlaster failed due to some reason.",
	         new ResourceInfo[] {
	            new ResourceInfo(ResourceInfo.REQ, "interface.connect", "interface.connect")
	         }
	      );

   public static final ErrorCode USER_SECURITY_AUTHENTICATION_ACCESSDENIED = new ErrorCode("user.security.authentication.accessDenied",
         "Login to xmlBlaster failed due to missing privileges.",
         new ResourceInfo[] {
            new ResourceInfo(ResourceInfo.REQ, "interface.connect", "interface.connect")
         }
      );

   public static final ErrorCode USER_SECURITY_AUTHENTICATION_ILLEGALARGUMENT = new ErrorCode("user.security.authentication.illegalArgument",
         "Login to xmlBlaster failed due to illegal arguments.",
         new ResourceInfo[] {
            new ResourceInfo(ResourceInfo.REQ, "interface.connect", "interface.connect")
         }
      );

   public static final ErrorCode USER_SECURITY_AUTHORIZATION_NOTAUTHORIZED = new ErrorCode("user.security.authorization.notAuthorized",
         "Login to xmlBlaster failed due to missing privileges.",
         new ResourceInfo[] {
            new ResourceInfo(ResourceInfo.REQ, "interface.connect", "interface.connect")
         }
      );

   public static final ErrorCode USER_UPDATE_ERROR = new ErrorCode("user.update.error",
         "Exception thrown by client on callback update invocation.",
         new ResourceInfo[] {
            new ResourceInfo(ResourceInfo.REQ, "interface.update", "interface.update")
         }
      );

   public static final ErrorCode USER_UPDATE_INTERNALERROR = new ErrorCode("user.update.internalError",
         "Unexpected exception thrown by client code on programming error.",
         new ResourceInfo[] {
            new ResourceInfo(ResourceInfo.REQ, "interface.update", "interface.update")
         }
      );

   public static final ErrorCode USER_UPDATE_ILLEGALARGUMENT = new ErrorCode("user.update.illegalArgument",
         "The update method was invoked without useful data.",
         new ResourceInfo[] {
            new ResourceInfo(ResourceInfo.REQ, "interface.update", "interface.update")
         }
      );

   public static final ErrorCode USER_ILLEGALARGUMENT = new ErrorCode("user.illegalArgument",
         "You have invoked a server method with illegal arguments.",
         new ResourceInfo[] {
         }
      );

   public static final ErrorCode USER_UPDATE_SECURITY_AUTHENTICATION_ACCESSDENIED = new ErrorCode("user.update.security.authentication.accessDenied",
         "The update method was invoked with an invalid callback session ID.",
         new ResourceInfo[] {
            new ResourceInfo(ResourceInfo.REQ, "interface.update", "interface.update")
         }
      );

   public static final ErrorCode USER_PUBLISH_READONLY = new ErrorCode("user.publish.readonly",
         "You published a message which is marked as readonly.",
         new ResourceInfo[] {
            new ResourceInfo(ResourceInfo.REQ, "engine.qos.publish.readonly", "engine.qos.publish.readonly"),
         }
      );

   public static final ErrorCode USER_SUBSCRIBE_ID = new ErrorCode("user.subscribe.id",
         "Your subscription tries to pass an illegal subscriptionId.",
         new ResourceInfo[] {
            new ResourceInfo(ResourceInfo.REQ, "interface.subscribe", "interface.subscribe"),
            new ResourceInfo(ResourceInfo.REQ, "engine.qos.subscribe.id", "engine.qos.subscribe.id")
         }
      );

   public static final ErrorCode USER_SUBSCRIBE_NOCALLBACK = new ErrorCode("user.subscribe.noCallback",
         "You try to subscribe to a topic but have no callback registered on connect.",
         new ResourceInfo[] {
            new ResourceInfo(ResourceInfo.REQ, "interface.connect", "interface.connect"),
         }
      );

   public static final ErrorCode USER_OID_UNKNOWN = new ErrorCode("user.oid.unknown",
         "You passed a message oid which is not known.",
         new ResourceInfo[] {
         }
      );

   public static final ErrorCode USER_JDBC_INVALID = new ErrorCode("user.jdbc.invalid",
         "You have invoked get() with an illegal JDBC query.",
         new ResourceInfo[] {
            new ResourceInfo(ResourceInfo.REQ, "engine.service.rdbms", "engine.service.rdbms"),
            new ResourceInfo(ResourceInfo.REQ, "interface.get", "interface.get")
         }
      );

   public static final ErrorCode USER_CONNECT = new ErrorCode("user.connect",
         "Your connection request could not be handled, check your QoS",
         new ResourceInfo[] {
            new ResourceInfo(ResourceInfo.REQ, "interface.connect", "interface.connect")
         }
      );

   public static final ErrorCode USER_CONNECT_MULTIPLE = new ErrorCode("user.connect.multiple",
         "You have invoked connect() multiple times",
         new ResourceInfo[] {
            new ResourceInfo(ResourceInfo.REQ, "interface.connect", "interface.connect")
         }
      );

   public static final ErrorCode USER_NOT_CONNECTED = new ErrorCode("user.notConnected",
         "Your operation is not possible, please login with connect() first",
         new ResourceInfo[] {
            new ResourceInfo(ResourceInfo.REQ, "interface.connect", "interface.connect")
         }
      );

   public static final ErrorCode USER_PUBLISH = new ErrorCode("user.publish",
         "Your published message could not be handled, check your QoS",
         new ResourceInfo[] {
            new ResourceInfo(ResourceInfo.REQ, "interface.publish", "interface.publish")
         }
      );

   public static final ErrorCode USER_PTP_UNKNOWNSESSION = new ErrorCode("user.ptp.unknownSession",
         "You have send a point to point message to a specific user session but the receiver is not known.",
         new ResourceInfo[] {
            new ResourceInfo(ResourceInfo.REQ, "interface.publish", "interface.publish")
         }
      );

   public static final ErrorCode USER_PTP_UNKNOWNDESTINATION = new ErrorCode("user.ptp.unknownDestination",
         "You have send a point to point message but the receiver is not known and <destination forceQueuing='true'> is not set.",
         new ResourceInfo[] {
            new ResourceInfo(ResourceInfo.REQ, "interface.publish", "interface.publish")
         }
      );

   public static final ErrorCode USER_PTP_UNKNOWNDESTINATION_SESSION = new ErrorCode("user.ptp.unknownDestinationSession",
         "You have send a point to point message but the receiver session is not known.",
         new ResourceInfo[] {
            new ResourceInfo(ResourceInfo.REQ, "interface.publish", "interface.publish")
         }
      );

   public static final ErrorCode USER_PTP_DENIED = new ErrorCode("user.ptp.denied",
           "You have send a point to point message but the receiver session does not accept PtP.",
           new ResourceInfo[] {
               new ResourceInfo(ResourceInfo.REQ, "interface.connect",
                   "interface.connect")
         }
      );

   public static final ErrorCode USER_MESSAGE_INVALID = new ErrorCode("user.message.invalid",
         "Usually thrown by a mime plugin if your MIME type does not fit to your message content, e.g. mime='text/xml' and content='Nice weather'.",
         new ResourceInfo[] {
            new ResourceInfo(ResourceInfo.REQ, "mime.plugin.accessfilter", "mime.plugin.accessfilter")
         }
      );

   public static final ErrorCode USER_QUERY_INVALID = new ErrorCode("user.query.invalid",
         "You have invoked get(), subscribe(), unSubscribe() or erase() with an illegal query syntax.",
         new ResourceInfo[] {
            new ResourceInfo(ResourceInfo.REQ, "interface.get", "interface.get"),
            new ResourceInfo(ResourceInfo.REQ, "interface.subscribe", "interface.subscribe"),
            new ResourceInfo(ResourceInfo.REQ, "interface.unSubscribe", "interface.unSubscribe"),
            new ResourceInfo(ResourceInfo.REQ, "interface.erase", "interface.erase"),
            new ResourceInfo(ResourceInfo.API, "query syntax", "org.xmlBlaster.util.key.QueryKeyData")
         }
      );

   public static final ErrorCode USER_ADMIN_INVALID = new ErrorCode("user.admin.invalid",
         "Your administrative request was illegal.",
         new ResourceInfo[] {
            new ResourceInfo(ResourceInfo.REQ, "admin.messages", "admin.messages")
         }
      );

   public static final ErrorCode USER_QUERY_TYPE_INVALID = new ErrorCode("user.query.type.invalid",
         "You have invoked get(), subscribe(), unSubscribe() or erase() with an illegal query type, try EXACT or XPATH.",
         new ResourceInfo[] {
            new ResourceInfo(ResourceInfo.REQ, "interface.get", "interface.get"),
            new ResourceInfo(ResourceInfo.REQ, "interface.subscribe", "interface.subscribe"),
            new ResourceInfo(ResourceInfo.REQ, "interface.unSubscribe", "interface.unSubscribe"),
            new ResourceInfo(ResourceInfo.REQ, "interface.erase", "interface.erase"),
            new ResourceInfo(ResourceInfo.API, "query syntax", "org.xmlBlaster.util.key.QueryKeyData")
         }
      );

   public static final ErrorCode USER_CLIENTCODE = new ErrorCode("user.clientCode",
         "You may use this error code in your client implementation to throw your own exceptions.",
         new ResourceInfo[] {
         }
      );


   /**
    * @exception IllegalArgumentException if the given errorCode is null
    */
   private ErrorCode(String errorCode, String description, ResourceInfo[] resourceInfos) {
      if (errorCode == null)
         throw new IllegalArgumentException("Your given errorCode is null");
      this.errorCode = errorCode;
      this.description = (description == null) ? "" : description;
      this.resourceInfos = (resourceInfos == null) ? new ResourceInfo[0] : resourceInfos;
      errorCodeMap.put(errorCode, this);
   }

   /**
    * Return a human readable string of the errorCode and description
    * @return never null
    */
   public String toString() {
      return "errorCode=" + this.errorCode + ": " + this.description;
   }

   /**
    * Returns 'true' if this error code is a 'child' of the error code
    * specified in baseCode. It follows the name convention of the error
    * code. For example USER_SECURITY_AUTHENTICATION_DENIED
    * would be of type (as it is a subtype) of USER_SECURITY_AUTHENTICATION
    * If one of the error codes code name is null, false is returned.
    * @param baseCode the base ErrorCode to check against. If null, false is
    * returned. 
    * @return
    */
   public final boolean isOfType(ErrorCode baseCode) {
	   if (baseCode == null)
		   return false;
	   String baseCodeTxt = baseCode.getErrorCode();
	   if (this.errorCode == null || baseCodeTxt == null)
		   return false;
	   return this.errorCode.startsWith(baseCodeTxt);
   }
   /**
    * Returns the errorCode string. 
    * @return never null
    */
   public String getErrorCode() {
      return this.errorCode;
   }

   /**
    * Returns the description of the errorCode. 
    * @return never null
    */
   public String getDescription() {
      return this.description;
   }

   /**
    * Returns the description of the errorCode including the online link with further explanations. 
    * @return never null
    */
   public String getLongDescription() {
      return this.description + " -> " + getUrl();