Package org.odpi.openmetadata.metadatasecurity.server

Class OpenMetadataServerSecurityVerifier

java.lang.Object

org.odpi.openmetadata.metadatasecurity.server.OpenMetadataServerSecurityVerifier

All Implemented Interfaces:

OpenMetadataElementSecurity, OpenMetadataRepositorySecurity, OpenMetadataServerSecurity, OpenMetadataServiceSecurity, OpenMetadataEventsSecurity

public class OpenMetadataServerSecurityVerifier
extends Object
implements OpenMetadataRepositorySecurity, OpenMetadataEventsSecurity, OpenMetadataElementSecurity, OpenMetadataServerSecurity, OpenMetadataServiceSecurity

OpenMetadataServerSecurityVerifier provides the plug-in point for the open metadata server connector. It supports the same security interfaces, and handles the fact that the security connector is optional.

Constructor Summary

Constructors

Constructor	Description
OpenMetadataServerSecurityVerifier()	Default constructor

Method Summary

Modifier and Type	Method	Description
List<String>	getVisibleZones(String userId)	Return the list of visible zones for this user.
void	registerSecurityValidator(String localServerUserId, String serverName, AuditLog auditLog, Connection connection)	Register an open metadata server security connector to verify access to the server's services.
EntityDetail	selectConnection(String userId, EntityDetail assetEntity, List<EntityDetail> connectionEntities, OMRSRepositoryHelper repositoryHelper, String serviceName, String methodName)	Use the security connector to make a choice on which connection to supply to the requesting user.
boolean	validateEntityReferenceCopySave(String userId, EntityDetail instance)	Tests for whether a reference copy should be saved to the repository.
OMRSInstanceEvent	validateInboundEvent(String cohortName, OMRSInstanceEvent event)	Validate whether an event received from another member of the cohort should be processed by this server.
OMRSInstanceEvent	validateOutboundEvent(String cohortName, OMRSInstanceEvent event)	Validate whether an event should be sent to the other members of the cohort by this server.
boolean	validateRelationshipReferenceCopySave(String userId, Relationship instance)	Tests for whether a reference copy should be saved to the repository.
void	validateUserAsServerAdmin(String userId)	Check that the calling user is authorized to update the configuration for a server.
void	validateUserAsServerInvestigator(String userId)	Check that the calling user is authorized to issue operator requests to the OMAG Server.
void	validateUserAsServerOperator(String userId)	Check that the calling user is authorized to issue operator requests to the OMAG Server.
void	validateUserForAnchorAddFeedback(String userId, EntityDetail anchorEntity, EntityDetail feedbackEntity, OMRSRepositoryHelper repositoryHelper, String serviceName, String methodName)	Tests for whether a specific user should have the right to attach feedback - such as comments, ratings, tags and likes, to the anchor or member element.
void	validateUserForAnchorAttach(String userId, EntityDetail anchorEntity, EntityDetail attachingEntity, String relationshipName, OMRSRepositoryHelper repositoryHelper, String serviceName, String methodName)	Tests for whether a specific user should have the right to link unanchored elements
void	validateUserForAnchorClassify(String userId, EntityDetail anchorEntity, String classificationName, OMRSRepositoryHelper repositoryHelper, String serviceName, String methodName)	Tests for whether a specific user should have the right to add or update a classification on this anchor or member element.
void	validateUserForAnchorDeclassify(String userId, EntityDetail anchorEntity, String classificationName, OMRSRepositoryHelper repositoryHelper, String serviceName, String methodName)	Tests for whether a specific user should have the right to remove a classification from this anchor or member element
void	validateUserForAnchorDeleteFeedback(String userId, EntityDetail anchorEntity, EntityDetail feedbackEntity, OMRSRepositoryHelper repositoryHelper, String serviceName, String methodName)	Tests for whether a specific user should have the right to detach feedback - such as comments, ratings, tags and likes, to the anchor or member element.
void	validateUserForAnchorDetach(String userId, EntityDetail anchorEntity, EntityDetail detachingEntity, String relationshipName, OMRSRepositoryHelper repositoryHelper, String serviceName, String methodName)	Tests for whether a specific user should have the right to link unanchored elements
void	validateUserForAnchorMemberAdd(String userId, EntityDetail anchorEntity, EntityDetail newMemberEntity, String relationshipName, OMRSRepositoryHelper repositoryHelper, String serviceName, String methodName)	Tests for whether a specific user should have the right to attach feedback - such as comments, ratings, tags and likes, to the element.
void	validateUserForAnchorMemberDelete(String userId, EntityDetail anchorEntity, EntityDetail obsoleteEntity, OMRSRepositoryHelper repositoryHelper, String serviceName, String methodName)	Tests for whether a specific user should have the right to delete an element and all of its contents.
void	validateUserForAnchorMemberRead(String userId, EntityDetail anchorEntity, EntityDetail requestedEntity, OMRSRepositoryHelper repositoryHelper, String serviceName, String methodName)	Tests for whether a specific user should have read access to a specific element and its contents.
void	validateUserForAnchorMemberStatusUpdate(String userId, EntityDetail anchorEntity, EntityDetail originalEntity, InstanceStatus newStatus, OMRSRepositoryHelper repositoryHelper, String serviceName, String methodName)	Tests for whether a specific user should have the right to update the instance status of an element.
void	validateUserForAnchorMemberUpdate(String userId, EntityDetail anchorEntity, OMRSRepositoryHelper repositoryHelper, String serviceName, String methodName)	Tests for whether a specific user should have the right to update elements attached directly to an anchor such as glossary terms and categories attached to an element.
void	validateUserForElementAddFeedback(String userId, EntityDetail originalEntity, EntityDetail feedbackEntity, OMRSRepositoryHelper repositoryHelper, String serviceName, String methodName)	Tests for whether a specific user should have the right to attach feedback - such as comments, ratings, tags and likes, to the element.
void	validateUserForElementAttach(String userId, EntityDetail startingEntity, EntityDetail attachingEntity, String relationshipName, OMRSRepositoryHelper repositoryHelper, String serviceName, String methodName)	Tests for whether a specific user should have the right to link unanchored elements to this element
void	validateUserForElementClassify(String userId, EntityDetail originalEntity, String classificationName, OMRSRepositoryHelper repositoryHelper, String serviceName, String methodName)	Tests for whether a specific user should have the right to add or update a classification on this element.
void	validateUserForElementCreate(String userId, String entityTypeGUID, String entityTypeName, InstanceProperties newProperties, List<Classification> classifications, InstanceStatus instanceStatus, OMRSRepositoryHelper repositoryHelper, String serviceName, String methodName)	Tests for whether a specific user should have the right to create an element.
void	validateUserForElementDeclassify(String userId, EntityDetail originalEntity, String classificationName, OMRSRepositoryHelper repositoryHelper, String serviceName, String methodName)	Tests for whether a specific user should have the right to remove a classification from this element
void	validateUserForElementDelete(String userId, EntityDetail entity, OMRSRepositoryHelper repositoryHelper, String serviceName, String methodName)	Tests for whether a specific user should have the right to delete an element and all of its contents.
void	validateUserForElementDeleteFeedback(String userId, EntityDetail originalEntity, EntityDetail feedbackEntity, OMRSRepositoryHelper repositoryHelper, String serviceName, String methodName)	Tests for whether a specific user should have the right to detach feedback - such as comments, ratings, tags and likes, to the element.
void	validateUserForElementDetach(String userId, EntityDetail startingEntity, EntityDetail detachingEntity, String relationshipName, OMRSRepositoryHelper repositoryHelper, String serviceName, String methodName)	Tests for whether a specific user should have the right to link unanchored elements to this element
void	validateUserForElementDetailUpdate(String userId, EntityDetail originalEntity, InstanceProperties newEntityProperties, OMRSRepositoryHelper repositoryHelper, String serviceName, String methodName)	Tests for whether a specific user should have the right to update the properties of an element.
void	validateUserForElementRead(String userId, EntityDetail requestedEntity, OMRSRepositoryHelper repositoryHelper, String serviceName, String methodName)	Tests for whether a specific user should have read access to a specific element and its contents.
void	validateUserForElementStatusUpdate(String userId, EntityDetail originalEntity, InstanceStatus newStatus, OMRSRepositoryHelper repositoryHelper, String serviceName, String methodName)	Tests for whether a specific user should have the right to update the properties of an element.
void	validateUserForEntityClassificationAdd(String userId, String metadataCollectionName, EntitySummary instance, String classificationName, 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(String userId, String metadataCollectionName, EntitySummary instance, 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(String userId, String metadataCollectionName, EntitySummary instance, String classificationName, InstanceProperties properties)	Tests for whether a specific user should have the right to update the classification for an entity instance within a repository.
void	validateUserForEntityCreate(String userId, String metadataCollectionName, String entityTypeGUID, InstanceProperties initialProperties, List<Classification> initialClassifications, InstanceStatus initialStatus)	Tests for whether a specific user should have the right to create an instance within a repository.
void	validateUserForEntityDelete(String userId, String metadataCollectionName, EntityDetail instance)	Tests for whether a specific user should have the right to delete an instance within a repository.
void	validateUserForEntityProxyRead(String userId, String metadataCollectionName, EntityProxy instance)	Tests for whether a specific user should have read access to a specific instance within a repository.
EntityDetail	validateUserForEntityRead(String userId, String metadataCollectionName, EntityDetail instance)	Tests for whether a specific user should have read access to a specific instance within a repository.
void	validateUserForEntityReHoming(String userId, String metadataCollectionName, EntityDetail instance, String newHomeMetadataCollectionId, String newHomeMetadataCollectionName)	Tests for whether a specific user should have the right to change the home of an instance within a repository.
void	validateUserForEntityReIdentification(String userId, String metadataCollectionName, EntityDetail instance, String newGUID)	Tests for whether a specific user should have the right to change the guid on an instance within a repository.
void	validateUserForEntityRestore(String userId, String metadataCollectionName, String deletedEntityGUID)	Tests for whether a specific user should have the right to delete an instance within a repository.
void	validateUserForEntityReTyping(String userId, String metadataCollectionName, EntityDetail instance, TypeDefSummary newTypeDefSummary)	Tests for whether a specific user should have the right to change an instance's type within a repository.
void	validateUserForEntitySummaryRead(String userId, String metadataCollectionName, EntitySummary instance)	Tests for whether a specific user should have read access to a specific instance within a repository.
void	validateUserForEntityUpdate(String userId, String metadataCollectionName, EntityDetail instance)	Tests for whether a specific user should have the right to update an instance within a repository.
void	validateUserForRelationshipCreate(String userId, String metadataCollectionName, String relationshipTypeGUID, InstanceProperties initialProperties, EntitySummary entityOneSummary, EntitySummary entityTwoSummary, InstanceStatus initialStatus)	Tests for whether a specific user should have the right to create an instance within a repository.
void	validateUserForRelationshipDelete(String userId, String metadataCollectionName, Relationship instance)	Tests for whether a specific user should have the right to delete an instance within a repository.
Relationship	validateUserForRelationshipRead(String userId, String metadataCollectionName, Relationship instance)	Tests for whether a specific user should have read access to a specific instance within a repository.
void	validateUserForRelationshipReHoming(String userId, String metadataCollectionName, Relationship instance, String newHomeMetadataCollectionId, String newHomeMetadataCollectionName)	Tests for whether a specific user should have the right to change the home of an instance within a repository.
void	validateUserForRelationshipReIdentification(String userId, String metadataCollectionName, Relationship instance, String newGUID)	Tests for whether a specific user should have the right to change the guid on an instance within a repository.
void	validateUserForRelationshipRestore(String userId, String metadataCollectionName, String deletedRelationshipGUID)	Tests for whether a specific user should have the right to delete an instance within a repository.
void	validateUserForRelationshipReTyping(String userId, String metadataCollectionName, Relationship instance, TypeDefSummary newTypeDefSummary)	Tests for whether a specific user should have the right to change an instance's type within a repository.
void	validateUserForRelationshipUpdate(String userId, String metadataCollectionName, Relationship instance)	Tests for whether a specific user should have the right to update an instance within a repository.
void	validateUserForServer(String userId)	Check that the calling user is authorized to issue a (any) request to the OMAG Server Platform.
void	validateUserForService(String userId, String serviceName)	Check that the calling user is authorized to issue this request.
void	validateUserForServiceOperation(String userId, String serviceName, String serviceOperationName)	Check that the calling user is authorized to issue this specific request.
void	validateUserForTypeCreate(String userId, String metadataCollectionName, AttributeTypeDef attributeTypeDef)	Tests for whether a specific user should have the right to create a type within a repository.
void	validateUserForTypeCreate(String userId, String metadataCollectionName, TypeDef typeDef)	Tests for whether a specific user should have the right to create a type within a repository.
void	validateUserForTypeDelete(String userId, String metadataCollectionName, AttributeTypeDef attributeTypeDef)	Tests for whether a specific user should have the right to delete a type within a repository.
void	validateUserForTypeDelete(String userId, String metadataCollectionName, TypeDef typeDef)	Tests for whether a specific user should have the right to delete a type within a repository.
void	validateUserForTypeRead(String userId, String metadataCollectionName, AttributeTypeDef attributeTypeDef)	Tests for whether a specific user should have read access to a specific type within a repository.
void	validateUserForTypeRead(String userId, String metadataCollectionName, TypeDef typeDef)	Tests for whether a specific user should have read access to a specific type within a repository.
void	validateUserForTypeReIdentify(String userId, String metadataCollectionName, AttributeTypeDef originalAttributeTypeDef, String newTypeDefGUID, String newTypeDefName)	Tests for whether a specific user should have the right to change the identifiers for a type within a repository.
void	validateUserForTypeReIdentify(String userId, String metadataCollectionName, TypeDef originalTypeDef, String newTypeDefGUID, String newTypeDefName)	Tests for whether a specific user should have the right to change the identifiers for a type within a repository.
void	validateUserForTypeUpdate(String userId, String metadataCollectionName, TypeDef typeDef, TypeDefPatch patch)	Tests for whether a specific user should have the right to update a type within a repository.

Methods inherited from class java.lang.Object

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

Constructor Details

OpenMetadataServerSecurityVerifier

public OpenMetadataServerSecurityVerifier()

Default constructor

Method Details

registerSecurityValidator

public void registerSecurityValidator(String localServerUserId,
 String serverName,
 AuditLog auditLog,
 Connection connection)
                               throws InvalidParameterException

Register an open metadata server security connector to verify access to the server's services.

Parameters:

localServerUserId - local server's userId

serverName - local server's name

auditLog - logging destination

connection - properties used to create the connector

Throws:

InvalidParameterException - the connection is invalid

getVisibleZones

public List<String> getVisibleZones(String userId)
                             throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Return the list of visible zones for this user.

Parameters:

userId - calling user

Returns:

list of zone names

Throws:

InvalidParameterException - invalid parameter

PropertyServerException - problem from the verifier

UserNotAuthorizedException - user not recognized

validateUserForServer

public void validateUserForServer(String userId)
                           throws UserNotAuthorizedException

Check that the calling user is authorized to issue a (any) request to the OMAG Server Platform.

Specified by:

validateUserForServer in interface OpenMetadataServerSecurity

Parameters:

userId - calling user

Throws:

UserNotAuthorizedException - the user is not authorized to access this function

validateUserAsServerAdmin

public void validateUserAsServerAdmin(String userId)
                               throws UserNotAuthorizedException

Check that the calling user is authorized to update the configuration for a server.

Specified by:

validateUserAsServerAdmin in interface OpenMetadataServerSecurity

Parameters:

userId - calling user

Throws:

UserNotAuthorizedException - the user is not authorized to change configuration

validateUserAsServerOperator

public void validateUserAsServerOperator(String userId)
                                  throws UserNotAuthorizedException

Check that the calling user is authorized to issue operator requests to the OMAG Server.

Specified by:

validateUserAsServerOperator in interface OpenMetadataServerSecurity

Parameters:

userId - calling user

Throws:

UserNotAuthorizedException - the user is not authorized to issue operator commands to this server

validateUserAsServerInvestigator

public void validateUserAsServerInvestigator(String userId)
                                      throws UserNotAuthorizedException

Check that the calling user is authorized to issue operator requests to the OMAG Server.

Specified by:

validateUserAsServerInvestigator in interface OpenMetadataServerSecurity

Parameters:

userId - calling user

Throws:

UserNotAuthorizedException - the user is not authorized to issue diagnostic commands to this server

validateUserForService

public void validateUserForService(String userId,
 String serviceName)
                            throws UserNotAuthorizedException

Check that the calling user is authorized to issue this request.

Specified by:

validateUserForService in interface OpenMetadataServiceSecurity

Parameters:

userId - calling user

serviceName - name of called service

Throws:

UserNotAuthorizedException - the user is not authorized to access this service

validateUserForServiceOperation

public void validateUserForServiceOperation(String userId,
 String serviceName,
 String serviceOperationName)
                                     throws UserNotAuthorizedException

Check that the calling user is authorized to issue this specific request.

Specified by:

validateUserForServiceOperation in interface OpenMetadataServiceSecurity

Parameters:

userId - calling user

serviceName - name of called service

serviceOperationName - name of called operation

Throws:

UserNotAuthorizedException - the user is not authorized to access this service

selectConnection

public EntityDetail selectConnection(String userId,
 EntityDetail assetEntity,
 List<EntityDetail> connectionEntities,
 OMRSRepositoryHelper repositoryHelper,
 String serviceName,
 String methodName)
                              throws UserNotAuthorizedException

Use the security connector to make a choice on which connection to supply to the requesting user.

Specified by:

selectConnection in interface OpenMetadataElementSecurity

Parameters:

userId - calling userId

assetEntity - associated asset - may be null

connectionEntities - list of retrieved connections

repositoryHelper - for working with OMRS objects

serviceName - calling service

methodName - calling method

Returns:

single connection entity, or null

Throws:

UserNotAuthorizedException - the user is not able to use any of the connections

validateUserForElementCreate

public void validateUserForElementCreate(String userId,
 String entityTypeGUID,
 String entityTypeName,
 InstanceProperties newProperties,
 List<Classification> classifications,
 InstanceStatus instanceStatus,
 OMRSRepositoryHelper repositoryHelper,
 String serviceName,
 String methodName)
                                  throws UserNotAuthorizedException,
InvalidParameterException,
PropertyServerException

Tests for whether a specific user should have the right to create an element.

Specified by:

validateUserForElementCreate in interface OpenMetadataElementSecurity

Parameters:

userId - identifier of user

entityTypeGUID - unique identifier of the type of entity to create

entityTypeName - unique name of the type of entity to create

newProperties - properties for new entity

classifications - classifications for new entity

instanceStatus - status for new entity

repositoryHelper - manipulates repository service objects

serviceName - calling service

methodName - calling method

Throws:

UserNotAuthorizedException - the user is not authorized to perform this command

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - there is a problem retrieving information from the property server(s).

validateUserForElementRead

public void validateUserForElementRead(String userId,
 EntityDetail requestedEntity,
 OMRSRepositoryHelper repositoryHelper,
 String serviceName,
 String methodName)
                                throws UserNotAuthorizedException,
InvalidParameterException,
PropertyServerException

Tests for whether a specific user should have read access to a specific element and its contents.

Specified by:

validateUserForElementRead in interface OpenMetadataElementSecurity

Parameters:

userId - calling user

requestedEntity - entity requested by the caller

repositoryHelper - helper for OMRS objects

serviceName - calling service

methodName - calling method

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - there is a problem retrieving information from the property server(s).

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

validateUserForAnchorMemberRead

public void validateUserForAnchorMemberRead(String userId,
 EntityDetail anchorEntity,
 EntityDetail requestedEntity,
 OMRSRepositoryHelper repositoryHelper,
 String serviceName,
 String methodName)
                                     throws UserNotAuthorizedException

Tests for whether a specific user should have read access to a specific element and its contents.

Specified by:

validateUserForAnchorMemberRead in interface OpenMetadataElementSecurity

Parameters:

userId - calling user

anchorEntity - entity for the anchor (if extracted - may be null)

requestedEntity - entity requested by the caller

repositoryHelper - helper for OMRS objects

serviceName - calling service

methodName - calling method

Throws:

UserNotAuthorizedException - user not authorized to issue this request

validateUserForElementDetailUpdate

public void validateUserForElementDetailUpdate(String userId,
 EntityDetail originalEntity,
 InstanceProperties newEntityProperties,
 OMRSRepositoryHelper repositoryHelper,
 String serviceName,
 String methodName)
                                        throws UserNotAuthorizedException

Tests for whether a specific user should have the right to update the properties of an element.

Specified by:

validateUserForElementDetailUpdate in interface OpenMetadataElementSecurity

Parameters:

userId - identifier of user

originalEntity - original entity details

newEntityProperties - new properties

repositoryHelper - helper for OMRS objects

serviceName - calling service

methodName - calling method

Throws:

UserNotAuthorizedException - the user is not authorized to change this element

validateUserForAnchorMemberUpdate

public void validateUserForAnchorMemberUpdate(String userId,
 EntityDetail anchorEntity,
 OMRSRepositoryHelper repositoryHelper,
 String serviceName,
 String methodName)
                                       throws UserNotAuthorizedException

Tests for whether a specific user should have the right to update elements attached directly to an anchor such as glossary terms and categories attached to an element. These updates could be to their properties, classifications and relationships.

Specified by:

validateUserForAnchorMemberUpdate in interface OpenMetadataElementSecurity

Parameters:

userId - identifier of user

anchorEntity - element details

repositoryHelper - helper for OMRS objects

serviceName - calling service

methodName - calling method

Throws:

UserNotAuthorizedException - the user is not authorized to change this element

validateUserForElementStatusUpdate

public void validateUserForElementStatusUpdate(String userId,
 EntityDetail originalEntity,
 InstanceStatus newStatus,
 OMRSRepositoryHelper repositoryHelper,
 String serviceName,
 String methodName)
                                        throws UserNotAuthorizedException

Tests for whether a specific user should have the right to update the properties of an element.

Specified by:

validateUserForElementStatusUpdate in interface OpenMetadataElementSecurity

Parameters:

userId - identifier of user

originalEntity - original entity details

newStatus - new value for status

repositoryHelper - helper for OMRS objects

serviceName - calling service

methodName - calling method

Throws:

UserNotAuthorizedException - the user is not authorized to change this element

validateUserForElementAttach

public void validateUserForElementAttach(String userId,
 EntityDetail startingEntity,
 EntityDetail attachingEntity,
 String relationshipName,
 OMRSRepositoryHelper repositoryHelper,
 String serviceName,
 String methodName)
                                  throws UserNotAuthorizedException

Tests for whether a specific user should have the right to link unanchored elements to this element

Specified by:

validateUserForElementAttach in interface OpenMetadataElementSecurity

Parameters:

userId - identifier of user

startingEntity - end 1 details

attachingEntity - end 1 details

relationshipName - name of the relationship

repositoryHelper - helper for OMRS objects

serviceName - calling service

methodName - calling method

Throws:

UserNotAuthorizedException - the user is not authorized to change this element

validateUserForElementDetach

public void validateUserForElementDetach(String userId,
 EntityDetail startingEntity,
 EntityDetail detachingEntity,
 String relationshipName,
 OMRSRepositoryHelper repositoryHelper,
 String serviceName,
 String methodName)
                                  throws UserNotAuthorizedException

Tests for whether a specific user should have the right to link unanchored elements to this element

Specified by:

validateUserForElementDetach in interface OpenMetadataElementSecurity

Parameters:

userId - identifier of user

startingEntity - end 1 details

detachingEntity - end 2 details

relationshipName - name of the relationship

repositoryHelper - helper for OMRS objects

serviceName - calling service

methodName - calling method

Throws:

UserNotAuthorizedException - the user is not authorized to change this element

validateUserForElementAddFeedback

public void validateUserForElementAddFeedback(String userId,
 EntityDetail originalEntity,
 EntityDetail feedbackEntity,
 OMRSRepositoryHelper repositoryHelper,
 String serviceName,
 String methodName)
                                       throws UserNotAuthorizedException

Tests for whether a specific user should have the right to attach feedback - such as comments, ratings, tags and likes, to the element.

Specified by:

validateUserForElementAddFeedback in interface OpenMetadataElementSecurity

Parameters:

userId - identifier of user

originalEntity - original entity details

feedbackEntity - feedback element

repositoryHelper - helper for OMRS objects

serviceName - calling service

methodName - calling method

Throws:

UserNotAuthorizedException - the user is not authorized to change this element

validateUserForElementDeleteFeedback

public void validateUserForElementDeleteFeedback(String userId,
 EntityDetail originalEntity,
 EntityDetail feedbackEntity,
 OMRSRepositoryHelper repositoryHelper,
 String serviceName,
 String methodName)
                                          throws UserNotAuthorizedException

Tests for whether a specific user should have the right to detach feedback - such as comments, ratings, tags and likes, to the element.

Specified by:

validateUserForElementDeleteFeedback in interface OpenMetadataElementSecurity

Parameters:

userId - identifier of user

originalEntity - original entity details

feedbackEntity - feedback element

repositoryHelper - helper for OMRS objects

serviceName - calling service

methodName - calling method

Throws:

UserNotAuthorizedException - the user is not authorized to change this element

validateUserForElementClassify

public void validateUserForElementClassify(String userId,
 EntityDetail originalEntity,
 String classificationName,
 OMRSRepositoryHelper repositoryHelper,
 String serviceName,
 String methodName)
                                    throws UserNotAuthorizedException

Tests for whether a specific user should have the right to add or update a classification on this element.

Specified by:

validateUserForElementClassify in interface OpenMetadataElementSecurity

Parameters:

userId - identifier of user

originalEntity - original entity details

classificationName - name of the classification

repositoryHelper - helper for OMRS objects

serviceName - calling service

methodName - calling method

Throws:

UserNotAuthorizedException - the user is not authorized to change this element

validateUserForElementDeclassify

public void validateUserForElementDeclassify(String userId,
 EntityDetail originalEntity,
 String classificationName,
 OMRSRepositoryHelper repositoryHelper,
 String serviceName,
 String methodName)
                                      throws UserNotAuthorizedException

Tests for whether a specific user should have the right to remove a classification from this element

Specified by:

validateUserForElementDeclassify in interface OpenMetadataElementSecurity

Parameters:

userId - identifier of user

originalEntity - original entity details

classificationName - name of the classification

repositoryHelper - helper for OMRS objects

serviceName - calling service

methodName - calling method

Throws:

UserNotAuthorizedException - the user is not authorized to change this element

validateUserForAnchorMemberStatusUpdate

public void validateUserForAnchorMemberStatusUpdate(String userId,
 EntityDetail anchorEntity,
 EntityDetail originalEntity,
 InstanceStatus newStatus,
 OMRSRepositoryHelper repositoryHelper,
 String serviceName,
 String methodName)
                                             throws UserNotAuthorizedException

Tests for whether a specific user should have the right to update the instance status of an element.

Specified by:

validateUserForAnchorMemberStatusUpdate in interface OpenMetadataElementSecurity

Parameters:

userId - identifier of user

anchorEntity - anchor details

originalEntity - original entity details

newStatus - new value for status

repositoryHelper - helper for OMRS objects

serviceName - calling service

methodName - calling method

Throws:

UserNotAuthorizedException - the user is not authorized to change this element

validateUserForAnchorAttach

public void validateUserForAnchorAttach(String userId,
 EntityDetail anchorEntity,
 EntityDetail attachingEntity,
 String relationshipName,
 OMRSRepositoryHelper repositoryHelper,
 String serviceName,
 String methodName)
                                 throws UserNotAuthorizedException

Tests for whether a specific user should have the right to link unanchored elements

Specified by:

validateUserForAnchorAttach in interface OpenMetadataElementSecurity

Parameters:

userId - identifier of user

anchorEntity - anchor details

attachingEntity - new element

relationshipName - name of the relationship

repositoryHelper - helper for OMRS objects

serviceName - calling service

methodName - calling method

Throws:

UserNotAuthorizedException - the user is not authorized to change this element

validateUserForAnchorDetach

public void validateUserForAnchorDetach(String userId,
 EntityDetail anchorEntity,
 EntityDetail detachingEntity,
 String relationshipName,
 OMRSRepositoryHelper repositoryHelper,
 String serviceName,
 String methodName)
                                 throws UserNotAuthorizedException

Tests for whether a specific user should have the right to link unanchored elements

Specified by:

validateUserForAnchorDetach in interface OpenMetadataElementSecurity

Parameters:

userId - identifier of user

anchorEntity - anchor details

detachingEntity - obsolete element

relationshipName - name of the relationship

repositoryHelper - helper for OMRS objects

serviceName - calling service

methodName - calling method

Throws:

UserNotAuthorizedException - the user is not authorized to change this element

validateUserForAnchorAddFeedback

public void validateUserForAnchorAddFeedback(String userId,
 EntityDetail anchorEntity,
 EntityDetail feedbackEntity,
 OMRSRepositoryHelper repositoryHelper,
 String serviceName,
 String methodName)
                                      throws UserNotAuthorizedException

Tests for whether a specific user should have the right to attach feedback - such as comments, ratings, tags and likes, to the anchor or member element.

Specified by:

validateUserForAnchorAddFeedback in interface OpenMetadataElementSecurity

Parameters:

userId - identifier of user

anchorEntity - anchor details

feedbackEntity - feedback element

repositoryHelper - helper for OMRS objects

serviceName - calling service

methodName - calling method

Throws:

UserNotAuthorizedException - the user is not authorized to change this element

validateUserForAnchorDeleteFeedback

public void validateUserForAnchorDeleteFeedback(String userId,
 EntityDetail anchorEntity,
 EntityDetail feedbackEntity,
 OMRSRepositoryHelper repositoryHelper,
 String serviceName,
 String methodName)
                                         throws UserNotAuthorizedException

Tests for whether a specific user should have the right to detach feedback - such as comments, ratings, tags and likes, to the anchor or member element.

Specified by:

validateUserForAnchorDeleteFeedback in interface OpenMetadataElementSecurity

Parameters:

userId - identifier of user

anchorEntity - anchor details

feedbackEntity - feedback element

repositoryHelper - helper for OMRS objects

serviceName - calling service

methodName - calling method

Throws:

UserNotAuthorizedException - the user is not authorized to change this element

validateUserForAnchorClassify

public void validateUserForAnchorClassify(String userId,
 EntityDetail anchorEntity,
 String classificationName,
 OMRSRepositoryHelper repositoryHelper,
 String serviceName,
 String methodName)
                                   throws UserNotAuthorizedException

Tests for whether a specific user should have the right to add or update a classification on this anchor or member element.

Specified by:

validateUserForAnchorClassify in interface OpenMetadataElementSecurity

Parameters:

userId - identifier of user

anchorEntity - anchor details

classificationName - name of the classification

repositoryHelper - helper for OMRS objects

serviceName - calling service

methodName - calling method

Throws:

UserNotAuthorizedException - the user is not authorized to change this element

validateUserForAnchorDeclassify

public void validateUserForAnchorDeclassify(String userId,
 EntityDetail anchorEntity,
 String classificationName,
 OMRSRepositoryHelper repositoryHelper,
 String serviceName,
 String methodName)
                                     throws UserNotAuthorizedException

Tests for whether a specific user should have the right to remove a classification from this anchor or member element

Specified by:

validateUserForAnchorDeclassify in interface OpenMetadataElementSecurity

Parameters:

userId - identifier of user

anchorEntity - anchor details

classificationName - name of the classification

repositoryHelper - helper for OMRS objects

serviceName - calling service

methodName - calling method

Throws:

UserNotAuthorizedException - the user is not authorized to change this element

validateUserForAnchorMemberDelete

public void validateUserForAnchorMemberDelete(String userId,
 EntityDetail anchorEntity,
 EntityDetail obsoleteEntity,
 OMRSRepositoryHelper repositoryHelper,
 String serviceName,
 String methodName)
                                       throws UserNotAuthorizedException

Tests for whether a specific user should have the right to delete an element and all of its contents.

Specified by:

validateUserForAnchorMemberDelete in interface OpenMetadataElementSecurity

Parameters:

userId - identifier of user

obsoleteEntity - original element details

repositoryHelper - helper for OMRS objects

serviceName - calling service

methodName - calling method

Throws:

UserNotAuthorizedException - the user is not authorized to change this element

validateUserForElementDelete

public void validateUserForElementDelete(String userId,
 EntityDetail entity,
 OMRSRepositoryHelper repositoryHelper,
 String serviceName,
 String methodName)
                                  throws UserNotAuthorizedException

Tests for whether a specific user should have the right to delete an element and all of its contents.

Specified by:

validateUserForElementDelete in interface OpenMetadataElementSecurity

Parameters:

userId - identifier of user

entity - original element details

repositoryHelper - helper for OMRS objects

serviceName - calling service

methodName - calling method

Throws:

UserNotAuthorizedException - the user is not authorized to change this element

validateUserForAnchorMemberAdd

public void validateUserForAnchorMemberAdd(String userId,
 EntityDetail anchorEntity,
 EntityDetail newMemberEntity,
 String relationshipName,
 OMRSRepositoryHelper repositoryHelper,
 String serviceName,
 String methodName)
                                    throws UserNotAuthorizedException

Tests for whether a specific user should have the right to attach feedback - such as comments, ratings, tags and likes, to the element.

Specified by:

validateUserForAnchorMemberAdd in interface OpenMetadataElementSecurity

Parameters:

userId - identifier of user

anchorEntity - anchor details

newMemberEntity - feedback element

relationshipName - name of the relationship

repositoryHelper - helper for OMRS objects

serviceName - calling service

methodName - calling method

Throws:

UserNotAuthorizedException - the user is not authorized to change this element

validateUserForTypeCreate

public void validateUserForTypeCreate(String userId,
 String metadataCollectionName,
 TypeDef typeDef)
                               throws UserNotAuthorizedException

Tests for whether a specific user should have the right to create a type within a repository.

Specified by:

validateUserForTypeCreate in interface OpenMetadataRepositorySecurity

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

public void validateUserForTypeCreate(String userId,
 String metadataCollectionName,
 AttributeTypeDef attributeTypeDef)
                               throws UserNotAuthorizedException

Tests for whether a specific user should have the right to create a type within a repository.

Specified by:

validateUserForTypeCreate in interface OpenMetadataRepositorySecurity

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

public void validateUserForTypeRead(String userId,
 String metadataCollectionName,
 TypeDef typeDef)
                             throws UserNotAuthorizedException

Tests for whether a specific user should have read access to a specific type within a repository.

Specified by:

validateUserForTypeRead in interface OpenMetadataRepositorySecurity

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

public void validateUserForTypeRead(String userId,
 String metadataCollectionName,
 AttributeTypeDef attributeTypeDef)
                             throws UserNotAuthorizedException

Tests for whether a specific user should have read access to a specific type within a repository.

Specified by:

validateUserForTypeRead in interface OpenMetadataRepositorySecurity

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

public void validateUserForTypeUpdate(String userId,
 String metadataCollectionName,
 TypeDef typeDef,
 TypeDefPatch patch)
                               throws UserNotAuthorizedException

Tests for whether a specific user should have the right to update a type within a repository.

Specified by:

validateUserForTypeUpdate in interface OpenMetadataRepositorySecurity

Parameters:

userId - identifier of user

metadataCollectionName - configurable name of the metadata collection

typeDef - type details

patch - changes to the type

Throws:

UserNotAuthorizedException - the user is not authorized to maintain types

validateUserForTypeDelete

public void validateUserForTypeDelete(String userId,
 String metadataCollectionName,
 TypeDef typeDef)
                               throws UserNotAuthorizedException

Tests for whether a specific user should have the right to delete a type within a repository.

Specified by:

validateUserForTypeDelete in interface OpenMetadataRepositorySecurity

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

public void validateUserForTypeDelete(String userId,
 String metadataCollectionName,
 AttributeTypeDef attributeTypeDef)
                               throws UserNotAuthorizedException

Tests for whether a specific user should have the right to delete a type within a repository.

Specified by:

validateUserForTypeDelete in interface OpenMetadataRepositorySecurity

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

public void validateUserForTypeReIdentify(String userId,
 String metadataCollectionName,
 TypeDef originalTypeDef,
 String newTypeDefGUID,
 String newTypeDefName)
                                   throws UserNotAuthorizedException

Tests for whether a specific user should have the right to change the identifiers for a type within a repository.

Specified by:

validateUserForTypeReIdentify in interface OpenMetadataRepositorySecurity

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

public void validateUserForTypeReIdentify(String userId,
 String metadataCollectionName,
 AttributeTypeDef originalAttributeTypeDef,
 String newTypeDefGUID,
 String newTypeDefName)
                                   throws UserNotAuthorizedException

Tests for whether a specific user should have the right to change the identifiers for a type within a repository.

Specified by:

validateUserForTypeReIdentify in interface OpenMetadataRepositorySecurity

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

public void validateUserForEntityCreate(String userId,
 String metadataCollectionName,
 String entityTypeGUID,
 InstanceProperties initialProperties,
 List<Classification> initialClassifications,
 InstanceStatus initialStatus)
                                 throws UserNotAuthorizedException

Tests for whether a specific user should have the right to create an instance within a repository.

Specified by:

validateUserForEntityCreate in interface OpenMetadataRepositorySecurity

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

public EntityDetail validateUserForEntityRead(String userId,
 String metadataCollectionName,
 EntityDetail instance)
                                       throws UserNotAuthorizedException

Tests for whether a specific user should have read access to a specific instance within a repository.

Specified by:

validateUserForEntityRead in interface OpenMetadataRepositorySecurity

Parameters:

userId - identifier of user

metadataCollectionName - configurable name of the metadata collection

instance - instance details

Returns:

entity to return (maybe altered by the connector)

Throws:

UserNotAuthorizedException - the user is not authorized to retrieve instances

validateUserForEntitySummaryRead

public void validateUserForEntitySummaryRead(String userId,
 String metadataCollectionName,
 EntitySummary instance)
                                      throws UserNotAuthorizedException

Tests for whether a specific user should have read access to a specific instance within a repository.

Specified by:

validateUserForEntitySummaryRead in interface OpenMetadataRepositorySecurity

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

public void validateUserForEntityProxyRead(String userId,
 String metadataCollectionName,
 EntityProxy instance)
                                    throws UserNotAuthorizedException

Tests for whether a specific user should have read access to a specific instance within a repository.

Specified by:

validateUserForEntityProxyRead in interface OpenMetadataRepositorySecurity

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

public void validateUserForEntityUpdate(String userId,
 String metadataCollectionName,
 EntityDetail instance)
                                 throws UserNotAuthorizedException

Tests for whether a specific user should have the right to update an instance within a repository.

Specified by:

validateUserForEntityUpdate in interface OpenMetadataRepositorySecurity

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

public void validateUserForEntityClassificationAdd(String userId,
 String metadataCollectionName,
 EntitySummary instance,
 String classificationName,
 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.

Specified by:

validateUserForEntityClassificationAdd in interface OpenMetadataRepositorySecurity

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

public void validateUserForEntityClassificationUpdate(String userId,
 String metadataCollectionName,
 EntitySummary instance,
 String classificationName,
 InstanceProperties properties)
                                               throws UserNotAuthorizedException

Tests for whether a specific user should have the right to update the classification for an entity instance within a repository.

Specified by:

validateUserForEntityClassificationUpdate in interface OpenMetadataRepositorySecurity

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

public void validateUserForEntityClassificationDelete(String userId,
 String metadataCollectionName,
 EntitySummary instance,
 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.

Specified by:

validateUserForEntityClassificationDelete in interface OpenMetadataRepositorySecurity

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

public void validateUserForEntityDelete(String userId,
 String metadataCollectionName,
 EntityDetail instance)
                                 throws UserNotAuthorizedException

Tests for whether a specific user should have the right to delete an instance within a repository.

Specified by:

validateUserForEntityDelete in interface OpenMetadataRepositorySecurity

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

public void validateUserForEntityRestore(String userId,
 String metadataCollectionName,
 String deletedEntityGUID)
                                  throws UserNotAuthorizedException

Tests for whether a specific user should have the right to delete an instance within a repository.

Specified by:

validateUserForEntityRestore in interface OpenMetadataRepositorySecurity

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

public void validateUserForEntityReIdentification(String userId,
 String metadataCollectionName,
 EntityDetail instance,
 String newGUID)
                                           throws UserNotAuthorizedException

Tests for whether a specific user should have the right to change the guid on an instance within a repository.

Specified by:

validateUserForEntityReIdentification in interface OpenMetadataRepositorySecurity

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

public void validateUserForEntityReTyping(String userId,
 String metadataCollectionName,
 EntityDetail instance,
 TypeDefSummary newTypeDefSummary)
                                   throws UserNotAuthorizedException

Tests for whether a specific user should have the right to change an instance's type within a repository.

Specified by:

validateUserForEntityReTyping in interface OpenMetadataRepositorySecurity

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

public void validateUserForEntityReHoming(String userId,
 String metadataCollectionName,
 EntityDetail instance,
 String newHomeMetadataCollectionId,
 String newHomeMetadataCollectionName)
                                   throws UserNotAuthorizedException

Tests for whether a specific user should have the right to change the home of an instance within a repository.

Specified by:

validateUserForEntityReHoming in interface OpenMetadataRepositorySecurity

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

public void validateUserForRelationshipCreate(String userId,
 String metadataCollectionName,
 String relationshipTypeGUID,
 InstanceProperties initialProperties,
 EntitySummary entityOneSummary,
 EntitySummary entityTwoSummary,
 InstanceStatus initialStatus)
                                       throws UserNotAuthorizedException

Tests for whether a specific user should have the right to create an instance within a repository.

Specified by:

validateUserForRelationshipCreate in interface OpenMetadataRepositorySecurity

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

public Relationship validateUserForRelationshipRead(String userId,
 String metadataCollectionName,
 Relationship instance)
                                             throws UserNotAuthorizedException

Tests for whether a specific user should have read access to a specific instance within a repository.

Specified by:

validateUserForRelationshipRead in interface OpenMetadataRepositorySecurity

Parameters:

userId - identifier of user

metadataCollectionName - configurable name of the metadata collection

instance - instance details

Returns:

relationship to return (maybe altered by the connector)

Throws:

UserNotAuthorizedException - the user is not authorized to retrieve instances

validateUserForRelationshipUpdate

public void validateUserForRelationshipUpdate(String userId,
 String metadataCollectionName,
 Relationship instance)
                                       throws UserNotAuthorizedException

Tests for whether a specific user should have the right to update an instance within a repository.

Specified by:

validateUserForRelationshipUpdate in interface OpenMetadataRepositorySecurity

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

public void validateUserForRelationshipDelete(String userId,
 String metadataCollectionName,
 Relationship instance)
                                       throws UserNotAuthorizedException

Tests for whether a specific user should have the right to delete an instance within a repository.

Specified by:

validateUserForRelationshipDelete in interface OpenMetadataRepositorySecurity

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

public void validateUserForRelationshipRestore(String userId,
 String metadataCollectionName,
 String deletedRelationshipGUID)
                                        throws UserNotAuthorizedException

Tests for whether a specific user should have the right to delete an instance within a repository.

Specified by:

validateUserForRelationshipRestore in interface OpenMetadataRepositorySecurity

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

public void validateUserForRelationshipReIdentification(String userId,
 String metadataCollectionName,
 Relationship instance,
 String newGUID)
                                                 throws UserNotAuthorizedException

Tests for whether a specific user should have the right to change the guid on an instance within a repository.

Specified by:

validateUserForRelationshipReIdentification in interface OpenMetadataRepositorySecurity

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

public void validateUserForRelationshipReTyping(String userId,
 String metadataCollectionName,
 Relationship instance,
 TypeDefSummary newTypeDefSummary)
                                         throws UserNotAuthorizedException

Tests for whether a specific user should have the right to change an instance's type within a repository.

Specified by:

validateUserForRelationshipReTyping in interface OpenMetadataRepositorySecurity

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

public void validateUserForRelationshipReHoming(String userId,
 String metadataCollectionName,
 Relationship instance,
 String newHomeMetadataCollectionId,
 String newHomeMetadataCollectionName)
                                         throws UserNotAuthorizedException

Tests for whether a specific user should have the right to change the home of an instance within a repository.

Specified by:

validateUserForRelationshipReHoming in interface OpenMetadataRepositorySecurity

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

public boolean validateEntityReferenceCopySave(String userId,
 EntityDetail instance)
                                        throws UserNotAuthorizedException

Tests for whether a reference copy should be saved to the repository.

Specified by:

validateEntityReferenceCopySave in interface OpenMetadataRepositorySecurity

Parameters:

userId - identifier of user

instance - instance details

Returns:

flag indicating whether the reference copy should be saved

Throws:

UserNotAuthorizedException - the user is not authorized to maintain instances

validateRelationshipReferenceCopySave

public boolean validateRelationshipReferenceCopySave(String userId,
 Relationship instance)
                                              throws UserNotAuthorizedException

Tests for whether a reference copy should be saved to the repository.

Specified by:

validateRelationshipReferenceCopySave in interface OpenMetadataRepositorySecurity

Parameters:

userId - identifier of user

instance - instance details

Returns:

flag indicating whether the reference copy should be saved

Throws:

UserNotAuthorizedException - the user is not authorized to maintain instances

validateInboundEvent

public OMRSInstanceEvent validateInboundEvent(String cohortName,
 OMRSInstanceEvent event)

Validate whether an event received from another member of the cohort should be processed by this server.

Specified by:

validateInboundEvent in interface OpenMetadataEventsSecurity

Parameters:

cohortName - name of the cohort

event - event that has been received

Returns:

inbound event to process (maybe updated) or null to indicate that the event should be ignored

validateOutboundEvent

public OMRSInstanceEvent validateOutboundEvent(String cohortName,
 OMRSInstanceEvent event)

Validate whether an event should be sent to the other members of the cohort by this server.

Specified by:

validateOutboundEvent in interface OpenMetadataEventsSecurity

Parameters:

cohortName - name of the cohort

event - event that has been received

Returns:

outbound event to send (maybe updated) or null to indicate that the event should be ignored