Class ApiException

    • Constructor Summary

      Constructors 
      Constructor Description
      ApiException​(java.lang.String msgId)  
      ApiException​(java.lang.String msgId, java.lang.Object[] msgParams)  
      ApiException​(java.lang.String msgId, java.lang.Throwable cause)  
      ApiException​(java.lang.String msgId, java.lang.Throwable cause, java.util.Map<java.lang.String,​java.lang.Object> additionalState)  
      ApiException​(java.lang.String msgId, java.util.Map<java.lang.String,​java.lang.Object> additionalState)  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.Map<java.lang.String,​java.lang.Object> getAdditionalState()
      A free-form object that contains any additional state that the developer thinks might be relevant for troubleshooting.
      java.lang.String getMsgId()
      Returns the message id key.
      • Methods inherited from class org.springframework.extensions.surf.exception.PlatformRuntimeException

        create, create, makeRuntimeException
      • Methods inherited from class java.lang.Throwable

        addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • ApiException

        public ApiException​(java.lang.String msgId)
      • ApiException

        public ApiException​(java.lang.String msgId,
                            java.lang.Object[] msgParams)
      • ApiException

        public ApiException​(java.lang.String msgId,
                            java.lang.Throwable cause)
      • ApiException

        public ApiException​(java.lang.String msgId,
                            java.lang.Throwable cause,
                            java.util.Map<java.lang.String,​java.lang.Object> additionalState)
      • ApiException

        public ApiException​(java.lang.String msgId,
                            java.util.Map<java.lang.String,​java.lang.Object> additionalState)
    • Method Detail

      • getAdditionalState

        public java.util.Map<java.lang.String,​java.lang.Object> getAdditionalState()
        A free-form object that contains any additional state that the developer thinks might be relevant for troubleshooting. This object will be rendered as JSON.
      • getMsgId

        public java.lang.String getMsgId()
        Returns the message id key.
        Returns:
        String messageId