org.odpi.openmetadata.viewservices.serverauthor.api.ffdc

Class ServerAuthorExceptionHandler

java.lang.Object

org.odpi.openmetadata.viewservices.serverauthor.api.ffdc.ServerAuthorExceptionHandler

public class ServerAuthorExceptionHandler
extends Object

The Server Author Exception handler maps OMAG exceptions that have been produced by the admin client into Server author Exceptions.

Constructor Summary

Constructors

Constructor and Description
ServerAuthorExceptionHandler()

Method Summary

Modifier and Type	Method and Description
static void	captureCheckedException(FFDCResponse response, OCFCheckedExceptionBase error, String exceptionClassName) Method for capturing an exception into a REST response.
static ServerAuthorViewServiceException	mapOMAGConfigurationErrorException(String className, String methodName, OMAGConfigurationErrorException error) Map an OMAG configuration exception to a ServerAuthorViewServiceException
static ServerAuthorViewServiceException	mapOMAGInvalidParameterException(String className, String methodName, OMAGInvalidParameterException omagException) Map an OMAGInvalidParameterException to a ServerAuthorViewServiceException which is more consumable / meaningful to the UI
static ServerAuthorViewServiceException	mapOMAGUserNotAuthorizedException(String className, String methodName, OMAGNotAuthorizedException omagException) Map an OMAGNotAuthorizedException to a ServerAuthorViewServiceException which is more consumable / meaningful to the UI

Methods inherited from class java.lang.Object

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

Constructor Detail

ServerAuthorExceptionHandler

public ServerAuthorExceptionHandler()

Method Detail

captureCheckedException

public static void captureCheckedException(FFDCResponse response,
                                           OCFCheckedExceptionBase error,
                                           String exceptionClassName)

Method for capturing an exception into a REST response. Set the exception information into the response. This exception capture handler strips off the messageId from the front of the message as the message is intended for user-consumption.

Parameters:

response - REST Response

error - returned response.

exceptionClassName - class name of the exception to recreate

mapOMAGUserNotAuthorizedException

public static ServerAuthorViewServiceException mapOMAGUserNotAuthorizedException(String className,
                                                                                 String methodName,
                                                                                 OMAGNotAuthorizedException omagException)

Map an OMAGNotAuthorizedException to a ServerAuthorViewServiceException which is more consumable / meaningful to the UI

Parameters:

className - the name of the calling class

methodName - the name of the operation being requested

omagException - supplied OMAGNotAuthorizedException

Returns:

mapped Server author View Exception

mapOMAGInvalidParameterException

public static ServerAuthorViewServiceException mapOMAGInvalidParameterException(String className,
                                                                                String methodName,
                                                                                OMAGInvalidParameterException omagException)

Map an OMAGInvalidParameterException to a ServerAuthorViewServiceException which is more consumable / meaningful to the UI

Parameters:

className - the name of the calling class

methodName - the name of the operation being requested

omagException - supplied OMAGInvalidParameterException

Returns:

mapped Server author View Exception

mapOMAGConfigurationErrorException

public static ServerAuthorViewServiceException mapOMAGConfigurationErrorException(String className,
                                                                                  String methodName,
                                                                                  OMAGConfigurationErrorException error)

Map an OMAG configuration exception to a ServerAuthorViewServiceException

Parameters:

className - the name of the calling class

methodName - the name of the operation being requested

error - the OMAGConfigurationErrorException error to be mapped

Returns:

ServerAuthorViewServiceException Server Author View Service Exception