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 SubjectAreaOMASAPIResponse	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 SubjectAreaOMASAPIResponse	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 SubjectAreaOMASAPIResponse	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 SubjectAreaOMASAPIResponse	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.
SubjectAreaOMASAPIResponse	handleEntityNotPurgedException(String obsoleteGuid, String restAPIName, String serverName, String serviceName)
static SubjectAreaOMASAPIResponse	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 SubjectAreaOMASAPIResponse	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 SubjectAreaOMASAPIResponse	handleInvalidParameterException(InvalidParameterException e, String methodName, String serverName, String serviceName) Throw an Invalid Parameter exception
SubjectAreaOMASAPIResponse	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 SubjectAreaOMASAPIResponse	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 SubjectAreaOMASAPIResponse	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 SubjectAreaOMASAPIResponse	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 SubjectAreaOMASAPIResponse	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.
SubjectAreaOMASAPIResponse	handleRelationshipNotPurgedException(String obsoleteGuid, String restAPIName, String serverName, String serviceName)
static SubjectAreaOMASAPIResponse	handleRepositoryError(Throwable error, String methodName, String serverName, String serviceName) return an exception response if the respository could not be contacted
static SubjectAreaOMASAPIResponse	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 SubjectAreaOMASAPIResponse	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 SubjectAreaOMASAPIResponse	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 SubjectAreaOMASAPIResponse	handleUnauthorizedUser(String userId, String methodName, String serverName, String serviceName) return an exception response if the supplied userId is not authorized to perform a request
static SubjectAreaOMASAPIResponse	handleUnknownAsset(Throwable error, String assetGUID, String methodName, String serverName, String serviceName) return an exception response if the asset is not known

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

handleUnauthorizedUser

public static SubjectAreaOMASAPIResponse handleUnauthorizedUser(String userId,
                                                                String methodName,
                                                                String serverName,
                                                                String serviceName)

return an exception response 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

Returns:

UserNotAuthorizedException response the userId is unauthorised for the request

handleRepositoryError

public static SubjectAreaOMASAPIResponse handleRepositoryError(Throwable error,
                                                               String methodName,
                                                               String serverName,
                                                               String serviceName)

return an exception response 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

Returns:

MetadataServerUncontactableException the metadata server cannot be reached

handleUnknownAsset

public static SubjectAreaOMASAPIResponse handleUnknownAsset(Throwable error,
                                                            String assetGUID,
                                                            String methodName,
                                                            String serverName,
                                                            String serviceName)

return an exception response 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

Returns:

UnrecognizedGUIDException response unexpected exception from property server

handleInvalidParameterException

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

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

Returns:

Invalid parameter response

handleTypeDefNotKnownException

public static SubjectAreaOMASAPIResponse 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.

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

Returns:

InvalidParameterException response a parameter is not valid or missing.

handlePropertyErrorException

public static SubjectAreaOMASAPIResponse handlePropertyErrorException(PropertyErrorException e,
                                                                      String methodName,
                                                                      String serverName,
                                                                      String serviceName)

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

Returns:

InvalidParameterException response a parameter is not valid or missing.

handleClassificationErrorException

public static SubjectAreaOMASAPIResponse handleClassificationErrorException(ClassificationErrorException e,
                                                                            String methodName,
                                                                            String serverName,
                                                                            String serviceName)

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

Returns:

ClassificationException error occurred during a classification

handleStatusNotSupportedException

public static SubjectAreaOMASAPIResponse 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.

Parameters:

e - exception to handle

methodName - name of the method making the call.

serverName - name of this server

serviceName - name of this access service

Returns:

StatusNotSupportedException response status not supported response

handleEntityNotKnownError

public static SubjectAreaOMASAPIResponse 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.

Parameters:

guid - supplied guid

methodName - name of the method making the call.

serverName - name of this server

serviceName - name of this access service

Returns:

UnrecognizedGUIDException unrecognized GUID response

handleEntityProxyOnlyException

public static SubjectAreaOMASAPIResponse 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.

Parameters:

e - exception to handle

methodName - name of the method making the call.

serverName - name of this server

serviceName - name of this access service

Returns:

MetadataServerUncontactableException the metadata server cannot be reached response

handleTypeErrorException

public static SubjectAreaOMASAPIResponse handleTypeErrorException(TypeErrorException e,
                                                                  String methodName,
                                                                  String serverName,
                                                                  String serviceName)

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

Returns:

InvalidParameterException a parameter is not valid or missing response

handleFunctionNotSupportedException

public static SubjectAreaOMASAPIResponse 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.

Parameters:

e - exception to handle

methodName - name of the method making the call.

serverName - name of this server

serviceName - name of this access service

Returns:

FunctionNotSupportedException response Function not supported

handlePagingErrorException

public static SubjectAreaOMASAPIResponse handlePagingErrorException(PagingErrorException e,
                                                                    String methodName,
                                                                    String serverName,
                                                                    String serviceName)

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

Returns:

InvalidParameterException response. a parameter is not valid or missing

handleRelationshipNotKnownException

public static SubjectAreaOMASAPIResponse 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.

Parameters:

guid - supplied guid

methodName - name of the method making the call.

serverName - name of this server

serviceName - name of this access service

Returns:

UnrecognizedGUIDException response - GUID not recognized

handleEntityNotKnownException

public static SubjectAreaOMASAPIResponse 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.

Parameters:

guid - supplied guid

methodName - name of the method making the call.

serverName - name of this server

serviceName - name of this access service

Returns:

UnrecognizedGUIDException response - GUID not recognized

handleEntityNotDeletedException

public static SubjectAreaOMASAPIResponse 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.

Parameters:

guid - supplied guid

methodName - name of the method making the call.

serverName - name of this server

serviceName - name of this access service

Returns:

GUIDNotDeletedException Relationship not purged

handleRelationshipNotDeletedException

public static SubjectAreaOMASAPIResponse 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.

Parameters:

guid - supplied guid

methodName - name of the method making the call.

serverName - name of this server

serviceName - name of this access service

Returns:

GUIDNotDeletedException response Relationship not purged

handleMetadataServerUnContactable

public SubjectAreaOMASAPIResponse 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.

Parameters:

e - exception to handle

methodName - name of the method making the call.

serverName - name of this server

serviceName - name of this access service

Returns:

MetadataServerUncontactableException response -the metadata server cannot be reached

handleEntityNotPurgedException

public SubjectAreaOMASAPIResponse handleEntityNotPurgedException(String obsoleteGuid,
                                                                 String restAPIName,
                                                                 String serverName,
                                                                 String serviceName)

handleRelationshipNotPurgedException

public SubjectAreaOMASAPIResponse handleRelationshipNotPurgedException(String obsoleteGuid,
                                                                       String restAPIName,
                                                                       String serverName,
                                                                       String serviceName)