Package com.morpheusdata.response

Class ServiceResponse<T>

  • Type Parameters:
    T - The class that holds the data - must be serializable. Usually a Map or List.
    public class ServiceResponse<T>
extends java.lang.Object
    ServiceResponse is a generic that allows you to strongly type models. Some scenarios are: Respond with text/html of content. Respond with data that will be serialized as json. Respond with data that will be used in a template model. Response headers and cookies can also be set if required.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      java.lang.Boolean inProgress  

    • Constructor Summary

      Constructors 
      Constructor Description
      ServiceResponse()  
      ServiceResponse​(java.lang.Boolean success, java.lang.String msg, java.util.Map<java.lang.String,​java.lang.String> errors, T data)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addCookie​(java.lang.String key, java.lang.Object value)
      Add a Cookie to the response
      void addError​(java.lang.String value)  
      void addError​(java.lang.String key, java.lang.String value)  
      void addHeader​(java.lang.String key, java.lang.Object value)  
      void clearErrors()  
      static ServiceResponse create​(ServiceResponse source)
      Helper to create service response from an existing service response.
      static ServiceResponse create​(java.util.Map<java.lang.String,​java.lang.Object> config)
      Helper to build an error response from a generic map.
      static ServiceResponse error()
      Helper to return a generic error response.
      static ServiceResponse error​(java.lang.String msg)
      Helper to return a error message
      static ServiceResponse error​(java.lang.String msg, java.util.Map<java.lang.String,​java.lang.String> errors)
      Detailed error message with a list of errors.
      static ServiceResponse error​(java.lang.String msg, java.util.Map<java.lang.String,​java.lang.String> errors, java.lang.Object data)
      Detailed error message with a list of errors.
      java.lang.String getContent()  
      java.lang.String getCookie​(java.lang.String key)
      Find a cookie
      java.util.Map getCookies()  
      T getData()  
      java.lang.String getError()
      Provided for backwards compatibility with existing getError()
      java.lang.String getError​(java.lang.String key)
      Returns the specific error message for a given key.
      java.lang.String getErrorCode()  
      java.util.Map<java.lang.String,​java.lang.String> getErrors()  
      java.util.Map<java.lang.String,​java.lang.Object> getHeaders()  
      java.lang.String getMsg()  
      java.lang.Object getResults()  
      java.lang.Boolean getSuccess()  
      boolean hasError​(java.lang.String key)
      Return if the ServiceResponse has any errors set
      boolean hasErrors()
      Return if the ServiceResponse has any errors set
      static ServiceResponse prepare()
      Helper to initialize a base response.
      static ServiceResponse prepare​(java.lang.Object data)
      Helper to initialize a base response with initial data.
      void removeError()  
      void removeError​(java.lang.String key)  
      void setContent​(java.lang.String content)  
      void setCookies​(java.util.Map cookies)  
      void setData​(T data)  
      void setError​(java.lang.String value)
      Provided for backwards compatibility with existing setError(msg)
      void setErrorCode​(java.lang.String errorCode)  
      void setErrors​(java.util.Map<java.lang.String,​java.lang.String> errors)  
      void setHeaders​(java.util.Map<java.lang.String,​java.lang.Object> headers)  
      void setMsg​(java.lang.String msg)  
      void setResults​(java.lang.Object results)  
      void setSuccess​(java.lang.Boolean success)  
      static ServiceResponse success()
      Create a generic success response
      static ServiceResponse success​(java.lang.Object data)
      Helper to return a success message.
      java.util.Map<java.lang.String,​java.lang.Object> toMap()
      Build a Map from this object with keys success, msg, errors, data
      java.util.Map<java.lang.String,​java.lang.Object> toMap​(java.lang.String dataKeyName)
      Serializes the ServiceResponse to a map.
      java.lang.String toString()
      String representation of the toMap() method

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Field Detail

      • inProgress

        public java.lang.Boolean inProgress

    • Constructor Detail

      • ServiceResponse

        public ServiceResponse()

      • ServiceResponse

        public ServiceResponse​(java.lang.Boolean success,
                       java.lang.String msg,
                       java.util.Map<java.lang.String,​java.lang.String> errors,
                       T data)

    • Method Detail

      • prepare

        public static ServiceResponse prepare()
        Helper to initialize a base response.
        Returns:
        A generic respose assuming the repsonse is an error if not converted to a success response.

      • prepare

        public static ServiceResponse prepare​(java.lang.Object data)
        Helper to initialize a base response with initial data.
        Returns:
        A generic respose assuming the repsonse is an error if not converted to a success response.

      • create

        public static ServiceResponse create​(java.util.Map<java.lang.String,​java.lang.Object> config)
        Helper to build an error response from a generic map.
        Returns:
        A success or error response based on the boolean value of success in the map.

      • create

        public static ServiceResponse create​(ServiceResponse source)
        Helper to create service response from an existing service response. Primarly a convenience method to prevent errors when a map has already been converted to a service response.
        Returns:
        An unmodified service response.

      • error

        public static ServiceResponse error()
        Helper to return a generic error response.
        Returns:
        A generic error scenario.

      • error

        public static ServiceResponse error​(java.lang.String msg)
        Helper to return a error message
        Parameters:
        msg - Message to send to the user.
        Returns:
        a ServiceResponse

      • error

        public static ServiceResponse error​(java.lang.String msg,
                                    java.util.Map<java.lang.String,​java.lang.String> errors)
        Detailed error message with a list of errors.
        Parameters:
        msg - Message to send to the user.
        errors - Detailed list of errors
        Returns:
        a ServiceResponse

      • error

        public static ServiceResponse error​(java.lang.String msg,
                                    java.util.Map<java.lang.String,​java.lang.String> errors,
                                    java.lang.Object data)
        Detailed error message with a list of errors.
        Parameters:
        msg - Message to send to the user.
        errors - Detailed list of errors
        data - Any additional data needed for the view.
        Returns:
        a ServiceResponse

      • success

        public static ServiceResponse success​(java.lang.Object data)
        Helper to return a success message.
        Parameters:
        data - object to pass back in success
        Returns:
        a ServiceResponse

      • success

        public static ServiceResponse success()
        Create a generic success response
        Returns:
        success response

      • toMap

        public java.util.Map<java.lang.String,​java.lang.Object> toMap()
        Build a Map from this object with keys success, msg, errors, data
        Returns:
        response Map

      • toMap

        public java.util.Map<java.lang.String,​java.lang.Object> toMap​(java.lang.String dataKeyName)
        Serializes the ServiceResponse to a map.
        Parameters:
        dataKeyName - the name to assign the data keys key in the map
        Returns:
        A Map

      • hasError

        public boolean hasError​(java.lang.String key)
        Return if the ServiceResponse has any errors set
        Parameters:
        key - Check a specific key
        Returns:
        boolean

      • hasErrors

        public boolean hasErrors()
        Return if the ServiceResponse has any errors set
        Returns:
        boolean

      • toString

        public java.lang.String toString()
        String representation of the toMap() method
        Overrides:
        toString in class java.lang.Object
        Returns:
        the response as a String

      • getSuccess

        public java.lang.Boolean getSuccess()

      • setSuccess

        public void setSuccess​(java.lang.Boolean success)

      • getMsg

        public java.lang.String getMsg()

      • setMsg

        public void setMsg​(java.lang.String msg)

      • getData

        public T getData()

      • setData

        public void setData​(T data)

      • getErrors

        public java.util.Map<java.lang.String,​java.lang.String> getErrors()

      • setErrors

        public void setErrors​(java.util.Map<java.lang.String,​java.lang.String> errors)

      • addError

        public void addError​(java.lang.String value)

      • addError

        public void addError​(java.lang.String key,
                     java.lang.String value)

      • removeError

        public void removeError()

      • clearErrors

        public void clearErrors()

      • removeError

        public void removeError​(java.lang.String key)

      • getError

        public java.lang.String getError​(java.lang.String key)
        Returns the specific error message for a given key.
        Parameters:
        key - that contains the error
        Returns:
        The error value

      • getError

        public java.lang.String getError()
        Provided for backwards compatibility with existing getError()
        Returns:
        Error message

      • setError

        public void setError​(java.lang.String value)
        Provided for backwards compatibility with existing setError(msg)
        Parameters:
        value - value to set

      • getHeaders

        public java.util.Map<java.lang.String,​java.lang.Object> getHeaders()

      • setHeaders

        public void setHeaders​(java.util.Map<java.lang.String,​java.lang.Object> headers)

      • addHeader

        public void addHeader​(java.lang.String key,
                      java.lang.Object value)

      • getContent

        public java.lang.String getContent()

      • setContent

        public void setContent​(java.lang.String content)

      • getErrorCode

        public java.lang.String getErrorCode()

      • setErrorCode

        public void setErrorCode​(java.lang.String errorCode)

      • getResults

        public java.lang.Object getResults()

      • setResults

        public void setResults​(java.lang.Object results)

      • getCookies

        public java.util.Map getCookies()

      • setCookies

        public void setCookies​(java.util.Map cookies)

      • addCookie

        public void addCookie​(java.lang.String key,
                      java.lang.Object value)
        Add a Cookie to the response
        Parameters:
        key - cookie name
        value - cookie value

      • getCookie

        public java.lang.String getCookie​(java.lang.String key)
        Find a cookie
        Parameters:
        key - cookie name
        Returns:
        the cookie value