org.odpi.openmetadata.accessservices.subjectarea.server.handlers

Class ErrorHandler

java.lang.Object

org.odpi.openmetadata.accessservices.subjectarea.server.handlers.ErrorHandler

public class ErrorHandler
extends Object

ErrorHandler provides common validation routines for the other handler classes

Constructor Summary

Constructors

Constructor and Description
ErrorHandler()

Method Summary

Modifier and Type	Method and Description
static void	handleClassificationErrorException(ClassificationErrorException e, String methodName, String serverName, String serviceName)
static void	handleEntityNotDeletedException(EntityNotDeletedException e, String methodName, String serverName, String serviceName, String guid) convert OMRS exception to OMAS Exception
static void	handleEntityNotDeletedException(String guid, String methodName, String serverName, String serviceName) Entity not deleted
static void	handleEntityNotKnownError(String guid, String methodName, String serverName, String serviceName) Entity not known
static void	handleEntityProxyOnlyException(EntityProxyOnlyException e, String methodName, String serverName, String serviceName) convert OMRS exception to OMAS Exception
static void	handleFunctionNotSupportedException(FunctionNotSupportedException e, String methodName, String serverName, String serviceName) convert OMRS exception to OMAS Exception
static void	handleInvalidParameterException(InvalidParameterException e, String methodName, String serverName, String serviceName) convert OMRS exception to OMAS Exception
static void	handlePagingErrorException(PagingErrorException e, String methodName, String serverName, String serviceName) convert OMRS exception to OMAS Exception
static void	handlePropertyErrorException(PropertyErrorException e, String methodName, String serverName, String serviceName) convert OMRS exception to OMAS Exception
static void	handleRelationshipNotDeletedException(RelationshipNotDeletedException e, String methodName, String serverName, String serviceName, String guid) relationship not deleted
static void	handleRelationshipNotKnownException(String guid, String methodName, String serverName, String serviceName) relationship not known
static void	handleRepositoryError(Throwable error, String methodName, String serverName, String serviceName) Throw an exception if the respository could not be contacted
static void	handleStatusNotSupportedException(StatusNotSupportedException e, String methodName, String serverName, String serviceName) status is not known
static void	handleTypeDefNotKnownException(String typeName, String methodName, String serverName, String serviceName) Invalid type name convert OMRS exception to OMAS Exception
static void	handleTypeErrorException(TypeErrorException e, String methodName, String serverName, String serviceName) convert OMRS exception to OMAS Exception
static void	handleUnauthorizedUser(String userId, String methodName, String serverName, String serviceName) Throw an exception if the supplied userId is not authorized to perform a request
static void	handleUnknownAsset(Throwable error, String assetGUID, String methodName, String serverName, String serviceName) Throw an exception if the asset is not known
static void	validateEnum(Object enumValue, String parameterName, String methodName) Throw an exception if the supplied enum is null
static void	validateGUID(String guid, String parameterName, String methodName) Throw an exception if the supplied unique identifier is null
static void	validateName(String name, String parameterName, String methodName) Throw an exception if the supplied name is null
static OMRSMetadataCollection	validateRepositoryConnector(String methodName, OMRSRepositoryConnector repositoryConnector) Check that there is a repository connector.
static void	validateText(String text, String parameterName, String methodName) Throw an exception if the supplied text field is null
static void	validateUserId(String userId, String methodName) Throw an exception if the supplied userId is null

Methods inherited from class java.lang.Object

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

Constructor Detail

ErrorHandler

public ErrorHandler()

Method Detail

validateUserId

public static void validateUserId(String userId,
                                  String methodName)
                           throws InvalidParameterException

Throw an exception if the supplied userId is null

Parameters:

userId - - user name to validate

methodName - - name of the method making the call.

Throws:

InvalidParameterException - - the userId is null

validateGUID

public static void validateGUID(String guid,
                                String parameterName,
                                String methodName)
                         throws InvalidParameterException

Throw an exception if the supplied unique identifier is null

Parameters:

guid - - unique identifier to validate

parameterName - - name of the parameter that passed the guid.

methodName - - name of the method making the call.

Throws:

InvalidParameterException - - the guid is null

validateEnum

public static void validateEnum(Object enumValue,
                                String parameterName,
                                String methodName)
                         throws InvalidParameterException

Throw an exception if the supplied enum is null

Parameters:

enumValue - - enum value to validate

parameterName - - name of the parameter that passed the enum.

methodName - - name of the method making the call.

Throws:

InvalidParameterException - - the enum is null

validateName

public static void validateName(String name,
                                String parameterName,
                                String methodName)
                         throws InvalidParameterException

Throw an exception if the supplied name is null

Parameters:

name - - unique name to validate

parameterName - - name of the parameter that passed the name.

methodName - - name of the method making the call.

Throws:

InvalidParameterException - - the guid is null

validateText

public static void validateText(String text,
                                String parameterName,
                                String methodName)
                         throws InvalidParameterException

Throw an exception if the supplied text field is null

Parameters:

text - - unique name to validate

parameterName - - name of the parameter that passed the name.

methodName - - name of the method making the call.

Throws:

InvalidParameterException - - the guid is null

validateRepositoryConnector

public static OMRSMetadataCollection validateRepositoryConnector(String methodName,
                                                                 OMRSRepositoryConnector repositoryConnector)
                                                          throws MetadataServerUncontactableException

Check that there is a repository connector.

Parameters:

methodName - - name of the method being called

Returns:

metadata collection that provides access to the properties in the property server

Throws:

MetadataServerUncontactableException - - exception thrown if the repository connector

handleUnauthorizedUser

public static void handleUnauthorizedUser(String userId,
                                          String methodName,
                                          String serverName,
                                          String serviceName)
                                   throws UserNotAuthorizedException

Throw an exception if the supplied userId is not authorized to perform a request

Parameters:

userId - - user name to validate

methodName - - name of the method making the call.

serverName - - name of this server

serviceName - - name of this access service

Throws:

UserNotAuthorizedException - - the userId is unauthorised for the request

handleRepositoryError

public static void handleRepositoryError(Throwable error,
                                         String methodName,
                                         String serverName,
                                         String serviceName)
                                  throws MetadataServerUncontactableException

Throw an exception if the respository could not be contacted

Parameters:

error - - caught exception

methodName - - name of the method making the call.

serverName - - name of this server

serviceName - - name of this access service

Throws:

MetadataServerUncontactableException - - unexpected exception from property server

handleUnknownAsset

public static void handleUnknownAsset(Throwable error,
                                      String assetGUID,
                                      String methodName,
                                      String serverName,
                                      String serviceName)
                               throws InvalidParameterException,
                                      UnrecognizedGUIDException

Throw an exception if the asset is not known

Parameters:

error - - caught exception

assetGUID - - unique identifier for the requested asset

methodName - - name of the method making the call

serverName - - name of this server

serviceName - - name of this access service

Throws:

UnrecognizedGUIDException - - unexpected exception from property server

InvalidParameterException

handleInvalidParameterException

public static void handleInvalidParameterException(InvalidParameterException e,
                                                   String methodName,
                                                   String serverName,
                                                   String serviceName)
                                            throws InvalidParameterException

convert OMRS exception to OMAS Exception

Parameters:

e - - exception to handle

methodName -

serverName -

serviceName -

Throws:

InvalidParameterException

handleTypeDefNotKnownException

public static void handleTypeDefNotKnownException(String typeName,
                                                  String methodName,
                                                  String serverName,
                                                  String serviceName)
                                           throws InvalidParameterException

Invalid type name convert OMRS exception to OMAS Exception

Parameters:

typeName -

methodName -

serverName -

serviceName -

Throws:

InvalidParameterException

handlePropertyErrorException

public static void handlePropertyErrorException(PropertyErrorException e,
                                                String methodName,
                                                String serverName,
                                                String serviceName)
                                         throws InvalidParameterException

convert OMRS exception to OMAS Exception

Parameters:

e - - exception to handle

methodName -

serverName -

serviceName -

Throws:

InvalidParameterException

handleClassificationErrorException

public static void handleClassificationErrorException(ClassificationErrorException e,
                                                      String methodName,
                                                      String serverName,
                                                      String serviceName)
                                               throws ClassificationException

Parameters:

e -

methodName -

serverName -

serviceName -

Throws:

ClassificationException

handleStatusNotSupportedException

public static void handleStatusNotSupportedException(StatusNotSupportedException e,
                                                     String methodName,
                                                     String serverName,
                                                     String serviceName)
                                              throws StatusNotSupportedException

status is not known

Parameters:

e -

methodName -

serverName -

serviceName -

Throws:

StatusNotSupportedException

handleEntityNotKnownError

public static void handleEntityNotKnownError(String guid,
                                             String methodName,
                                             String serverName,
                                             String serviceName)
                                      throws UnrecognizedGUIDException

Entity not known

Parameters:

guid -

methodName -

serverName -

serviceName -

Throws:

UnrecognizedGUIDException

handleEntityProxyOnlyException

public static void handleEntityProxyOnlyException(EntityProxyOnlyException e,
                                                  String methodName,
                                                  String serverName,
                                                  String serviceName)
                                           throws MetadataServerUncontactableException

convert OMRS exception to OMAS Exception

Parameters:

e - - exception to handle

methodName -

serverName -

serviceName -

Throws:

MetadataServerUncontactableException

handleTypeErrorException

public static void handleTypeErrorException(TypeErrorException e,
                                            String methodName,
                                            String serverName,
                                            String serviceName)
                                     throws InvalidParameterException

convert OMRS exception to OMAS Exception

Parameters:

e - - exception to handle

methodName -

serverName -

serviceName -

Throws:

InvalidParameterException

handleFunctionNotSupportedException

public static void handleFunctionNotSupportedException(FunctionNotSupportedException e,
                                                       String methodName,
                                                       String serverName,
                                                       String serviceName)
                                                throws FunctionNotSupportedException

convert OMRS exception to OMAS Exception

Parameters:

e - - exception to handle

methodName -

serverName -

serviceName -

Throws:

FunctionNotSupportedException

handlePagingErrorException

public static void handlePagingErrorException(PagingErrorException e,
                                              String methodName,
                                              String serverName,
                                              String serviceName)
                                       throws InvalidParameterException

convert OMRS exception to OMAS Exception

Parameters:

e - - exception to handle

methodName -

serverName -

serviceName -

Throws:

InvalidParameterException

handleEntityNotDeletedException

public static void handleEntityNotDeletedException(EntityNotDeletedException e,
                                                   String methodName,
                                                   String serverName,
                                                   String serviceName,
                                                   String guid)
                                            throws GUIDNotPurgedException

convert OMRS exception to OMAS Exception

Parameters:

e - - exception to handle

methodName -

serverName -

serviceName -

guid -

Throws:

GUIDNotPurgedException

handleRelationshipNotKnownException

public static void handleRelationshipNotKnownException(String guid,
                                                       String methodName,
                                                       String serverName,
                                                       String serviceName)
                                                throws UnrecognizedGUIDException

relationship not known

Parameters:

guid -

methodName -

serverName -

serviceName -

Throws:

UnrecognizedGUIDException

handleRelationshipNotDeletedException

public static void handleRelationshipNotDeletedException(RelationshipNotDeletedException e,
                                                         String methodName,
                                                         String serverName,
                                                         String serviceName,
                                                         String guid)
                                                  throws GUIDNotPurgedException

relationship not deleted

Parameters:

e -

methodName -

serverName -

serviceName -

guid -

Throws:

GUIDNotPurgedException

handleEntityNotDeletedException

public static void handleEntityNotDeletedException(String guid,
                                                   String methodName,
                                                   String serverName,
                                                   String serviceName)
                                            throws GUIDNotPurgedException

Entity not deleted

Parameters:

guid -

methodName -

serverName -

serviceName -

Throws:

GUIDNotPurgedException