org.odpi.openmetadata.commonservices.repositoryhandler

Class RepositoryErrorHandler

java.lang.Object

org.odpi.openmetadata.commonservices.repositoryhandler.RepositoryErrorHandler

public class RepositoryErrorHandler
extends Object

RepositoryErrorHandler provides common validation routines for the other handler classes

Constructor Summary

Constructors

Constructor and Description
RepositoryErrorHandler(OMRSRepositoryHelper repositoryHelper, String serviceName, String serverName) Typical constructor providing access to the repository connector for this access service.
RepositoryErrorHandler(OMRSRepositoryHelper repositoryHelper, String serviceName, String serverName, AuditLog auditLog) Typical constructor providing access to the repository connector for this access service.

Method Summary

Modifier and Type	Method and Description
void	handleAmbiguousEntityName(String name, String nameParameterName, String entityTypeName, List<EntityDetail> returnedEntities, String methodName) Throw an exception if multiple entities are returned when not expected.
void	handleAmbiguousName(String name, String nameParameterName, String entityTypeName, List<String> returnedEntityGUIDs, String methodName) Throw an exception if multiple entities are returned when not expected.
void	handleAmbiguousRelationships(String entityGUID, String entityTypeName, String relationshipTypeName, List<Relationship> returnedRelationships, String methodName) Throw an exception if multiple relationships are returned when not expected.
void	handleDuplicateCreateRequest(String typeName, String qualifiedName, String existingEntityGUID, String methodName) Report an error where an entity is being created with the same qualified name as an existing entity of the same type.
void	handleEntityProxy(Throwable error, String entityGUID, String entityTypeName, String methodName, String guidParameterName) Throw an exception if there is a problem with the asset guid
void	handleNoEntity(String entityTypeGUID, String entityTypeName, InstanceProperties properties, String methodName) Throw an exception if it is not possible to create an entity.
void	handleNoEntityForClassification(String entityGUID, String classificationTypeGUID, String classificationTypeName, InstanceProperties properties, String methodName) Throw an exception if it is not possible to update an entity.
void	handleNoRelationship(String entityGUID, String entityTypeName, String relationshipTypeName, String methodName) Throw an exception if no relationships are returned when not expected.
void	handleRepositoryError(Throwable error, String methodName) Throw an exception if an unexpected repository error is received
void	handleRepositoryError(Throwable error, String methodName, String localMethodName) Throw an exception if an unexpected repository error is received
void	handleUnauthorizedUser(String userId, String methodName) Throw an exception if the supplied userId is not authorized to perform a request
void	handleUnknownEntity(Throwable error, String entityGUID, String entityTypeName, String methodName, String guidParameterName) Throw an exception if there is a problem with the entity guid
void	handleUnknownRelationship(Throwable error, String relationshipGUID, String relationshipTypeName, String methodName, String guidParameterName) Throw an exception if there is a problem with the relationship guid
void	handleUnsupportedAnchorsType(Throwable error, String methodName, String typeName) Throw an exception if the supplied userId is not authorized to perform a request
void	handleUnsupportedParameter(String methodName, String parameterName, String parameterValue) Throw an exception if the supplied parameter is invalid.
void	handleUnsupportedProperty(Throwable error, String methodName, String propertyName) Throw an exception if the supplied property is not supported
void	handleUnsupportedType(Throwable error, String methodName, String typeName) Throw an exception if the supplied type name is not supported i nthe metadta
void	validateRepositoryConnector(OMRSRepositoryConnector repositoryConnector, String methodName) Check that there is a repository connector.

Methods inherited from class java.lang.Object

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

Constructor Detail

RepositoryErrorHandler

public RepositoryErrorHandler(OMRSRepositoryHelper repositoryHelper,
                              String serviceName,
                              String serverName)

Typical constructor providing access to the repository connector for this access service.

Parameters:

repositoryHelper - access to the repository helper.

serviceName - name of this access service

serverName - name of this server

RepositoryErrorHandler

public RepositoryErrorHandler(OMRSRepositoryHelper repositoryHelper,
                              String serviceName,
                              String serverName,
                              AuditLog auditLog)

Typical constructor providing access to the repository connector for this access service.

Parameters:

repositoryHelper - access to the repository helper.

serviceName - name of this access service

serverName - name of this server

auditLog - logging destination

Method Detail

validateRepositoryConnector

public void validateRepositoryConnector(OMRSRepositoryConnector repositoryConnector,
                                        String methodName)
                                 throws PropertyServerException

Check that there is a repository connector.

Parameters:

methodName - name of the method being called

repositoryConnector - connector object

Throws:

PropertyServerException - exception thrown if the repository connector

handleDuplicateCreateRequest

public void handleDuplicateCreateRequest(String typeName,
                                         String qualifiedName,
                                         String existingEntityGUID,
                                         String methodName)
                                  throws InvalidParameterException

Report an error where an entity is being created with the same qualified name as an existing entity of the same type.

Parameters:

typeName - name of the type

qualifiedName - clashing qualified name

existingEntityGUID - existing entity found in the repository

methodName - calling method

Throws:

InvalidParameterException - exception that reports this error

handleUnauthorizedUser

public void handleUnauthorizedUser(String userId,
                                   String methodName)
                            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.

Throws:

UserNotAuthorizedException - the userId is unauthorised for the request

handleUnsupportedProperty

public void handleUnsupportedProperty(Throwable error,
                                      String methodName,
                                      String propertyName)
                               throws InvalidParameterException

Throw an exception if the supplied property is not supported

Parameters:

error - caught exception

methodName - name of the method making the call

propertyName - name of the property in error

Throws:

InvalidParameterException - invalid property

handleUnsupportedParameter

public void handleUnsupportedParameter(String methodName,
                                       String parameterName,
                                       String parameterValue)
                                throws InvalidParameterException

Throw an exception if the supplied parameter is invalid.

Parameters:

methodName - name of the method making the call

parameterName - name of the parameter in error

parameterValue - value of the parameter

Throws:

InvalidParameterException - invalid property

handleUnsupportedType

public void handleUnsupportedType(Throwable error,
                                  String methodName,
                                  String typeName)
                           throws InvalidParameterException

Throw an exception if the supplied type name is not supported i nthe metadta

Parameters:

error - caught exception

methodName - name of the method making the call

typeName - name of the property in error

Throws:

InvalidParameterException - invalid property

handleUnsupportedAnchorsType

public void handleUnsupportedAnchorsType(Throwable error,
                                         String methodName,
                                         String typeName)

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

Parameters:

error - caught exception

methodName - name of the method making the call

typeName - name of the property in error

handleRepositoryError

public void handleRepositoryError(Throwable error,
                                  String methodName)
                           throws PropertyServerException

Throw an exception if an unexpected repository error is received

Parameters:

error - caught exception

methodName - name of the method making the call.

Throws:

PropertyServerException - unexpected exception from property server

handleRepositoryError

public void handleRepositoryError(Throwable error,
                                  String methodName,
                                  String localMethodName)
                           throws PropertyServerException

Throw an exception if an unexpected repository error is received

Parameters:

error - caught exception

methodName - name of the method called by the external party

localMethodName - name of method that called this error

Throws:

PropertyServerException - unexpected exception from property server

handleUnknownEntity

public void handleUnknownEntity(Throwable error,
                                String entityGUID,
                                String entityTypeName,
                                String methodName,
                                String guidParameterName)
                         throws InvalidParameterException

Throw an exception if there is a problem with the entity guid

Parameters:

error - caught exception

entityGUID - unique identifier for the requested entity

entityTypeName - expected type of asset

methodName - name of the method making the call

guidParameterName - name of the parameter that passed the GUID.

Throws:

InvalidParameterException - unexpected exception from property server

handleUnknownRelationship

public void handleUnknownRelationship(Throwable error,
                                      String relationshipGUID,
                                      String relationshipTypeName,
                                      String methodName,
                                      String guidParameterName)
                               throws InvalidParameterException

Throw an exception if there is a problem with the relationship guid

Parameters:

error - caught exception

relationshipGUID - unique identifier for the requested entity

relationshipTypeName - expected type of asset

methodName - name of the method making the call

guidParameterName - name of the parameter that passed the GUID.

Throws:

InvalidParameterException - unexpected exception from property server

handleEntityProxy

public void handleEntityProxy(Throwable error,
                              String entityGUID,
                              String entityTypeName,
                              String methodName,
                              String guidParameterName)
                       throws InvalidParameterException

Throw an exception if there is a problem with the asset guid

Parameters:

error - caught exception

entityGUID - unique identifier for the requested entity

entityTypeName - expected type of asset

methodName - name of the method making the call

guidParameterName - name of the parameter that passed the GUID.

Throws:

InvalidParameterException - unexpected exception from property server

handleAmbiguousRelationships

public void handleAmbiguousRelationships(String entityGUID,
                                         String entityTypeName,
                                         String relationshipTypeName,
                                         List<Relationship> returnedRelationships,
                                         String methodName)
                                  throws PropertyServerException

Throw an exception if multiple relationships are returned when not expected.

Parameters:

entityGUID - unique identifier for the anchor entity

entityTypeName - name of the entity's type

relationshipTypeName - expected type of relationship

returnedRelationships - list of relationships returned

methodName - name of the method making the call

Throws:

PropertyServerException - unexpected response from property server

handleAmbiguousEntityName

public void handleAmbiguousEntityName(String name,
                                      String nameParameterName,
                                      String entityTypeName,
                                      List<EntityDetail> returnedEntities,
                                      String methodName)
                               throws PropertyServerException

Throw an exception if multiple entities are returned when not expected.

Parameters:

name - requested name for the entity

nameParameterName - name of the parameter

entityTypeName - name of the entity's type

returnedEntities - list of entities returned

methodName - name of the method making the call

Throws:

PropertyServerException - unexpected response from property server

handleAmbiguousName

public void handleAmbiguousName(String name,
                                String nameParameterName,
                                String entityTypeName,
                                List<String> returnedEntityGUIDs,
                                String methodName)
                         throws PropertyServerException

Throw an exception if multiple entities are returned when not expected.

Parameters:

name - requested name for the entity

nameParameterName - name of the parameter

entityTypeName - name of the entity's type

returnedEntityGUIDs - list of entities returned

methodName - name of the method making the call

Throws:

PropertyServerException - unexpected response from property server

handleNoRelationship

public void handleNoRelationship(String entityGUID,
                                 String entityTypeName,
                                 String relationshipTypeName,
                                 String methodName)
                          throws PropertyServerException

Throw an exception if no relationships are returned when not expected.

Parameters:

entityGUID - unique identifier for the anchor entity

entityTypeName - name of the entity's type

relationshipTypeName - expected type of relationship

methodName - name of the method making the call

Throws:

PropertyServerException - unexpected response from property server

handleNoEntity

public void handleNoEntity(String entityTypeGUID,
                           String entityTypeName,
                           InstanceProperties properties,
                           String methodName)
                    throws PropertyServerException

Throw an exception if it is not possible to create an entity.

Parameters:

entityTypeGUID - unique identifier for the entity's type

entityTypeName - name of the entity's type

properties - properties

methodName - name of the method making the call

Throws:

PropertyServerException - unexpected response from property server

handleNoEntityForClassification

public void handleNoEntityForClassification(String entityGUID,
                                            String classificationTypeGUID,
                                            String classificationTypeName,
                                            InstanceProperties properties,
                                            String methodName)
                                     throws PropertyServerException

Throw an exception if it is not possible to update an entity.

Parameters:

entityGUID - unique identifier of entity

classificationTypeGUID - unique identifier for the classification's type

classificationTypeName - name of the classification's type

properties - properties

methodName - name of the method making the call

Throws:

PropertyServerException - unexpected response from property server