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 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(FFDCResponseBase restResult)	Throw an exception if it is encoded in the REST response.
void	logRESTCallException(String serverPlatformURLRoot, String methodName, Exception error)	Provide detailed logging for exceptions.

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

captureCheckedException, captureCheckedException, captureInvalidParameterException, capturePropertyServerException, captureRuntimeExceptions, captureUserNotAuthorizedException, detectAndThrowInvalidParameterException, detectAndThrowInvalidParameterException, detectAndThrowPropertyServerException, detectAndThrowPropertyServerException, detectAndThrowStandardExceptions, detectAndThrowUserNotAuthorizedException, detectAndThrowUserNotAuthorizedException, handleBadType, handleInvalidCallToServer, handleInvalidPropertiesObject, handleMissingValue, handleNoRequestBody, handleNoRequestBody, handleUnexpectedException

Methods inherited from class java.lang.Object

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

Constructor Details

AdminClientRESTExceptionHandler

public AdminClientRESTExceptionHandler()

Method Details

detectAndThrowAdminExceptions

public void detectAndThrowAdminExceptions(FFDCResponseBase restResult)
                                   throws OMAGInvalidParameterException,
OMAGNotAuthorizedException,
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:

OMAGInvalidParameterException - one of the parameters is invalid.

OMAGNotAuthorizedException - the user is not authorized to make this request.

OMAGConfigurationErrorException - configuration error

logRESTCallException

public void logRESTCallException(String serverPlatformURLRoot,
 String methodName,
 Exception error)
                          throws OMAGConfigurationErrorException

Provide detailed logging for exceptions.

Parameters:

serverPlatformURLRoot - platform that was being called.

methodName - calling method

error - resulting exception

Throws:

OMAGConfigurationErrorException - wrapping exception