Package org.odpi.openmetadata.adminservices.client.rest

Class AdminClientRESTExceptionHandler

java.lang.Object
org.odpi.openmetadata.commonservices.ffdc.RESTExceptionHandler
org.odpi.openmetadata.adminservices.client.rest.AdminClientRESTExceptionHandler
public class AdminClientRESTExceptionHandler extends org.odpi.openmetadata.commonservices.ffdc.RESTExceptionHandler
AdminClientRESTExceptionHandler is managing the receipt of exceptions in the response from a REST call and converting them into Admin Exceptions.

  • Constructor Summary

    Constructors
    Constructor
    Description
    AdminClientRESTExceptionHandler()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    detectAndThrowAdminExceptions(org.odpi.openmetadata.commonservices.ffdc.rest.FFDCResponseBase restResult)
    Throw an exception if it is encoded in the REST response.
    void
    logRESTCallException(String serverPlatformURLRoot, String methodName, Throwable error)
    Provide detailed logging for exceptions.

    Methods inherited from class org.odpi.openmetadata.commonservices.ffdc.RESTExceptionHandler

    captureExceptions, captureExceptions, captureInvalidParameterException, capturePropertyServerException, captureUserNotAuthorizedException, detectAndThrowInvalidParameterException, detectAndThrowInvalidParameterException, detectAndThrowPropertyServerException, detectAndThrowPropertyServerException, detectAndThrowStandardExceptions, detectAndThrowUserNotAuthorizedException, detectAndThrowUserNotAuthorizedException, handleBadType, handleInvalidPropertiesObject, handleMissingValue, handleNoRequestBody, handleNoRequestBody, handleUnexpectedException

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • AdminClientRESTExceptionHandler

      public AdminClientRESTExceptionHandler()

  • Method Details

    • detectAndThrowAdminExceptions

      public void detectAndThrowAdminExceptions(org.odpi.openmetadata.commonservices.ffdc.rest.FFDCResponseBase restResult) throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException, org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException, org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
      Throw an exception if it is encoded in the REST response.
      Parameters:
      restResult - response from the rest call. This generated in the remote server.
      Throws:
      org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - one of the parameters is invalid.
      org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException - the user is not authorized to make this request.
      org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - configuration error

    • logRESTCallException

      public void logRESTCallException(String serverPlatformURLRoot, String methodName, Throwable error) throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
      Provide detailed logging for exceptions.
      Parameters:
      serverPlatformURLRoot - platform that was being called.
      methodName - calling method
      error - resulting exception
      Throws:
      org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - wrapping exception