Package org.odpi.openmetadata.conformance.rest

Class ConformanceServicesAPIResponse

java.lang.Object
org.odpi.openmetadata.conformance.rest.ConformanceServicesAPIResponse
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
ProfileNameListResponse, ProfileReportResponse, TestCaseListReportResponse, TestCaseListResponse, TestCaseReportResponse, TestLabReportResponse, TestLabSummaryResponse, VoidResponse, WorkbenchReportResponse, WorkbenchStatusResponse
public abstract class ConformanceServicesAPIResponse extends Object implements Serializable
ConformanceServicesAPIResponse provides a common header for admin services managed response to its REST API. It manages information about exceptions. If no exception has been raised exceptionClassName is null.
See Also:

  • Constructor Details

    • ConformanceServicesAPIResponse

      public ConformanceServicesAPIResponse()
      Default constructor

    • ConformanceServicesAPIResponse

      public ConformanceServicesAPIResponse(ConformanceServicesAPIResponse template)
      Copy/clone constructor
      Parameters:
      template - object to copy

  • Method Details

    • getRelatedHTTPCode

      public int getRelatedHTTPCode()
      Return the HTTP Code to use if forwarding response to HTTP client.
      Returns:
      integer HTTP status code

    • setRelatedHTTPCode

      public void setRelatedHTTPCode(int relatedHTTPCode)
      Set up the HTTP Code to use if forwarding response to HTTP client.
      Parameters:
      relatedHTTPCode - - integer HTTP status code

    • getSuccessMessage

      public String getSuccessMessage()
      Return the success message (if any).
      Returns:
      string or null

    • setSuccessMessage

      public void setSuccessMessage(String successMessage)
      Set up the success message. This provides supplementary information about the services that have been changed.
      Parameters:
      successMessage - string or null

    • getExceptionClassName

      public String getExceptionClassName()
      Return the name of the Java class name to use to recreate the exception.
      Returns:
      String name of the fully-qualified java class name

    • setExceptionClassName

      public void setExceptionClassName(String exceptionClassName)
      Set up the name of the Java class name to use to recreate the exception.
      Parameters:
      exceptionClassName - - String name of the fully-qualified java class name

    • getExceptionErrorMessage

      public String getExceptionErrorMessage()
      Return the error message associated with the exception.
      Returns:
      string error message

    • setExceptionErrorMessage

      public void setExceptionErrorMessage(String exceptionErrorMessage)
      Set up the error message associated with the exception.
      Parameters:
      exceptionErrorMessage - - string error message

    • getExceptionSystemAction

      public String getExceptionSystemAction()
      Return the description of the action taken by the system as a result of the exception.
      Returns:
      - string description of the action taken

    • setExceptionSystemAction

      public void setExceptionSystemAction(String exceptionSystemAction)
      Set up the description of the action taken by the system as a result of the exception.
      Parameters:
      exceptionSystemAction - - string description of the action taken

    • getExceptionUserAction

      public String getExceptionUserAction()
      Return the action that a user should take to resolve the problem.
      Returns:
      string instructions

    • setExceptionUserAction

      public void setExceptionUserAction(String exceptionUserAction)
      Set up the action that a user should take to resolve the problem.
      Parameters:
      exceptionUserAction - - string instructions

    • getExceptionProperties

      public Map<String,Object> getExceptionProperties()
      Return the additional properties stored by the exceptions.
      Returns:
      property map

    • setExceptionProperties

      public void setExceptionProperties(Map<String,Object> exceptionProperties)
      Set up the additional properties stored by the exceptions.
      Parameters:
      exceptionProperties - property map

    • toString

      public String toString()
      JSON-like toString
      Overrides:
      toString in class Object
      Returns:
      string containing the property names and values

    • equals

      public boolean equals(Object objectToCompare)
      Return comparison result based on the content of the properties.
      Overrides:
      equals in class Object
      Parameters:
      objectToCompare - test object
      Returns:
      result of comparison

    • hashCode

      public int hashCode()
      Return hash code for this object
      Overrides:
      hashCode in class Object
      Returns:
      int hash code