Class RestResponse


  • public abstract class RestResponse
    extends Object

    This class abstracts the response from the admin console code so that we can use JSON / REST interchangeably.

    Author:
    jasonlee, Ken Paulsen ([email protected])
    • Constructor Detail

      • RestResponse

        public RestResponse()
    • Method Detail

      • getResponseCode

        public abstract int getResponseCode()
      • getResponseBody

        public abstract String getResponseBody()
      • getRestResponse

        public static RestResponse getRestResponse​(jakarta.ws.rs.core.Response response)
      • isSuccess

        public boolean isSuccess()
      • getResponse

        public abstract Map<String,​Object> getResponse()

        This method abstracts the physical response to return a consistent data structure. For many responses, this data structure may look like:

        Map<String, Object> { "responseCode" : Integer // HTTP Response code, ie. 200 "output" : String // The Raw Response Body "description" : String // Command Description // 0 or more messages returned from the command "messages" : List<Map<String, Object>> [ { "message" : String // Raw Message String "..." : String // Additional custom attributes // List of properties for this message "properties" : List<Map<String, Object>> [ { "name" : String // The Property Name "value" : String // The Property Value "properties" : List // Child Properties }, ... ] }, ... ] }

      • close

        public abstract void close()