Package org.odpi.openmetadata.commonservices.ffdc.rest

Class FFDCResponseBase

java.lang.Object
org.odpi.openmetadata.commonservices.ffdc.rest.FFDCResponseBase
All Implemented Interfaces:
FFDCResponse
Direct Known Subclasses:
AccessServicesResponse, AdminServicesAPIResponse, AssetCatalogSupportedTypes, BooleanResponse, CertificationElementsResponse, ConnectionListResponse, ConnectorReportResponse, ElementHeaderResponse, ElementHeadersResponse, EngineHostServicesResponse, GlossaryTermActivityTypeListResponse, GlossaryTermRelationshipStatusListResponse, GlossaryTermStatusListResponse, GovernanceEngineSummariesResponse, GovernanceEngineSummaryResponse, GUIDListResponse, GUIDResponse, IntegrationDaemonServicesResponse, IntegrationDaemonStatusResponse, IntegrationGroupsResponse, IntegrationGroupSummariesResponse, IntegrationGroupSummaryResponse, IntegrationReportResponse, IntegrationReportsResponse, MetadataElementSummariesResponse, MetadataElementSummaryResponse, MetadataRelationshipSummariesResponse, NameListResponse, OCFConnectionResponse, OCFConnectorTypeResponse, OMAGGAFAPIResponse, OMAGOMFAPIResponse, OMAGServerStatusResponse, OpenMetadataGraphResponse, OpenMetadataRootElementResponse, OpenMetadataRootElementsResponse, PlatformReportResponse, PropertiesResponse, RegisteredOMAGServiceResponse, RegisteredOMAGServicesResponse, RelatedMetadataElementSummariesResponse, ServerListResponse, ServerReportResponse, ServerServicesListResponse, ServerStatusResponse, StringMapResponse, StringResponse, SuccessMessageResponse, TechnologyTypeHierarchyResponse, TechnologyTypeReportResponse, TechnologyTypeSummaryListResponse, ValidMetadataValueListResponse, ValidMetadataValueResponse, ViewServicesResponse, VoidResponse
public class FFDCResponseBase extends Object implements FFDCResponse
FFDCResponseBase provides the base class for REST API responses.

  • Constructor Details

    • FFDCResponseBase

      public FFDCResponseBase()
      Default constructor

    • FFDCResponseBase

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

  • Method Details

    • getExceptionClassName

      public String getExceptionClassName()
      Return the name of the Java class name to use to recreate the exception.
      Specified by:
      getExceptionClassName in interface FFDCResponse
      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.
      Specified by:
      setExceptionClassName in interface FFDCResponse
      Parameters:
      exceptionClassName - - String name of the fully-qualified java class name

    • getExceptionCausedBy

      public String getExceptionCausedBy()
      Return the name of any nested exception that may indicate the root cause of the exception.
      Specified by:
      getExceptionCausedBy in interface FFDCResponse
      Returns:
      exception class name

    • setExceptionCausedBy

      public void setExceptionCausedBy(String exceptionCausedBy)
      Set up the name of any nested exception that may indicate the root cause of the exception.
      Specified by:
      setExceptionCausedBy in interface FFDCResponse
      Parameters:
      exceptionCausedBy - exception class name

    • getActionDescription

      public String getActionDescription()
      Return the description of the action in progress when the exception occurred.
      Specified by:
      getActionDescription in interface FFDCResponse
      Returns:
      string description

    • setActionDescription

      public void setActionDescription(String actionDescription)
      Set up the description of the activity in progress when the exception occurred.
      Specified by:
      setActionDescription in interface FFDCResponse
      Parameters:
      actionDescription - string description

    • getRelatedHTTPCode

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

    • setRelatedHTTPCode

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

    • getExceptionErrorMessage

      public String getExceptionErrorMessage()
      Return the error message associated with the exception.
      Specified by:
      getExceptionErrorMessage in interface FFDCResponse
      Returns:
      string error message

    • setExceptionErrorMessage

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

    • getExceptionErrorMessageId

      public String getExceptionErrorMessageId()
      Return the formal message identifier for the error message. This is incorporated in the error message. This is provided both for automated processing and to enable the error message to be reformatted in a different language.
      Specified by:
      getExceptionErrorMessageId in interface FFDCResponse
      Returns:
      string identifier

    • setExceptionErrorMessageId

      public void setExceptionErrorMessageId(String exceptionErrorMessageId)
      Set up the formal message identifier for the error message. This is incorporated in the error message. This is provided both for automated processing and to enable the error message to be reformatted in a different language.
      Specified by:
      setExceptionErrorMessageId in interface FFDCResponse
      Parameters:
      exceptionErrorMessageId - string identifier

    • getExceptionErrorMessageParameters

      public String[] getExceptionErrorMessageParameters()
      Return the parameters that were inserted in the error message. These are provided both for automated processing and to enable the error message to be reformatted in a different language.
      Specified by:
      getExceptionErrorMessageParameters in interface FFDCResponse
      Returns:
      array of strings

    • setExceptionErrorMessageParameters

      public void setExceptionErrorMessageParameters(String[] exceptionErrorMessageParameters)
      Set up the list of parameters inserted in to the error message. These are provided both for automated processing and to enable the error message to be reformatted in a different language.
      Specified by:
      setExceptionErrorMessageParameters in interface FFDCResponse
      Parameters:
      exceptionErrorMessageParameters - list of strings

    • getExceptionSystemAction

      public String getExceptionSystemAction()
      Return the description of the action taken by the system as a result of the exception.
      Specified by:
      getExceptionSystemAction in interface FFDCResponse
      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.
      Specified by:
      setExceptionSystemAction in interface FFDCResponse
      Parameters:
      exceptionSystemAction - - string description of the action taken

    • getExceptionUserAction

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

    • setExceptionUserAction

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

    • getExceptionProperties

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

    • setExceptionProperties

      public void setExceptionProperties(Map<String,Object> exceptionProperties)
      Set up the additional properties stored by the exceptions.
      Specified by:
      setExceptionProperties in interface FFDCResponse
      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