Interface OpenMetadataRepositorySecurity

  • All Known Implementing Classes:
    OMRSMetadataDefaultRepositorySecurity

    public interface OpenMetadataRepositorySecurity
    OpenMetadataRepositorySecurity defines security checks for accessing and maintaining open metadata types and instances in the local repository. An instance is an entity or a relationship. There is also a special method for changing classifications added to an entity.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      boolean validateEntityReferenceCopySave​(org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityDetail instance)
      Tests for whether a reference copy should be saved to the repository.
      boolean validateRelationshipReferenceCopySave​(org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.Relationship instance)
      Tests for whether a reference copy should be saved to the repository.
      void validateUserForEntityClassificationAdd​(java.lang.String userId, java.lang.String metadataCollectionName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntitySummary instance, java.lang.String classificationName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties)
      Tests for whether a specific user should have the right to add a classification to an entity instance within a repository.
      void validateUserForEntityClassificationDelete​(java.lang.String userId, java.lang.String metadataCollectionName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntitySummary instance, java.lang.String classificationName)
      Tests for whether a specific user should have the right to delete a classification from an entity instance within a repository.
      void validateUserForEntityClassificationUpdate​(java.lang.String userId, java.lang.String metadataCollectionName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntitySummary instance, java.lang.String classificationName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties)
      Tests for whether a specific user should have the right to update a classification for an entity instance within a repository.
      void validateUserForEntityCreate​(java.lang.String userId, java.lang.String metadataCollectionName, java.lang.String entityTypeGUID, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties initialProperties, java.util.List<org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.Classification> initialClassifications, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceStatus initialStatus)
      Tests for whether a specific user should have the right to create a instance within a repository.
      void validateUserForEntityDelete​(java.lang.String userId, java.lang.String metadataCollectionName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityDetail instance)
      Tests for whether a specific user should have the right to delete a instance within a repository.
      void validateUserForEntityProxyRead​(java.lang.String userId, java.lang.String metadataCollectionName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityProxy instance)
      Tests for whether a specific user should have read access to a specific instance within a repository.
      org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityDetail validateUserForEntityRead​(java.lang.String userId, java.lang.String metadataCollectionName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityDetail instance)
      Tests for whether a specific user should have read access to a specific instance within a repository.
      void validateUserForEntityReHoming​(java.lang.String userId, java.lang.String metadataCollectionName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityDetail instance, java.lang.String newHomeMetadataCollectionId, java.lang.String newHomeMetadataCollectionName)
      Tests for whether a specific user should have the right to change the home of a instance within a repository.
      void validateUserForEntityReIdentification​(java.lang.String userId, java.lang.String metadataCollectionName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityDetail instance, java.lang.String newGUID)
      Tests for whether a specific user should have the right to change the guid on a instance within a repository.
      void validateUserForEntityRestore​(java.lang.String userId, java.lang.String metadataCollectionName, java.lang.String deletedEntityGUID)
      Tests for whether a specific user should have the right to restore a instance within a repository.
      void validateUserForEntityReTyping​(java.lang.String userId, java.lang.String metadataCollectionName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityDetail instance, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefSummary newTypeDefSummary)
      Tests for whether a specific user should have the right to change the type of a instance within a repository.
      void validateUserForEntitySummaryRead​(java.lang.String userId, java.lang.String metadataCollectionName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntitySummary instance)
      Tests for whether a specific user should have read access to a specific instance within a repository.
      void validateUserForEntityUpdate​(java.lang.String userId, java.lang.String metadataCollectionName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityDetail instance)
      Tests for whether a specific user should have the right to update a instance within a repository.
      void validateUserForRelationshipCreate​(java.lang.String userId, java.lang.String metadataCollectionName, java.lang.String relationshipTypeGUID, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties initialProperties, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntitySummary entityOneSummary, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntitySummary entityTwoSummary, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceStatus initialStatus)
      Tests for whether a specific user should have the right to create a instance within a repository.
      void validateUserForRelationshipDelete​(java.lang.String userId, java.lang.String metadataCollectionName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.Relationship instance)
      Tests for whether a specific user should have the right to delete a instance within a repository.
      org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.Relationship validateUserForRelationshipRead​(java.lang.String userId, java.lang.String metadataCollectionName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.Relationship instance)
      Tests for whether a specific user should have read access to a specific instance within a repository.
      void validateUserForRelationshipReHoming​(java.lang.String userId, java.lang.String metadataCollectionName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.Relationship instance, java.lang.String newHomeMetadataCollectionId, java.lang.String newHomeMetadataCollectionName)
      Tests for whether a specific user should have the right to change the home of a instance within a repository.
      void validateUserForRelationshipReIdentification​(java.lang.String userId, java.lang.String metadataCollectionName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.Relationship instance, java.lang.String newGUID)
      Tests for whether a specific user should have the right to change the guid on a instance within a repository.
      void validateUserForRelationshipRestore​(java.lang.String userId, java.lang.String metadataCollectionName, java.lang.String deletedRelationshipGUID)
      Tests for whether a specific user should have the right to restore a instance within a repository.
      void validateUserForRelationshipReTyping​(java.lang.String userId, java.lang.String metadataCollectionName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.Relationship instance, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefSummary newTypeDefSummary)
      Tests for whether a specific user should have the right to change the type of a instance within a repository.
      void validateUserForRelationshipUpdate​(java.lang.String userId, java.lang.String metadataCollectionName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.Relationship instance)
      Tests for whether a specific user should have the right to update a instance within a repository.
      void validateUserForTypeCreate​(java.lang.String userId, java.lang.String metadataCollectionName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.AttributeTypeDef attributeTypeDef)
      Tests for whether a specific user should have the right to create a type within a repository.
      void validateUserForTypeCreate​(java.lang.String userId, java.lang.String metadataCollectionName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDef typeDef)
      Tests for whether a specific user should have the right to create a type within a repository.
      void validateUserForTypeDelete​(java.lang.String userId, java.lang.String metadataCollectionName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.AttributeTypeDef attributeTypeDef)
      Tests for whether a specific user should have the right to delete a type within a repository.
      void validateUserForTypeDelete​(java.lang.String userId, java.lang.String metadataCollectionName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDef typeDef)
      Tests for whether a specific user should have the right to delete a type within a repository.
      void validateUserForTypeRead​(java.lang.String userId, java.lang.String metadataCollectionName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.AttributeTypeDef attributeTypeDef)
      Tests for whether a specific user should have read access to a specific type within a repository.
      void validateUserForTypeRead​(java.lang.String userId, java.lang.String metadataCollectionName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDef typeDef)
      Tests for whether a specific user should have read access to a specific type within a repository.
      void validateUserForTypeReIdentify​(java.lang.String userId, java.lang.String metadataCollectionName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.AttributeTypeDef originalAttributeTypeDef, java.lang.String newTypeDefGUID, java.lang.String newTypeDefName)
      Tests for whether a specific user should have the right to change the identifiers for a type within a repository.
      void validateUserForTypeReIdentify​(java.lang.String userId, java.lang.String metadataCollectionName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDef originalTypeDef, java.lang.String newTypeDefGUID, java.lang.String newTypeDefName)
      Tests for whether a specific user should have the right to change the identifiers for a type within a repository.
      void validateUserForTypeUpdate​(java.lang.String userId, java.lang.String metadataCollectionName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDef typeDef, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefPatch patch)
      Tests for whether a specific user should have the right to update a type within a repository.
    • Method Detail

      • validateUserForTypeCreate

        void validateUserForTypeCreate​(java.lang.String userId,
                                       java.lang.String metadataCollectionName,
                                       org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDef typeDef)
                                throws UserNotAuthorizedException
        Tests for whether a specific user should have the right to create a type within a repository.
        Parameters:
        userId - identifier of user
        metadataCollectionName - configurable name of the metadata collection
        typeDef - type details
        Throws:
        UserNotAuthorizedException - the user is not authorized to maintain types
      • validateUserForTypeCreate

        void validateUserForTypeCreate​(java.lang.String userId,
                                       java.lang.String metadataCollectionName,
                                       org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.AttributeTypeDef attributeTypeDef)
                                throws UserNotAuthorizedException
        Tests for whether a specific user should have the right to create a type within a repository.
        Parameters:
        userId - identifier of user
        metadataCollectionName - configurable name of the metadata collection
        attributeTypeDef - type details
        Throws:
        UserNotAuthorizedException - the user is not authorized to maintain types
      • validateUserForTypeRead

        void validateUserForTypeRead​(java.lang.String userId,
                                     java.lang.String metadataCollectionName,
                                     org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDef typeDef)
                              throws UserNotAuthorizedException
        Tests for whether a specific user should have read access to a specific type within a repository.
        Parameters:
        userId - identifier of user
        metadataCollectionName - configurable name of the metadata collection
        typeDef - type details
        Throws:
        UserNotAuthorizedException - the user is not authorized to retrieve types
      • validateUserForTypeRead

        void validateUserForTypeRead​(java.lang.String userId,
                                     java.lang.String metadataCollectionName,
                                     org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.AttributeTypeDef attributeTypeDef)
                              throws UserNotAuthorizedException
        Tests for whether a specific user should have read access to a specific type within a repository.
        Parameters:
        userId - identifier of user
        metadataCollectionName - configurable name of the metadata collection
        attributeTypeDef - type details
        Throws:
        UserNotAuthorizedException - the user is not authorized to retrieve types
      • validateUserForTypeUpdate

        void validateUserForTypeUpdate​(java.lang.String userId,
                                       java.lang.String metadataCollectionName,
                                       org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDef typeDef,
                                       org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefPatch patch)
                                throws UserNotAuthorizedException
        Tests for whether a specific user should have the right to update a type within a repository.
        Parameters:
        userId - identifier of user
        metadataCollectionName - configurable name of the metadata collection
        typeDef - current type details
        patch - proposed changes to type
        Throws:
        UserNotAuthorizedException - the user is not authorized to maintain types
      • validateUserForTypeDelete

        void validateUserForTypeDelete​(java.lang.String userId,
                                       java.lang.String metadataCollectionName,
                                       org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDef typeDef)
                                throws UserNotAuthorizedException
        Tests for whether a specific user should have the right to delete a type within a repository.
        Parameters:
        userId - identifier of user
        metadataCollectionName - configurable name of the metadata collection
        typeDef - type details
        Throws:
        UserNotAuthorizedException - the user is not authorized to maintain types
      • validateUserForTypeDelete

        void validateUserForTypeDelete​(java.lang.String userId,
                                       java.lang.String metadataCollectionName,
                                       org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.AttributeTypeDef attributeTypeDef)
                                throws UserNotAuthorizedException
        Tests for whether a specific user should have the right to delete a type within a repository.
        Parameters:
        userId - identifier of user
        metadataCollectionName - configurable name of the metadata collection
        attributeTypeDef - type details
        Throws:
        UserNotAuthorizedException - the user is not authorized to maintain types
      • validateUserForTypeReIdentify

        void validateUserForTypeReIdentify​(java.lang.String userId,
                                           java.lang.String metadataCollectionName,
                                           org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDef originalTypeDef,
                                           java.lang.String newTypeDefGUID,
                                           java.lang.String newTypeDefName)
                                    throws UserNotAuthorizedException
        Tests for whether a specific user should have the right to change the identifiers for a type within a repository.
        Parameters:
        userId - identifier of user
        metadataCollectionName - configurable name of the metadata collection
        originalTypeDef - type details
        newTypeDefGUID - the new identifier for the type.
        newTypeDefName - new name for this type.
        Throws:
        UserNotAuthorizedException - the user is not authorized to maintain types
      • validateUserForTypeReIdentify

        void validateUserForTypeReIdentify​(java.lang.String userId,
                                           java.lang.String metadataCollectionName,
                                           org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.AttributeTypeDef originalAttributeTypeDef,
                                           java.lang.String newTypeDefGUID,
                                           java.lang.String newTypeDefName)
                                    throws UserNotAuthorizedException
        Tests for whether a specific user should have the right to change the identifiers for a type within a repository.
        Parameters:
        userId - identifier of user
        metadataCollectionName - configurable name of the metadata collection
        originalAttributeTypeDef - type details
        newTypeDefGUID - the new identifier for the type.
        newTypeDefName - new name for this type.
        Throws:
        UserNotAuthorizedException - the user is not authorized to maintain types
      • validateUserForEntityCreate

        void validateUserForEntityCreate​(java.lang.String userId,
                                         java.lang.String metadataCollectionName,
                                         java.lang.String entityTypeGUID,
                                         org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties initialProperties,
                                         java.util.List<org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.Classification> initialClassifications,
                                         org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceStatus initialStatus)
                                  throws UserNotAuthorizedException
        Tests for whether a specific user should have the right to create a instance within a repository.
        Parameters:
        userId - identifier of user
        metadataCollectionName - configurable name of the metadata collection
        entityTypeGUID - unique identifier (guid) for the new entity's type.
        initialProperties - initial list of properties for the new entity null means no properties.
        initialClassifications - initial list of classifications for the new entity null means no classifications.
        initialStatus - initial status typically DRAFT, PREPARED or ACTIVE.
        Throws:
        UserNotAuthorizedException - the user is not authorized to maintain instances
      • validateUserForEntityRead

        org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityDetail validateUserForEntityRead​(java.lang.String userId,
                                                                                                                                                       java.lang.String metadataCollectionName,
                                                                                                                                                       org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityDetail instance)
                                                                                                                                                throws UserNotAuthorizedException
        Tests for whether a specific user should have read access to a specific instance within a repository.
        Parameters:
        userId - identifier of user
        metadataCollectionName - configurable name of the metadata collection
        instance - instance details
        Returns:
        entity to return (may be altered by the connector)
        Throws:
        UserNotAuthorizedException - the user is not authorized to retrieve instances
      • validateUserForEntitySummaryRead

        void validateUserForEntitySummaryRead​(java.lang.String userId,
                                              java.lang.String metadataCollectionName,
                                              org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntitySummary instance)
                                       throws UserNotAuthorizedException
        Tests for whether a specific user should have read access to a specific instance within a repository.
        Parameters:
        userId - identifier of user
        metadataCollectionName - configurable name of the metadata collection
        instance - instance details
        Throws:
        UserNotAuthorizedException - the user is not authorized to retrieve instances
      • validateUserForEntityProxyRead

        void validateUserForEntityProxyRead​(java.lang.String userId,
                                            java.lang.String metadataCollectionName,
                                            org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityProxy instance)
                                     throws UserNotAuthorizedException
        Tests for whether a specific user should have read access to a specific instance within a repository.
        Parameters:
        userId - identifier of user
        metadataCollectionName - configurable name of the metadata collection
        instance - instance details
        Throws:
        UserNotAuthorizedException - the user is not authorized to retrieve instances
      • validateUserForEntityUpdate

        void validateUserForEntityUpdate​(java.lang.String userId,
                                         java.lang.String metadataCollectionName,
                                         org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityDetail instance)
                                  throws UserNotAuthorizedException
        Tests for whether a specific user should have the right to update a instance within a repository.
        Parameters:
        userId - identifier of user
        metadataCollectionName - configurable name of the metadata collection
        instance - instance details
        Throws:
        UserNotAuthorizedException - the user is not authorized to maintain instances
      • validateUserForEntityClassificationAdd

        void validateUserForEntityClassificationAdd​(java.lang.String userId,
                                                    java.lang.String metadataCollectionName,
                                                    org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntitySummary instance,
                                                    java.lang.String classificationName,
                                                    org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties)
                                             throws UserNotAuthorizedException
        Tests for whether a specific user should have the right to add a classification to an entity instance within a repository.
        Parameters:
        userId - identifier of user
        metadataCollectionName - configurable name of the metadata collection
        instance - instance details
        classificationName - String name for the classification.
        properties - list of properties for the classification.
        Throws:
        UserNotAuthorizedException - the user is not authorized to maintain instances
      • validateUserForEntityClassificationUpdate

        void validateUserForEntityClassificationUpdate​(java.lang.String userId,
                                                       java.lang.String metadataCollectionName,
                                                       org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntitySummary instance,
                                                       java.lang.String classificationName,
                                                       org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties)
                                                throws UserNotAuthorizedException
        Tests for whether a specific user should have the right to update a classification for an entity instance within a repository.
        Parameters:
        userId - identifier of user
        metadataCollectionName - configurable name of the metadata collection
        instance - instance details
        classificationName - String name for the classification.
        properties - list of properties for the classification.
        Throws:
        UserNotAuthorizedException - the user is not authorized to maintain instances
      • validateUserForEntityClassificationDelete

        void validateUserForEntityClassificationDelete​(java.lang.String userId,
                                                       java.lang.String metadataCollectionName,
                                                       org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntitySummary instance,
                                                       java.lang.String classificationName)
                                                throws UserNotAuthorizedException
        Tests for whether a specific user should have the right to delete a classification from an entity instance within a repository.
        Parameters:
        userId - identifier of user
        metadataCollectionName - configurable name of the metadata collection
        instance - instance details
        classificationName - String name for the classification.
        Throws:
        UserNotAuthorizedException - the user is not authorized to maintain instances
      • validateUserForEntityDelete

        void validateUserForEntityDelete​(java.lang.String userId,
                                         java.lang.String metadataCollectionName,
                                         org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityDetail instance)
                                  throws UserNotAuthorizedException
        Tests for whether a specific user should have the right to delete a instance within a repository.
        Parameters:
        userId - identifier of user
        metadataCollectionName - configurable name of the metadata collection
        instance - instance details
        Throws:
        UserNotAuthorizedException - the user is not authorized to maintain instances
      • validateUserForEntityRestore

        void validateUserForEntityRestore​(java.lang.String userId,
                                          java.lang.String metadataCollectionName,
                                          java.lang.String deletedEntityGUID)
                                   throws UserNotAuthorizedException
        Tests for whether a specific user should have the right to restore a instance within a repository.
        Parameters:
        userId - identifier of user
        metadataCollectionName - configurable name of the metadata collection
        deletedEntityGUID - String unique identifier (guid) for the entity.
        Throws:
        UserNotAuthorizedException - the user is not authorized to maintain instances
      • validateUserForEntityReIdentification

        void validateUserForEntityReIdentification​(java.lang.String userId,
                                                   java.lang.String metadataCollectionName,
                                                   org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityDetail instance,
                                                   java.lang.String newGUID)
                                            throws UserNotAuthorizedException
        Tests for whether a specific user should have the right to change the guid on a instance within a repository.
        Parameters:
        userId - identifier of user
        metadataCollectionName - configurable name of the metadata collection
        instance - instance details
        newGUID - the new guid for the instance.
        Throws:
        UserNotAuthorizedException - the user is not authorized to maintain instances
      • validateUserForEntityReTyping

        void validateUserForEntityReTyping​(java.lang.String userId,
                                           java.lang.String metadataCollectionName,
                                           org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityDetail instance,
                                           org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefSummary newTypeDefSummary)
                                    throws UserNotAuthorizedException
        Tests for whether a specific user should have the right to change the type of a instance within a repository.
        Parameters:
        userId - identifier of user
        metadataCollectionName - configurable name of the metadata collection
        instance - instance details
        newTypeDefSummary - details of this instance's new TypeDef.
        Throws:
        UserNotAuthorizedException - the user is not authorized to maintain instances
      • validateUserForEntityReHoming

        void validateUserForEntityReHoming​(java.lang.String userId,
                                           java.lang.String metadataCollectionName,
                                           org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityDetail instance,
                                           java.lang.String newHomeMetadataCollectionId,
                                           java.lang.String newHomeMetadataCollectionName)
                                    throws UserNotAuthorizedException
        Tests for whether a specific user should have the right to change the home of a instance within a repository.
        Parameters:
        userId - identifier of user
        metadataCollectionName - configurable name of the metadata collection
        instance - instance details
        newHomeMetadataCollectionId - unique identifier for the new home metadata collection/repository.
        newHomeMetadataCollectionName - display name for the new home metadata collection/repository.
        Throws:
        UserNotAuthorizedException - the user is not authorized to maintain instances
      • validateUserForRelationshipCreate

        void validateUserForRelationshipCreate​(java.lang.String userId,
                                               java.lang.String metadataCollectionName,
                                               java.lang.String relationshipTypeGUID,
                                               org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties initialProperties,
                                               org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntitySummary entityOneSummary,
                                               org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntitySummary entityTwoSummary,
                                               org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceStatus initialStatus)
                                        throws UserNotAuthorizedException
        Tests for whether a specific user should have the right to create a instance within a repository.
        Parameters:
        userId - identifier of user
        metadataCollectionName - configurable name of the metadata collection
        relationshipTypeGUID - unique identifier (guid) for the new relationship's type.
        initialProperties - initial list of properties for the new entity null means no properties.
        entityOneSummary - the unique identifier of one of the entities that the relationship is connecting together.
        entityTwoSummary - the unique identifier of the other entity that the relationship is connecting together.
        initialStatus - initial status typically DRAFT, PREPARED or ACTIVE.
        Throws:
        UserNotAuthorizedException - the user is not authorized to maintain instances
      • validateUserForRelationshipRead

        org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.Relationship validateUserForRelationshipRead​(java.lang.String userId,
                                                                                                                                                             java.lang.String metadataCollectionName,
                                                                                                                                                             org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.Relationship instance)
                                                                                                                                                      throws UserNotAuthorizedException
        Tests for whether a specific user should have read access to a specific instance within a repository.
        Parameters:
        userId - identifier of user
        metadataCollectionName - configurable name of the metadata collection
        instance - instance details
        Returns:
        relationship to return (may be altered by the connector)
        Throws:
        UserNotAuthorizedException - the user is not authorized to retrieve instances
      • validateUserForRelationshipUpdate

        void validateUserForRelationshipUpdate​(java.lang.String userId,
                                               java.lang.String metadataCollectionName,
                                               org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.Relationship instance)
                                        throws UserNotAuthorizedException
        Tests for whether a specific user should have the right to update a instance within a repository.
        Parameters:
        userId - identifier of user
        metadataCollectionName - configurable name of the metadata collection
        instance - instance details
        Throws:
        UserNotAuthorizedException - the user is not authorized to maintain instances
      • validateUserForRelationshipDelete

        void validateUserForRelationshipDelete​(java.lang.String userId,
                                               java.lang.String metadataCollectionName,
                                               org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.Relationship instance)
                                        throws UserNotAuthorizedException
        Tests for whether a specific user should have the right to delete a instance within a repository.
        Parameters:
        userId - identifier of user
        metadataCollectionName - configurable name of the metadata collection
        instance - instance details
        Throws:
        UserNotAuthorizedException - the user is not authorized to maintain instances
      • validateUserForRelationshipRestore

        void validateUserForRelationshipRestore​(java.lang.String userId,
                                                java.lang.String metadataCollectionName,
                                                java.lang.String deletedRelationshipGUID)
                                         throws UserNotAuthorizedException
        Tests for whether a specific user should have the right to restore a instance within a repository.
        Parameters:
        userId - identifier of user
        metadataCollectionName - configurable name of the metadata collection
        deletedRelationshipGUID - String unique identifier (guid) for the relationship.
        Throws:
        UserNotAuthorizedException - the user is not authorized to maintain instances
      • validateUserForRelationshipReIdentification

        void validateUserForRelationshipReIdentification​(java.lang.String userId,
                                                         java.lang.String metadataCollectionName,
                                                         org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.Relationship instance,
                                                         java.lang.String newGUID)
                                                  throws UserNotAuthorizedException
        Tests for whether a specific user should have the right to change the guid on a instance within a repository.
        Parameters:
        userId - identifier of user
        metadataCollectionName - configurable name of the metadata collection
        instance - instance details
        newGUID - the new guid for the instance.
        Throws:
        UserNotAuthorizedException - the user is not authorized to maintain instances
      • validateUserForRelationshipReTyping

        void validateUserForRelationshipReTyping​(java.lang.String userId,
                                                 java.lang.String metadataCollectionName,
                                                 org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.Relationship instance,
                                                 org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefSummary newTypeDefSummary)
                                          throws UserNotAuthorizedException
        Tests for whether a specific user should have the right to change the type of a instance within a repository.
        Parameters:
        userId - identifier of user
        metadataCollectionName - configurable name of the metadata collection
        instance - instance details
        newTypeDefSummary - details of this instance's new TypeDef.
        Throws:
        UserNotAuthorizedException - the user is not authorized to maintain instances
      • validateUserForRelationshipReHoming

        void validateUserForRelationshipReHoming​(java.lang.String userId,
                                                 java.lang.String metadataCollectionName,
                                                 org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.Relationship instance,
                                                 java.lang.String newHomeMetadataCollectionId,
                                                 java.lang.String newHomeMetadataCollectionName)
                                          throws UserNotAuthorizedException
        Tests for whether a specific user should have the right to change the home of a instance within a repository.
        Parameters:
        userId - identifier of user
        metadataCollectionName - configurable name of the metadata collection
        instance - instance details
        newHomeMetadataCollectionId - unique identifier for the new home metadata collection/repository.
        newHomeMetadataCollectionName - display name for the new home metadata collection/repository.
        Throws:
        UserNotAuthorizedException - the user is not authorized to maintain instances
      • validateEntityReferenceCopySave

        boolean validateEntityReferenceCopySave​(org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityDetail instance)
        Tests for whether a reference copy should be saved to the repository.
        Parameters:
        instance - instance details
        Returns:
        flag indicating whether the reference copy should be saved
      • validateRelationshipReferenceCopySave

        boolean validateRelationshipReferenceCopySave​(org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.Relationship instance)
        Tests for whether a reference copy should be saved to the repository.
        Parameters:
        instance - instance details
        Returns:
        flag indicating whether the reference copy should be saved