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) Convert the supplied OMRS exception to a Subject Area classification error exception and throw it.
static void	handleEntityNotDeletedException(EntityNotDeletedException e, String methodName, String serverName, String serviceName, String guid) Convert the supplied OMRS exception to a Subject Area Entity Not Deleted exception and throw it.
static void	handleEntityNotDeletedException(String guid, String methodName, String serverName, String serviceName) Convert the supplied OMRS exception to a Subject Area entity not deleted exception and throw it.
static void	handleEntityNotKnownError(String guid, String methodName, String serverName, String serviceName) Convert the supplied OMRS exception to a Subject Area Entity Not known exception and throw it.
static void	handleEntityNotKnownException(String guid, String methodName, String serverName, String serviceName) Convert the supplied OMRS exception to a Subject Area Entity not known exception and throw it.
void	handleEntityNotPurgedException(String obsoleteGuid, String restAPIName, String serverName, String serviceName)
static void	handleEntityProxyOnlyException(EntityProxyOnlyException e, String methodName, String serverName, String serviceName) Convert the supplied OMRS exception to a Subject Area Entity Proxy Only exception and throw it.
static void	handleFunctionNotSupportedException(FunctionNotSupportedException e, String methodName, String serverName, String serviceName) Convert the supplied OMRS exception to a Subject Area Function Not Supported exception and throw it.
static void	handleInvalidParameterException(InvalidParameterException e, String methodName, String serverName, String serviceName) Throw an Invalid Parameter exception
void	handleMetadataServerUnContactable(MetadataServerUncontactableException e, String methodName, String serverName, String serviceName) Convert the supplied OMRS exception to a Subject Area metadata server not reachable exception and throw it.
static void	handlePagingErrorException(PagingErrorException e, String methodName, String serverName, String serviceName) Convert the supplied OMRS exception to a Subject Area paging error exception and throw it.
static void	handlePropertyErrorException(PropertyErrorException e, String methodName, String serverName, String serviceName) Convert the supplied OMRS exception to a Subject Area property error exception and throw it.
static void	handleRelationshipNotDeletedException(String guid, String methodName, String serverName, String serviceName) Convert the supplied OMRS exception to a Subject Area relationship not deleted exception and throw it.
static void	handleRelationshipNotKnownException(String guid, String methodName, String serverName, String serviceName) Convert the supplied OMRS exception to a Subject Area relationship not known exception and throw it.
void	handleRelationshipNotPurgedException(String obsoleteGuid, String restAPIName, String serverName, String serviceName)
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) Convert the supplied OMRS exception to a Subject Area status not known exception and throw it.
static void	handleTypeDefNotKnownException(String typeName, String methodName, String serverName, String serviceName) Convert the supplied OMRS exception to a Subject Area invalid type name exception and throw it.
static void	handleTypeErrorException(TypeErrorException e, String methodName, String serverName, String serviceName) Convert the supplied OMRS exception to a Subject Area type error exception and throw it.
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 - supplied 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

repositoryConnector - connector to the repository

Returns:

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

Throws:

MetadataServerUncontactableException - exception thrown if the metadata server cannot be reached

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 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 name of this server

serviceName - name of this access service

Throws:

MetadataServerUncontactableException - the metadata server cannot be reached

handleUnknownAsset

public static void handleUnknownAsset(Throwable error,
                                      String assetGUID,
                                      String methodName,
                                      String serverName,
                                      String serviceName)
                               throws 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 name of this server

serviceName - name of this access service

Throws:

UnrecognizedGUIDException - unexpected exception from property server

handleInvalidParameterException

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

Throw an Invalid Parameter exception

Parameters:

e - exception to handle

methodName - name of the method making the call.

serverName - name of this server

serviceName - name of this access service

Throws:

InvalidParameterException - a parameter is not valid or missing.

handleTypeDefNotKnownException

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

Convert the supplied OMRS exception to a Subject Area invalid type name exception and throw it.

Parameters:

typeName - the name of the unknown type

methodName - name of the method making the call.

serverName - name of this server

serviceName - access service name

Throws:

InvalidParameterException - a parameter is not valid or missing.

handlePropertyErrorException

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

Convert the supplied OMRS exception to a Subject Area property error exception and throw it.

Parameters:

e - exception to handle

methodName - name of the method making the call.

serverName - name of this server

serviceName - name of this access service

Throws:

InvalidParameterException - a parameter is not valid or missing.

handleClassificationErrorException

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

Convert the supplied OMRS exception to a Subject Area classification error exception and throw it.

Parameters:

e - exception to handle

methodName - name of the method making the call.

serverName - name of this server

serviceName - name of this access service

Throws:

ClassificationException - error occured during a classification

handleStatusNotSupportedException

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

Convert the supplied OMRS exception to a Subject Area status not known exception and throw it.

Parameters:

e - exception to handle

methodName - name of the method making the call.

serverName - name of this server

serviceName - name of this access service

Throws:

StatusNotSupportedException - staus not supported

handleEntityNotKnownError

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

Convert the supplied OMRS exception to a Subject Area Entity Not known exception and throw it.

Parameters:

guid - supplied guid

methodName - name of the method making the call.

serverName - name of this server

serviceName - name of this access service

Throws:

UnrecognizedGUIDException - unrecognized GUID

handleEntityProxyOnlyException

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

Convert the supplied OMRS exception to a Subject Area Entity Proxy Only exception and throw it.

Parameters:

e - exception to handle

methodName - name of the method making the call.

serverName - name of this server

serviceName - name of this access service

Throws:

MetadataServerUncontactableException - the metadata server cannot be reached

handleTypeErrorException

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

Convert the supplied OMRS exception to a Subject Area type error exception and throw it.

Parameters:

e - exception to handle

methodName - name of the method making the call.

serverName - name of this server

serviceName - name of this access service

Throws:

InvalidParameterException - a parameter is not valid or missing.

handleFunctionNotSupportedException

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

Convert the supplied OMRS exception to a Subject Area Function Not Supported exception and throw it.

Parameters:

e - exception to handle

methodName - name of the method making the call.

serverName - name of this server

serviceName - name of this access service

Throws:

FunctionNotSupportedException - Function not supported

handlePagingErrorException

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

Convert the supplied OMRS exception to a Subject Area paging error exception and throw it.

Parameters:

e - exception to handle

methodName - name of the method making the call.

serverName - name of this server

serviceName - name of this access service

Throws:

InvalidParameterException - a parameter is not valid or missing.

handleEntityNotDeletedException

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

Convert the supplied OMRS exception to a Subject Area Entity Not Deleted exception and throw it.

Parameters:

e - exception to handle

methodName - name of the method making the call.

serverName - name of this server

serviceName - name of this access service

guid - supplied guid

Throws:

GUIDNotPurgedException - Entity not deleted

handleRelationshipNotKnownException

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

Convert the supplied OMRS exception to a Subject Area relationship not known exception and throw it.

Parameters:

guid - supplied guid

methodName - name of the method making the call.

serverName - name of this server

serviceName - name of this access service

Throws:

UnrecognizedGUIDException - GUID not recognized

handleEntityNotKnownException

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

Convert the supplied OMRS exception to a Subject Area Entity not known exception and throw it.

Parameters:

guid - supplied guid

methodName - name of the method making the call.

serverName - name of this server

serviceName - name of this access service

Throws:

UnrecognizedGUIDException - GUID not recognized

handleEntityNotDeletedException

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

Convert the supplied OMRS exception to a Subject Area entity not deleted exception and throw it.

Parameters:

guid - supplied guid

methodName - name of the method making the call.

serverName - name of this server

serviceName - name of this access service

Throws:

GUIDNotDeletedException - Relationship not purged

handleRelationshipNotDeletedException

public static void handleRelationshipNotDeletedException(String guid,
                                                         String methodName,
                                                         String serverName,
                                                         String serviceName)
                                                  throws GUIDNotDeletedException

Convert the supplied OMRS exception to a Subject Area relationship not deleted exception and throw it.

Parameters:

guid - supplied guid

methodName - name of the method making the call.

serverName - name of this server

serviceName - name of this access service

Throws:

GUIDNotDeletedException - Relationship not purged

handleMetadataServerUnContactable

public void handleMetadataServerUnContactable(MetadataServerUncontactableException e,
                                              String methodName,
                                              String serverName,
                                              String serviceName)
                                       throws MetadataServerUncontactableException

Convert the supplied OMRS exception to a Subject Area metadata server not reachable exception and throw it.

Parameters:

e - exception to handle

methodName - name of the method making the call.

serverName - name of this server

serviceName - name of this access service

Throws:

MetadataServerUncontactableException - the metadata server cannot be reached

handleEntityNotPurgedException

public void handleEntityNotPurgedException(String obsoleteGuid,
                                           String restAPIName,
                                           String serverName,
                                           String serviceName)
                                    throws GUIDNotPurgedException

Throws:

GUIDNotPurgedException

handleRelationshipNotPurgedException

public void handleRelationshipNotPurgedException(String obsoleteGuid,
                                                 String restAPIName,
                                                 String serverName,
                                                 String serviceName)
                                          throws GUIDNotPurgedException

Throws:

GUIDNotPurgedException