org.odpi.openmetadata.metadatasecurity.accessconnector.OpenMetadataAccessSecurityConnector

All Implemented Interfaces:: AuditLoggingComponent, SecureConnectorExtension, VirtualConnectorExtension, OpenMetadataElementSecurity, OpenMetadataPlatformSecurity, OpenMetadataRepositorySecurity, OpenMetadataServerSecurity, OpenMetadataServiceSecurity, OpenMetadataUserSecurity

public class OpenMetadataAccessSecurityConnector extends OpenMetadataSecurityConnector implements OpenMetadataPlatformSecurity, OpenMetadataRepositorySecurity, OpenMetadataServerSecurity, OpenMetadataServiceSecurity, OpenMetadataElementSecurity, OpenMetadataUserSecurity

OpenMetadataAccessSecurityConnector provides a specific security connector for Egeria's runtime users that overrides the default behavior of the default open metadata security connectors that does not allow any access to anything. It provides a demonstration of how to implement a security connector that uses an external secrets store.

Nested Class Summary

Nested classes/interfaces inherited from class org.odpi.openmetadata.frameworks.connectors.ConnectorBase
ConnectorBase.ProtectedConnection
Field Summary

Fields inherited from class org.odpi.openmetadata.metadatasecurity.connectors.OpenMetadataSecurityConnector
connectorName, localServerUserId, platformName, serverName, unknownTypeName

Fields inherited from class org.odpi.openmetadata.frameworks.connectors.ConnectorBase
auditLog, connectionBean, connectorInstanceId, embeddedConnectors, messageFormatter, secretsStoreConnectorMap
Constructor Summary

Constructors

Constructor

Description

OpenMetadataAccessSecurityConnector()

Constructor sets up the security policies
Method Summary

Modifier and Type

Method

Description

void

deleteUserAccount(String userId)

Delete information about a specific user.

protected List<String>

getAssociatedSecurityListForZone(String zoneName, AccessOperation operation)

Returns the list of security lists associated with the zone and operation.

List<String>

getDefaultZonesForUser(List<String> initialZones, String typeName, String serviceName, String userId)

Determine the appropriate setting for the default zones depending on the user and the default zones set up for the service.

List<String>

getPublishZonesForUser(List<String> currentZones, String typeName, String serviceName, String userId)

Determine the appropriate setting for the default zones depending on the user and the default publish zones set up for the service.

OpenMetadataUserAccount

getUserAccount(String userId)

Retrieve information about a specific user.

List<String>

getWithdrawZonesForUser(List<String> currentZones, String typeName, String serviceName, String userId)

Determine the appropriate setting for the zones depending on the user and the current zones set up for the element.

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.

void

setUserAccount(OpenMetadataUserAccount userAccount)

Update/create information about a specific user.

void

start()

Indicates that the connector is completely configured and can begin processing.

boolean

validateEntityReferenceCopySave(String userId, EntityDetail instance)

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

boolean

validateRelationshipReferenceCopySave(String userId, Relationship instance)

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

void

validateUserAsInvestigatorForPlatform(String userId)

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

void

validateUserAsOperatorForPlatform(String userId)

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

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

validateUserForAnchorMemberCreate(String userId, EntityDetail anchorEntity, OMRSRepositoryHelper repositoryHelper, String serviceName, String methodName)

Tests for whether a specific user should have the right to create new elements as members of an anchor.

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.

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 restore 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 the type name of an instance 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

validateUserForNewServer(String userId)

Check that the calling user is authorized to create new servers.

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 a 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 restore 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 the type name of an instance 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 typeDef within a repository.

protected boolean

validateUserInGroup(String userId, SecurityAccessControl securityAccessControl, boolean isUserOwner, List<String> maintainers, String accessOperation)

This method does the lookup of the user and group in the secrets store.

protected void

validateZoneAccess(String userId, String entityGUID, String entityTypeName, List<Classification> classifications, AccessOperation operation, List<String> maintainers, OMRSRepositoryHelper repositoryHelper, String serviceName, String methodName)

Determine whether the user is permitted to perform the desired operation based on the element's zones.

Methods inherited from class org.odpi.openmetadata.metadatasecurity.connectors.OpenMetadataSecurityConnector
disconnect, getConnectorComponentDescription, logConnectorDisconnecting, logConnectorStarting, printZoneList, setAuditLog, setLocalServerUserId, setPlatformName, setServerName, throwMissingAnchor, throwUnauthorizedAddFeedback, throwUnauthorizedAnchorAccess, throwUnauthorizedElementAccess, throwUnauthorizedInstanceAccess, throwUnauthorizedInstanceChange, throwUnauthorizedInstanceCreate, throwUnauthorizedPlatformAccess, throwUnauthorizedServerAccess, throwUnauthorizedServiceAccess, throwUnauthorizedTypeAccess, throwUnauthorizedTypeChange, throwUnauthorizedZoneChange, throwUnknownUser

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.ConnectorBase
combineConfigurationProperties, disconnectConnectors, equals, fromCamelToCanonicalCase, fromCanonicalToCamelCase, fromCanonicalToKebabCase, fromCanonicalToSnakeCase, fromKebabToCanonicalCase, fromSnakeToCanonicalCase, getArrayConfigurationProperty, getArrayConfigurationProperty, getArrayConfigurationProperty, getBooleanConfigurationProperty, getConnection, getConnectorInstanceId, getDateConfigurationProperty, getIntConfigurationProperty, getLongConfigurationProperty, getSecretsCollectionName, getSecretsLocation, getSecretsProvider, getStringConfigurationProperty, getStringConfigurationProperty, getSuppliedPlaceholderProperties, hashCode, initialize, initializeEmbeddedConnectors, initializeSecretsStoreConnector, isActive, logExceptionRecord, logRecord, logRecord, throwMissingConfigurationProperty, throwMissingEndpointAddress, throwMissingResource, throwNoAsset, throwWrongTypeOfAsset, throwWrongTypeOfResource, throwWrongTypeOfRootSchema, toString

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.Connector
clearStatisticProperty, clearStatisticTimestamp, getConnectorStatistics, getStatisticCounter, getStatisticProperty, getStatisticTimestamp, incrementStatisticCounter, initializeStatisticCounter, refreshStatistics, setStatisticProperty, setStatisticTimestamp

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.odpi.openmetadata.metadatasecurity.OpenMetadataPlatformSecurity
setPlatformName

Constructor Details
- OpenMetadataAccessSecurityConnector
  
  public OpenMetadataAccessSecurityConnector()
  
  Constructor sets up the security policies
Method Details
- start
  
  public void start() throws ConnectorCheckedException, UserNotAuthorizedException
  
  Indicates that the connector is completely configured and can begin processing.
  
  Overrides:
  
  start in class OpenMetadataSecurityConnector
  
  Throws:
  
  ConnectorCheckedException - the connector detected a problem.
  
  UserNotAuthorizedException - the connector was disconnected before/during start
- getUserAccount
  
  public OpenMetadataUserAccount getUserAccount(String userId) throws UserNotAuthorizedException, InvalidParameterException, PropertyServerException
  
  Retrieve information about a specific user. This is used during a user's request for a token
  
  Specified by:
  
  getUserAccount in interface OpenMetadataUserSecurity
  
  Parameters:
  
  userId - calling user
  
  Returns:
  
  security properties about the user
  
  Throws:
  
  InvalidParameterException - one of the elements is invisible to the requesting user.
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.
  
  PropertyServerException - unable to retrieve necessary information to make the decision.
- setUserAccount
  
  public void setUserAccount(OpenMetadataUserAccount userAccount) throws UserNotAuthorizedException
  
  Update/create information about a specific user. This is used to update user details nd reset the password.
  
  Specified by:
  
  setUserAccount in interface OpenMetadataUserSecurity
  
  Parameters:
  
  userAccount - security properties about the user
  
  Throws:
  
  UserNotAuthorizedException - user not recognized
- deleteUserAccount
  
  public void deleteUserAccount(String userId) throws UserNotAuthorizedException
  
  Delete information about a specific user.
  
  Specified by:
  
  deleteUserAccount in interface OpenMetadataUserSecurity
  
  Parameters:
  
  userId - calling user
  
  Throws:
  
  UserNotAuthorizedException - user not recognized
- validateUserInGroup
  
  protected boolean validateUserInGroup(String userId, SecurityAccessControl securityAccessControl, boolean isUserOwner, List<String> maintainers, String accessOperation) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException
  
  This method does the lookup of the user and group in the secrets store.
  
  Parameters:
  
  userId - calling user
  
  securityAccessControl - control
  
  accessOperation - operation
  
  isUserOwner - is the user the owner of the element?
  
  maintainers - list of maintainers
  
  Returns:
  
  boolean indicating that they are not members of the group
  
  Throws:
  
  InvalidParameterException - one of the elements is invisible to the requesting user.
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.
  
  PropertyServerException - unable to retrieve necessary information to make the decision.
- validateUserForNewServer
  
  public void validateUserForNewServer(String userId) throws UserNotAuthorizedException, InvalidParameterException, PropertyServerException
  
  Check that the calling user is authorized to create new servers.
  
  Specified by:
  
  validateUserForNewServer in interface OpenMetadataPlatformSecurity
  
  Overrides:
  
  validateUserForNewServer in class OpenMetadataSecurityConnector
  
  Parameters:
  
  userId - calling user
  
  Throws:
  
  InvalidParameterException - one of the elements is invisible to the requesting user.
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.
  
  PropertyServerException - unable to retrieve necessary information to make the decision.
- validateUserAsOperatorForPlatform
  
  public void validateUserAsOperatorForPlatform(String userId) throws UserNotAuthorizedException, InvalidParameterException, PropertyServerException
  
  Check that the calling user is authorized to issue operator requests to the OMAG Server Platform.
  
  Specified by:
  
  validateUserAsOperatorForPlatform in interface OpenMetadataPlatformSecurity
  
  Overrides:
  
  validateUserAsOperatorForPlatform in class OpenMetadataSecurityConnector
  
  Parameters:
  
  userId - calling user
  
  Throws:
  
  InvalidParameterException - one of the elements is invisible to the requesting user.
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.
  
  PropertyServerException - unable to retrieve necessary information to make the decision.
- validateUserAsInvestigatorForPlatform
  
  public void validateUserAsInvestigatorForPlatform(String userId) throws UserNotAuthorizedException, InvalidParameterException, PropertyServerException
  
  Check that the calling user is authorized to issue diagnostic requests to the OMAG Server Platform.
  
  Specified by:
  
  validateUserAsInvestigatorForPlatform in interface OpenMetadataPlatformSecurity
  
  Overrides:
  
  validateUserAsInvestigatorForPlatform in class OpenMetadataSecurityConnector
  
  Parameters:
  
  userId - calling user
  
  Throws:
  
  InvalidParameterException - one of the elements is invisible to the requesting user.
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.
  
  PropertyServerException - unable to retrieve necessary information to make the decision.
- validateUserForServer
  
  public void validateUserForServer(String userId) throws UserNotAuthorizedException, InvalidParameterException, PropertyServerException
  
  Check that the calling user is authorized to issue a (any) request to the OMAG Server Platform.
  
  Specified by:
  
  validateUserForServer in interface OpenMetadataServerSecurity
  
  Overrides:
  
  validateUserForServer in class OpenMetadataSecurityConnector
  
  Parameters:
  
  userId - calling user
  
  Throws:
  
  InvalidParameterException - one of the elements is invisible to the requesting user.
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.
  
  PropertyServerException - unable to retrieve necessary information to make the decision.
- validateUserAsServerAdmin
  
  public void validateUserAsServerAdmin(String userId) throws UserNotAuthorizedException, InvalidParameterException, PropertyServerException
  
  Check that the calling user is authorized to update the configuration for a server.
  
  Specified by:
  
  validateUserAsServerAdmin in interface OpenMetadataServerSecurity
  
  Overrides:
  
  validateUserAsServerAdmin in class OpenMetadataSecurityConnector
  
  Parameters:
  
  userId - calling user
  
  Throws:
  
  InvalidParameterException - one of the elements is invisible to the requesting user.
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.
  
  PropertyServerException - unable to retrieve necessary information to make the decision.
- validateUserAsServerOperator
  
  public void validateUserAsServerOperator(String userId) throws UserNotAuthorizedException, InvalidParameterException, PropertyServerException
  
  Check that the calling user is authorized to issue operator requests to the OMAG Server.
  
  Specified by:
  
  validateUserAsServerOperator in interface OpenMetadataServerSecurity
  
  Overrides:
  
  validateUserAsServerOperator in class OpenMetadataSecurityConnector
  
  Parameters:
  
  userId - calling user
  
  Throws:
  
  InvalidParameterException - one of the elements is invisible to the requesting user.
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.
  
  PropertyServerException - unable to retrieve necessary information to make the decision.
- validateUserAsServerInvestigator
  
  public void validateUserAsServerInvestigator(String userId) throws UserNotAuthorizedException, InvalidParameterException, PropertyServerException
  
  Check that the calling user is authorized to issue operator requests to the OMAG Server.
  
  Specified by:
  
  validateUserAsServerInvestigator in interface OpenMetadataServerSecurity
  
  Overrides:
  
  validateUserAsServerInvestigator in class OpenMetadataSecurityConnector
  
  Parameters:
  
  userId - calling user
  
  Throws:
  
  InvalidParameterException - one of the elements is invisible to the requesting user.
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.
  
  PropertyServerException - unable to retrieve necessary information to make the decision.
- validateUserForService
  
  public void validateUserForService(String userId, String serviceName) throws UserNotAuthorizedException, InvalidParameterException, PropertyServerException
  
  Check that the calling user is authorized to issue this request.
  
  Specified by:
  
  validateUserForService in interface OpenMetadataServiceSecurity
  
  Overrides:
  
  validateUserForService in class OpenMetadataSecurityConnector
  
  Parameters:
  
  userId - calling user
  
  serviceName - name of called service
  
  Throws:
  
  InvalidParameterException - one of the elements is invisible to the requesting user.
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.
  
  PropertyServerException - unable to retrieve necessary information to make the decision.
- validateUserForServiceOperation
  
  public void validateUserForServiceOperation(String userId, String serviceName, String serviceOperationName) throws UserNotAuthorizedException, InvalidParameterException, PropertyServerException
  
  Check that the calling user is authorized to issue this specific request.
  
  Specified by:
  
  validateUserForServiceOperation in interface OpenMetadataServiceSecurity
  
  Overrides:
  
  validateUserForServiceOperation in class OpenMetadataSecurityConnector
  
  Parameters:
  
  userId - calling user
  
  serviceName - name of called service
  
  serviceOperationName - name of called operation
  
  Throws:
  
  InvalidParameterException - one of the elements is invisible to the requesting user.
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.
  
  PropertyServerException - unable to retrieve necessary information to make the decision.
- getAssociatedSecurityListForZone
  
  protected List<String> getAssociatedSecurityListForZone(String zoneName, AccessOperation operation)
  
  Returns the list of security lists associated with the zone and operation. If none are found, there is no restriction on the use of the zone.
  
  Parameters:
  
  zoneName - name of the zone
  
  operation - operation to check
  
  Returns:
  
  list of security groups
- getDefaultZonesForUser
  
  public List<String> getDefaultZonesForUser(List<String> initialZones, String typeName, String serviceName, String userId) throws UserNotAuthorizedException, InvalidParameterException, PropertyServerException
  
  Determine the appropriate setting for the default zones depending on the user and the default zones set up for the service. This is called whenever an element is created.
  
  Specified by:
  
  getDefaultZonesForUser in interface OpenMetadataUserSecurity
  
  Overrides:
  
  getDefaultZonesForUser in class OpenMetadataSecurityConnector
  
  Parameters:
  
  initialZones - default setting of the default zones
  
  typeName - type of the element
  
  serviceName - name of the called service
  
  userId - name of the user
  
  Returns:
  
  list of default zones for the user
  
  Throws:
  
  InvalidParameterException - one of the elements is invisible to the requesting user.
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.
  
  PropertyServerException - unable to retrieve necessary information to make the decision.
- getPublishZonesForUser
  
  public List<String> getPublishZonesForUser(List<String> currentZones, String typeName, String serviceName, String userId) throws UserNotAuthorizedException, InvalidParameterException, PropertyServerException
  
  Determine the appropriate setting for the default zones depending on the user and the default publish zones set up for the service. This is called whenever an element is published.
  
  Specified by:
  
  getPublishZonesForUser in interface OpenMetadataUserSecurity
  
  Overrides:
  
  getPublishZonesForUser in class OpenMetadataSecurityConnector
  
  Parameters:
  
  currentZones - default setting of the published zones
  
  typeName - type of the element
  
  serviceName - name of the called service
  
  userId - name of the user
  
  Returns:
  
  list of published zones for the user
  
  Throws:
  
  InvalidParameterException - one of the elements is invisible to the requesting user.
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.
  
  PropertyServerException - unable to retrieve necessary information to make the decision.
- getWithdrawZonesForUser
  
  public List<String> getWithdrawZonesForUser(List<String> currentZones, String typeName, String serviceName, String userId) throws UserNotAuthorizedException, InvalidParameterException, PropertyServerException
  
  Determine the appropriate setting for the zones depending on the user and the current zones set up for the element. This is called whenever an element is withdrawn.
  
  Specified by:
  
  getWithdrawZonesForUser in interface OpenMetadataUserSecurity
  
  Overrides:
  
  getWithdrawZonesForUser in class OpenMetadataSecurityConnector
  
  Parameters:
  
  currentZones - default setting of the default zones
  
  typeName - type of the element
  
  serviceName - name of the called service
  
  userId - name of the user
  
  Returns:
  
  list of published zones for the user
  
  Throws:
  
  InvalidParameterException - one of the elements is invisible to the requesting user.
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.
  
  PropertyServerException - unable to retrieve necessary information to make the decision.
- validateZoneAccess
  
  protected void validateZoneAccess(String userId, String entityGUID, String entityTypeName, List<Classification> classifications, AccessOperation operation, List<String> maintainers, OMRSRepositoryHelper repositoryHelper, String serviceName, String methodName) throws UserNotAuthorizedException, InvalidParameterException, PropertyServerException
  
  Determine whether the user is permitted to perform the desired operation based on the element's zones.
  
  Parameters:
  
  userId - identifier of user
  
  entityGUID - unique identifier of entity
  
  entityTypeName - open metadata type name
  
  classifications - list of classifications from entity
  
  operation - operation that they wish to perform
  
  maintainers - list of maintainers of the entity
  
  repositoryHelper - manipulates repository service objects
  
  serviceName - calling service
  
  methodName - calling method
  
  Throws:
  
  InvalidParameterException - one of the elements is invisible to the requesting user.
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.
  
  PropertyServerException - unable to retrieve necessary information to make the decision.
- 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:
  
  InvalidParameterException - one of the elements is invisible to the requesting user.
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.
  
  PropertyServerException - unable to retrieve necessary information to make the decision.
- 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 elements is invisible to the requesting user.
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.
  
  PropertyServerException - unable to retrieve necessary information to make the decision.
- validateUserForAnchorMemberRead
  
  public void validateUserForAnchorMemberRead(String userId, EntityDetail anchorEntity, 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:
  
  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:
  
  InvalidParameterException - one of the elements is invisible to the requesting user.
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.
  
  PropertyServerException - unable to retrieve necessary information to make the decision.
- validateUserForElementDetailUpdate
  
  public void validateUserForElementDetailUpdate(String userId, EntityDetail originalEntity, InstanceProperties newEntityProperties, OMRSRepositoryHelper repositoryHelper, String serviceName, String methodName) throws UserNotAuthorizedException, InvalidParameterException, PropertyServerException
  
  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:
  
  InvalidParameterException - one of the elements is invisible to the requesting user.
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.
  
  PropertyServerException - unable to retrieve necessary information to make the decision.
- validateUserForElementStatusUpdate
  
  public void validateUserForElementStatusUpdate(String userId, EntityDetail originalEntity, InstanceStatus newStatus, OMRSRepositoryHelper repositoryHelper, String serviceName, String methodName) throws UserNotAuthorizedException, InvalidParameterException, PropertyServerException
  
  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:
  
  InvalidParameterException - one of the elements is invisible to the requesting user.
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.
  
  PropertyServerException - unable to retrieve necessary information to make the decision.
- validateUserForElementAttach
  
  public void validateUserForElementAttach(String userId, EntityDetail startingEntity, EntityDetail attachingEntity, String relationshipName, OMRSRepositoryHelper repositoryHelper, String serviceName, String methodName) throws UserNotAuthorizedException, InvalidParameterException, PropertyServerException
  
  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:
  
  InvalidParameterException - one of the elements is invisible to the requesting user.
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.
  
  PropertyServerException - unable to retrieve necessary information to make the decision.
- validateUserForElementDetach
  
  public void validateUserForElementDetach(String userId, EntityDetail startingEntity, EntityDetail detachingEntity, String relationshipName, OMRSRepositoryHelper repositoryHelper, String serviceName, String methodName) throws UserNotAuthorizedException, InvalidParameterException, PropertyServerException
  
  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:
  
  InvalidParameterException - one of the elements is invisible to the requesting user.
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.
  
  PropertyServerException - unable to retrieve necessary information to make the decision.
- validateUserForElementAddFeedback
  
  public void validateUserForElementAddFeedback(String userId, EntityDetail originalEntity, EntityDetail feedbackEntity, OMRSRepositoryHelper repositoryHelper, String serviceName, String methodName) throws UserNotAuthorizedException, InvalidParameterException, PropertyServerException
  
  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:
  
  InvalidParameterException - one of the elements is invisible to the requesting user.
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.
  
  PropertyServerException - unable to retrieve necessary information to make the decision.
- validateUserForElementDeleteFeedback
  
  public void validateUserForElementDeleteFeedback(String userId, EntityDetail originalEntity, EntityDetail feedbackEntity, OMRSRepositoryHelper repositoryHelper, String serviceName, String methodName) throws UserNotAuthorizedException, InvalidParameterException, PropertyServerException
  
  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:
  
  InvalidParameterException - one of the elements is invisible to the requesting user.
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.
  
  PropertyServerException - unable to retrieve necessary information to make the decision.
- validateUserForElementClassify
  
  public void validateUserForElementClassify(String userId, EntityDetail originalEntity, String classificationName, OMRSRepositoryHelper repositoryHelper, String serviceName, String methodName) throws UserNotAuthorizedException, InvalidParameterException, PropertyServerException
  
  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:
  
  InvalidParameterException - one of the elements is invisible to the requesting user.
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.
  
  PropertyServerException - unable to retrieve necessary information to make the decision.
- validateUserForElementDeclassify
  
  public void validateUserForElementDeclassify(String userId, EntityDetail originalEntity, String classificationName, OMRSRepositoryHelper repositoryHelper, String serviceName, String methodName) throws UserNotAuthorizedException, InvalidParameterException, PropertyServerException
  
  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:
  
  InvalidParameterException - one of the elements is invisible to the requesting user.
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.
  
  PropertyServerException - unable to retrieve necessary information to make the decision.
- validateUserForAnchorMemberCreate
  
  public void validateUserForAnchorMemberCreate(String userId, EntityDetail anchorEntity, OMRSRepositoryHelper repositoryHelper, String serviceName, String methodName) throws UserNotAuthorizedException, InvalidParameterException, PropertyServerException
  
  Tests for whether a specific user should have the right to create new elements as members of an anchor.
  
  Specified by:
  
  validateUserForAnchorMemberCreate in interface OpenMetadataElementSecurity
  
  Parameters:
  
  userId - identifier of user
  
  anchorEntity - element details
  
  repositoryHelper - helper for OMRS objects
  
  serviceName - calling service
  
  methodName - calling method
  
  Throws:
  
  InvalidParameterException - one of the elements is invisible to the requesting user.
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.
  
  PropertyServerException - unable to retrieve necessary information to make the decision.
- validateUserForAnchorMemberUpdate
  
  public void validateUserForAnchorMemberUpdate(String userId, EntityDetail anchorEntity, OMRSRepositoryHelper repositoryHelper, String serviceName, String methodName) throws UserNotAuthorizedException, InvalidParameterException, PropertyServerException
  
  Tests for whether a specific user should have the right to update elements attached directly to an anchor. 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:
  
  InvalidParameterException - one of the elements is invisible to the requesting user.
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.
  
  PropertyServerException - unable to retrieve necessary information to make the decision.
- validateUserForAnchorMemberStatusUpdate
  
  public void validateUserForAnchorMemberStatusUpdate(String userId, EntityDetail anchorEntity, EntityDetail originalEntity, InstanceStatus newStatus, OMRSRepositoryHelper repositoryHelper, String serviceName, String methodName) throws UserNotAuthorizedException, InvalidParameterException, PropertyServerException
  
  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
  
  repositoryHelper - helper for OMRS objects
  
  serviceName - calling service
  
  methodName - calling method
  
  originalEntity - entity being updated
  
  newStatus - new value for status
  
  Throws:
  
  InvalidParameterException - one of the elements is invisible to the requesting user.
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.
  
  PropertyServerException - unable to retrieve necessary information to make the decision.
- validateUserForAnchorAttach
  
  public void validateUserForAnchorAttach(String userId, EntityDetail anchorEntity, EntityDetail attachingEntity, String relationshipName, OMRSRepositoryHelper repositoryHelper, String serviceName, String methodName) throws UserNotAuthorizedException, InvalidParameterException, PropertyServerException
  
  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:
  
  InvalidParameterException - one of the elements is invisible to the requesting user.
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.
  
  PropertyServerException - unable to retrieve necessary information to make the decision.
- validateUserForAnchorDetach
  
  public void validateUserForAnchorDetach(String userId, EntityDetail anchorEntity, EntityDetail detachingEntity, String relationshipName, OMRSRepositoryHelper repositoryHelper, String serviceName, String methodName) throws UserNotAuthorizedException, InvalidParameterException, PropertyServerException
  
  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:
  
  InvalidParameterException - one of the elements is invisible to the requesting user.
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.
  
  PropertyServerException - unable to retrieve necessary information to make the decision.
- validateUserForAnchorAddFeedback
  
  public void validateUserForAnchorAddFeedback(String userId, EntityDetail anchorEntity, EntityDetail feedbackEntity, OMRSRepositoryHelper repositoryHelper, String serviceName, String methodName) throws UserNotAuthorizedException, InvalidParameterException, PropertyServerException
  
  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:
  
  InvalidParameterException - one of the elements is invisible to the requesting user.
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.
  
  PropertyServerException - unable to retrieve necessary information to make the decision.
- validateUserForAnchorDeleteFeedback
  
  public void validateUserForAnchorDeleteFeedback(String userId, EntityDetail anchorEntity, EntityDetail feedbackEntity, OMRSRepositoryHelper repositoryHelper, String serviceName, String methodName) throws UserNotAuthorizedException, InvalidParameterException, PropertyServerException
  
  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:
  
  InvalidParameterException - one of the elements is invisible to the requesting user.
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.
  
  PropertyServerException - unable to retrieve necessary information to make the decision.
- validateUserForAnchorClassify
  
  public void validateUserForAnchorClassify(String userId, EntityDetail anchorEntity, String classificationName, OMRSRepositoryHelper repositoryHelper, String serviceName, String methodName) throws UserNotAuthorizedException, InvalidParameterException, PropertyServerException
  
  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:
  
  InvalidParameterException - one of the elements is invisible to the requesting user.
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.
  
  PropertyServerException - unable to retrieve necessary information to make the decision.
- validateUserForAnchorDeclassify
  
  public void validateUserForAnchorDeclassify(String userId, EntityDetail anchorEntity, String classificationName, OMRSRepositoryHelper repositoryHelper, String serviceName, String methodName) throws UserNotAuthorizedException, InvalidParameterException, PropertyServerException
  
  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:
  
  InvalidParameterException - one of the elements is invisible to the requesting user.
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.
  
  PropertyServerException - unable to retrieve necessary information to make the decision.
- validateUserForAnchorMemberDelete
  
  public void validateUserForAnchorMemberDelete(String userId, EntityDetail anchorEntity, EntityDetail obsoleteEntity, OMRSRepositoryHelper repositoryHelper, String serviceName, String methodName) throws UserNotAuthorizedException, InvalidParameterException, PropertyServerException
  
  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:
  
  InvalidParameterException - one of the elements is invisible to the requesting user.
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.
  
  PropertyServerException - unable to retrieve necessary information to make the decision.
- validateUserForElementDelete
  
  public void validateUserForElementDelete(String userId, EntityDetail entity, OMRSRepositoryHelper repositoryHelper, String serviceName, String methodName) throws UserNotAuthorizedException, InvalidParameterException, PropertyServerException
  
  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:
  
  InvalidParameterException - one of the elements is invisible to the requesting user.
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.
  
  PropertyServerException - unable to retrieve necessary information to make the decision.
- validateUserForAnchorMemberAdd
  
  public void validateUserForAnchorMemberAdd(String userId, EntityDetail anchorEntity, EntityDetail newMemberEntity, String relationshipName, OMRSRepositoryHelper repositoryHelper, String serviceName, String methodName) throws UserNotAuthorizedException, InvalidParameterException, PropertyServerException
  
  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:
  
  InvalidParameterException - one of the elements is invisible to the requesting user.
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.
  
  PropertyServerException - unable to retrieve necessary information to make the decision.
- selectConnection
  
  public EntityDetail selectConnection(String userId, EntityDetail assetEntity, List<EntityDetail> connectionEntities, OMRSRepositoryHelper repositoryHelper, String serviceName, String methodName) throws UserNotAuthorizedException, InvalidParameterException, PropertyServerException
  
  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:
  
  InvalidParameterException - one of the elements is invisible to the requesting user.
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.
  
  PropertyServerException - unable to retrieve necessary information to make the decision.
- validateUserForTypeCreate
  
  public void validateUserForTypeCreate(String userId, String metadataCollectionName, TypeDef typeDef) throws UserNotAuthorizedException, InvalidParameterException, PropertyServerException
  
  Tests for whether a specific user should have the right to create a type within a repository.
  
  Specified by:
  
  validateUserForTypeCreate in interface OpenMetadataRepositorySecurity
  
  Overrides:
  
  validateUserForTypeCreate in class OpenMetadataSecurityConnector
  
  Parameters:
  
  userId - identifier of user
  
  metadataCollectionName - configurable name of the metadata collection
  
  typeDef - type details
  
  Throws:
  
  InvalidParameterException - one of the elements is invisible to the requesting user.
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.
  
  PropertyServerException - unable to retrieve necessary information to make the decision.
- validateUserForTypeCreate
  
  public void validateUserForTypeCreate(String userId, String metadataCollectionName, AttributeTypeDef attributeTypeDef) throws UserNotAuthorizedException, InvalidParameterException, PropertyServerException
  
  Tests for whether a specific user should have the right to create a type within a repository.
  
  Specified by:
  
  validateUserForTypeCreate in interface OpenMetadataRepositorySecurity
  
  Overrides:
  
  validateUserForTypeCreate in class OpenMetadataSecurityConnector
  
  Parameters:
  
  userId - identifier of user
  
  metadataCollectionName - configurable name of the metadata collection
  
  attributeTypeDef - type details
  
  Throws:
  
  InvalidParameterException - one of the elements is invisible to the requesting user.
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.
  
  PropertyServerException - unable to retrieve necessary information to make the decision.
- validateUserForTypeRead
  
  public void validateUserForTypeRead(String userId, String metadataCollectionName, TypeDef typeDef) throws UserNotAuthorizedException, InvalidParameterException, PropertyServerException
  
  Tests for whether a specific user should have read access to a specific type within a repository.
  
  Specified by:
  
  validateUserForTypeRead in interface OpenMetadataRepositorySecurity
  
  Overrides:
  
  validateUserForTypeRead in class OpenMetadataSecurityConnector
  
  Parameters:
  
  userId - identifier of user
  
  metadataCollectionName - configurable name of the metadata collection
  
  typeDef - type details
  
  Throws:
  
  InvalidParameterException - one of the elements is invisible to the requesting user.
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.
  
  PropertyServerException - unable to retrieve necessary information to make the decision.
- validateUserForTypeRead
  
  public void validateUserForTypeRead(String userId, String metadataCollectionName, AttributeTypeDef attributeTypeDef) throws UserNotAuthorizedException, InvalidParameterException, PropertyServerException
  
  Tests for whether a specific user should have read access to a specific type within a repository.
  
  Specified by:
  
  validateUserForTypeRead in interface OpenMetadataRepositorySecurity
  
  Overrides:
  
  validateUserForTypeRead in class OpenMetadataSecurityConnector
  
  Parameters:
  
  userId - identifier of user
  
  metadataCollectionName - configurable name of the metadata collection
  
  attributeTypeDef - type details
  
  Throws:
  
  InvalidParameterException - one of the elements is invisible to the requesting user.
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.
  
  PropertyServerException - unable to retrieve necessary information to make the decision.
- validateUserForTypeUpdate
  
  public void validateUserForTypeUpdate(String userId, String metadataCollectionName, TypeDef typeDef, TypeDefPatch patch) throws UserNotAuthorizedException, InvalidParameterException, PropertyServerException
  
  Tests for whether a specific user should have the right to update a typeDef within a repository.
  
  Specified by:
  
  validateUserForTypeUpdate in interface OpenMetadataRepositorySecurity
  
  Overrides:
  
  validateUserForTypeUpdate in class OpenMetadataSecurityConnector
  
  Parameters:
  
  userId - identifier of user
  
  metadataCollectionName - configurable name of the metadata collection
  
  typeDef - current typeDef details
  
  patch - proposed changes to type
  
  Throws:
  
  InvalidParameterException - one of the elements is invisible to the requesting user.
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.
  
  PropertyServerException - unable to retrieve necessary information to make the decision.
- validateUserForTypeDelete
  
  public void validateUserForTypeDelete(String userId, String metadataCollectionName, TypeDef typeDef) throws UserNotAuthorizedException, InvalidParameterException, PropertyServerException
  
  Tests for whether a specific user should have the right to delete a type within a repository.
  
  Specified by:
  
  validateUserForTypeDelete in interface OpenMetadataRepositorySecurity
  
  Overrides:
  
  validateUserForTypeDelete in class OpenMetadataSecurityConnector
  
  Parameters:
  
  userId - identifier of user
  
  metadataCollectionName - configurable name of the metadata collection
  
  typeDef - type details
  
  Throws:
  
  InvalidParameterException - one of the elements is invisible to the requesting user.
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.
  
  PropertyServerException - unable to retrieve necessary information to make the decision.
- validateUserForTypeDelete
  
  public void validateUserForTypeDelete(String userId, String metadataCollectionName, AttributeTypeDef attributeTypeDef) throws UserNotAuthorizedException, InvalidParameterException, PropertyServerException
  
  Tests for whether a specific user should have the right to delete a type within a repository.
  
  Specified by:
  
  validateUserForTypeDelete in interface OpenMetadataRepositorySecurity
  
  Overrides:
  
  validateUserForTypeDelete in class OpenMetadataSecurityConnector
  
  Parameters:
  
  userId - identifier of user
  
  metadataCollectionName - configurable name of the metadata collection
  
  attributeTypeDef - type details
  
  Throws:
  
  InvalidParameterException - one of the elements is invisible to the requesting user.
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.
  
  PropertyServerException - unable to retrieve necessary information to make the decision.
- validateUserForTypeReIdentify
  
  public void validateUserForTypeReIdentify(String userId, String metadataCollectionName, TypeDef originalTypeDef, String newTypeDefGUID, String newTypeDefName) throws UserNotAuthorizedException, InvalidParameterException, PropertyServerException
  
  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
  
  Overrides:
  
  validateUserForTypeReIdentify in class OpenMetadataSecurityConnector
  
  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:
  
  InvalidParameterException - one of the elements is invisible to the requesting user.
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.
  
  PropertyServerException - unable to retrieve necessary information to make the decision.
- validateUserForTypeReIdentify
  
  public void validateUserForTypeReIdentify(String userId, String metadataCollectionName, AttributeTypeDef originalAttributeTypeDef, String newTypeDefGUID, String newTypeDefName) throws UserNotAuthorizedException, InvalidParameterException, PropertyServerException
  
  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
  
  Overrides:
  
  validateUserForTypeReIdentify in class OpenMetadataSecurityConnector
  
  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:
  
  InvalidParameterException - one of the elements is invisible to the requesting user.
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.
  
  PropertyServerException - unable to retrieve necessary information to make the decision.
- validateUserForEntityCreate
  
  public void validateUserForEntityCreate(String userId, String metadataCollectionName, String entityTypeGUID, InstanceProperties initialProperties, List<Classification> initialClassifications, InstanceStatus initialStatus) throws UserNotAuthorizedException, InvalidParameterException, PropertyServerException
  
  Tests for whether a specific user should have the right to create an instance within a repository.
  
  Specified by:
  
  validateUserForEntityCreate in interface OpenMetadataRepositorySecurity
  
  Overrides:
  
  validateUserForEntityCreate in class OpenMetadataSecurityConnector
  
  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:
  
  InvalidParameterException - one of the elements is invisible to the requesting user.
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.
  
  PropertyServerException - unable to retrieve necessary information to make the decision.
- validateUserForEntityRead
  
  public EntityDetail validateUserForEntityRead(String userId, String metadataCollectionName, EntityDetail instance) throws UserNotAuthorizedException, InvalidParameterException, PropertyServerException
  
  Tests for whether a specific user should have read access to a specific instance within a repository.
  
  Specified by:
  
  validateUserForEntityRead in interface OpenMetadataRepositorySecurity
  
  Overrides:
  
  validateUserForEntityRead in class OpenMetadataSecurityConnector
  
  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:
  
  InvalidParameterException - one of the elements is invisible to the requesting user.
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.
  
  PropertyServerException - unable to retrieve necessary information to make the decision.
- validateUserForEntitySummaryRead
  
  public void validateUserForEntitySummaryRead(String userId, String metadataCollectionName, EntitySummary instance) throws UserNotAuthorizedException, InvalidParameterException, PropertyServerException
  
  Tests for whether a specific user should have read access to a specific instance within a repository.
  
  Specified by:
  
  validateUserForEntitySummaryRead in interface OpenMetadataRepositorySecurity
  
  Overrides:
  
  validateUserForEntitySummaryRead in class OpenMetadataSecurityConnector
  
  Parameters:
  
  userId - identifier of user
  
  metadataCollectionName - configurable name of the metadata collection
  
  instance - instance details
  
  Throws:
  
  InvalidParameterException - one of the elements is invisible to the requesting user.
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.
  
  PropertyServerException - unable to retrieve necessary information to make the decision.
- validateUserForEntityProxyRead
  
  public void validateUserForEntityProxyRead(String userId, String metadataCollectionName, EntityProxy instance) throws UserNotAuthorizedException, InvalidParameterException, PropertyServerException
  
  Tests for whether a specific user should have read access to a specific instance within a repository.
  
  Specified by:
  
  validateUserForEntityProxyRead in interface OpenMetadataRepositorySecurity
  
  Overrides:
  
  validateUserForEntityProxyRead in class OpenMetadataSecurityConnector
  
  Parameters:
  
  userId - identifier of user
  
  metadataCollectionName - configurable name of the metadata collection
  
  instance - instance details
  
  Throws:
  
  InvalidParameterException - one of the elements is invisible to the requesting user.
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.
  
  PropertyServerException - unable to retrieve necessary information to make the decision.
- validateUserForEntityUpdate
  
  public void validateUserForEntityUpdate(String userId, String metadataCollectionName, EntityDetail instance) throws UserNotAuthorizedException, InvalidParameterException, PropertyServerException
  
  Tests for whether a specific user should have the right to update an instance within a repository.
  
  Specified by:
  
  validateUserForEntityUpdate in interface OpenMetadataRepositorySecurity
  
  Overrides:
  
  validateUserForEntityUpdate in class OpenMetadataSecurityConnector
  
  Parameters:
  
  userId - identifier of user
  
  metadataCollectionName - configurable name of the metadata collection
  
  instance - instance details
  
  Throws:
  
  InvalidParameterException - one of the elements is invisible to the requesting user.
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.
  
  PropertyServerException - unable to retrieve necessary information to make the decision.
- validateUserForEntityClassificationAdd
  
  public void validateUserForEntityClassificationAdd(String userId, String metadataCollectionName, EntitySummary instance, String classificationName, InstanceProperties properties) throws UserNotAuthorizedException, InvalidParameterException, PropertyServerException
  
  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
  
  Overrides:
  
  validateUserForEntityClassificationAdd in class OpenMetadataSecurityConnector
  
  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:
  
  InvalidParameterException - one of the elements is invisible to the requesting user.
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.
  
  PropertyServerException - unable to retrieve necessary information to make the decision.
- validateUserForEntityClassificationUpdate
  
  public void validateUserForEntityClassificationUpdate(String userId, String metadataCollectionName, EntitySummary instance, String classificationName, InstanceProperties properties) throws UserNotAuthorizedException, InvalidParameterException, PropertyServerException
  
  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
  
  Overrides:
  
  validateUserForEntityClassificationUpdate in class OpenMetadataSecurityConnector
  
  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:
  
  InvalidParameterException - one of the elements is invisible to the requesting user.
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.
  
  PropertyServerException - unable to retrieve necessary information to make the decision.
- validateUserForEntityClassificationDelete
  
  public void validateUserForEntityClassificationDelete(String userId, String metadataCollectionName, EntitySummary instance, String classificationName) throws UserNotAuthorizedException, InvalidParameterException, PropertyServerException
  
  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
  
  Overrides:
  
  validateUserForEntityClassificationDelete in class OpenMetadataSecurityConnector
  
  Parameters:
  
  userId - identifier of user
  
  metadataCollectionName - configurable name of the metadata collection
  
  instance - instance details
  
  classificationName - String name for the classification.
  
  Throws:
  
  InvalidParameterException - one of the elements is invisible to the requesting user.
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.
  
  PropertyServerException - unable to retrieve necessary information to make the decision.
- validateUserForEntityDelete
  
  public void validateUserForEntityDelete(String userId, String metadataCollectionName, EntityDetail instance) throws UserNotAuthorizedException, InvalidParameterException, PropertyServerException
  
  Tests for whether a specific user should have the right to delete an instance within a repository.
  
  Specified by:
  
  validateUserForEntityDelete in interface OpenMetadataRepositorySecurity
  
  Overrides:
  
  validateUserForEntityDelete in class OpenMetadataSecurityConnector
  
  Parameters:
  
  userId - identifier of user
  
  metadataCollectionName - configurable name of the metadata collection
  
  instance - instance details
  
  Throws:
  
  InvalidParameterException - one of the elements is invisible to the requesting user.
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.
  
  PropertyServerException - unable to retrieve necessary information to make the decision.
- validateUserForEntityRestore
  
  public void validateUserForEntityRestore(String userId, String metadataCollectionName, String deletedEntityGUID) throws UserNotAuthorizedException, InvalidParameterException, PropertyServerException
  
  Tests for whether a specific user should have the right to restore an instance within a repository.
  
  Specified by:
  
  validateUserForEntityRestore in interface OpenMetadataRepositorySecurity
  
  Overrides:
  
  validateUserForEntityRestore in class OpenMetadataSecurityConnector
  
  Parameters:
  
  userId - identifier of user
  
  metadataCollectionName - configurable name of the metadata collection
  
  deletedEntityGUID - String unique identifier (guid) for the entity.
  
  Throws:
  
  InvalidParameterException - one of the elements is invisible to the requesting user.
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.
  
  PropertyServerException - unable to retrieve necessary information to make the decision.
- validateUserForEntityReIdentification
  
  public void validateUserForEntityReIdentification(String userId, String metadataCollectionName, EntityDetail instance, String newGUID) throws UserNotAuthorizedException, InvalidParameterException, PropertyServerException
  
  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
  
  Overrides:
  
  validateUserForEntityReIdentification in class OpenMetadataSecurityConnector
  
  Parameters:
  
  userId - identifier of user
  
  metadataCollectionName - configurable name of the metadata collection
  
  instance - instance details
  
  newGUID - the new guid for the instance.
  
  Throws:
  
  InvalidParameterException - one of the elements is invisible to the requesting user.
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.
  
  PropertyServerException - unable to retrieve necessary information to make the decision.
- validateUserForEntityReTyping
  
  public void validateUserForEntityReTyping(String userId, String metadataCollectionName, EntityDetail instance, TypeDefSummary newTypeDefSummary) throws UserNotAuthorizedException, InvalidParameterException, PropertyServerException
  
  Tests for whether a specific user should have the right to change the type name of an instance within a repository.
  
  Specified by:
  
  validateUserForEntityReTyping in interface OpenMetadataRepositorySecurity
  
  Overrides:
  
  validateUserForEntityReTyping in class OpenMetadataSecurityConnector
  
  Parameters:
  
  userId - identifier of user
  
  metadataCollectionName - configurable name of the metadata collection
  
  instance - instance details
  
  newTypeDefSummary - details of this instance's new TypeDef.
  
  Throws:
  
  InvalidParameterException - one of the elements is invisible to the requesting user.
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.
  
  PropertyServerException - unable to retrieve necessary information to make the decision.
- validateUserForEntityReHoming
  
  public void validateUserForEntityReHoming(String userId, String metadataCollectionName, EntityDetail instance, String newHomeMetadataCollectionId, String newHomeMetadataCollectionName) throws UserNotAuthorizedException, InvalidParameterException, PropertyServerException
  
  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
  
  Overrides:
  
  validateUserForEntityReHoming in class OpenMetadataSecurityConnector
  
  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:
  
  InvalidParameterException - one of the elements is invisible to the requesting user.
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.
  
  PropertyServerException - unable to retrieve necessary information to make the decision.
- validateUserForRelationshipCreate
  
  public void validateUserForRelationshipCreate(String userId, String metadataCollectionName, String relationshipTypeGUID, InstanceProperties initialProperties, EntitySummary entityOneSummary, EntitySummary entityTwoSummary, InstanceStatus initialStatus) throws UserNotAuthorizedException, InvalidParameterException, PropertyServerException
  
  Tests for whether a specific user should have the right to create an instance within a repository.
  
  Specified by:
  
  validateUserForRelationshipCreate in interface OpenMetadataRepositorySecurity
  
  Overrides:
  
  validateUserForRelationshipCreate in class OpenMetadataSecurityConnector
  
  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:
  
  InvalidParameterException - one of the elements is invisible to the requesting user.
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.
  
  PropertyServerException - unable to retrieve necessary information to make the decision.
- validateUserForRelationshipRead
  
  public Relationship validateUserForRelationshipRead(String userId, String metadataCollectionName, Relationship instance) throws UserNotAuthorizedException, InvalidParameterException, PropertyServerException
  
  Tests for whether a specific user should have read access to a specific instance within a repository.
  
  Specified by:
  
  validateUserForRelationshipRead in interface OpenMetadataRepositorySecurity
  
  Overrides:
  
  validateUserForRelationshipRead in class OpenMetadataSecurityConnector
  
  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:
  
  InvalidParameterException - one of the elements is invisible to the requesting user.
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.
  
  PropertyServerException - unable to retrieve necessary information to make the decision.
- validateUserForRelationshipUpdate
  
  public void validateUserForRelationshipUpdate(String userId, String metadataCollectionName, Relationship instance) throws UserNotAuthorizedException, InvalidParameterException, PropertyServerException
  
  Tests for whether a specific user should have the right to update an instance within a repository.
  
  Specified by:
  
  validateUserForRelationshipUpdate in interface OpenMetadataRepositorySecurity
  
  Overrides:
  
  validateUserForRelationshipUpdate in class OpenMetadataSecurityConnector
  
  Parameters:
  
  userId - identifier of user
  
  metadataCollectionName - configurable name of the metadata collection
  
  instance - instance details
  
  Throws:
  
  InvalidParameterException - one of the elements is invisible to the requesting user.
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.
  
  PropertyServerException - unable to retrieve necessary information to make the decision.
- validateUserForRelationshipDelete
  
  public void validateUserForRelationshipDelete(String userId, String metadataCollectionName, Relationship instance) throws UserNotAuthorizedException, InvalidParameterException, PropertyServerException
  
  Tests for whether a specific user should have the right to delete an instance within a repository.
  
  Specified by:
  
  validateUserForRelationshipDelete in interface OpenMetadataRepositorySecurity
  
  Overrides:
  
  validateUserForRelationshipDelete in class OpenMetadataSecurityConnector
  
  Parameters:
  
  userId - identifier of user
  
  metadataCollectionName - configurable name of the metadata collection
  
  instance - instance details
  
  Throws:
  
  InvalidParameterException - one of the elements is invisible to the requesting user.
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.
  
  PropertyServerException - unable to retrieve necessary information to make the decision.
- validateUserForRelationshipRestore
  
  public void validateUserForRelationshipRestore(String userId, String metadataCollectionName, String deletedRelationshipGUID) throws UserNotAuthorizedException, InvalidParameterException, PropertyServerException
  
  Tests for whether a specific user should have the right to restore an instance within a repository.
  
  Specified by:
  
  validateUserForRelationshipRestore in interface OpenMetadataRepositorySecurity
  
  Overrides:
  
  validateUserForRelationshipRestore in class OpenMetadataSecurityConnector
  
  Parameters:
  
  userId - identifier of user
  
  metadataCollectionName - configurable name of the metadata collection
  
  deletedRelationshipGUID - String unique identifier (guid) for the relationship.
  
  Throws:
  
  InvalidParameterException - one of the elements is invisible to the requesting user.
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.
  
  PropertyServerException - unable to retrieve necessary information to make the decision.
- validateUserForRelationshipReIdentification
  
  public void validateUserForRelationshipReIdentification(String userId, String metadataCollectionName, Relationship instance, String newGUID) throws UserNotAuthorizedException, InvalidParameterException, PropertyServerException
  
  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
  
  Overrides:
  
  validateUserForRelationshipReIdentification in class OpenMetadataSecurityConnector
  
  Parameters:
  
  userId - identifier of user
  
  metadataCollectionName - configurable name of the metadata collection
  
  instance - instance details
  
  newGUID - the new guid for the instance.
  
  Throws:
  
  InvalidParameterException - one of the elements is invisible to the requesting user.
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.
  
  PropertyServerException - unable to retrieve necessary information to make the decision.
- validateUserForRelationshipReTyping
  
  public void validateUserForRelationshipReTyping(String userId, String metadataCollectionName, Relationship instance, TypeDefSummary newTypeDefSummary) throws UserNotAuthorizedException, InvalidParameterException, PropertyServerException
  
  Tests for whether a specific user should have the right to change the type name of an instance within a repository.
  
  Specified by:
  
  validateUserForRelationshipReTyping in interface OpenMetadataRepositorySecurity
  
  Overrides:
  
  validateUserForRelationshipReTyping in class OpenMetadataSecurityConnector
  
  Parameters:
  
  userId - identifier of user
  
  metadataCollectionName - configurable name of the metadata collection
  
  instance - instance details
  
  newTypeDefSummary - details of this instance's new TypeDef.
  
  Throws:
  
  InvalidParameterException - one of the elements is invisible to the requesting user.
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.
  
  PropertyServerException - unable to retrieve necessary information to make the decision.
- validateUserForRelationshipReHoming
  
  public void validateUserForRelationshipReHoming(String userId, String metadataCollectionName, Relationship instance, String newHomeMetadataCollectionId, String newHomeMetadataCollectionName) throws UserNotAuthorizedException, InvalidParameterException, PropertyServerException
  
  Tests for whether a specific user should have the right to change the home of a instance within a repository.
  
  Specified by:
  
  validateUserForRelationshipReHoming in interface OpenMetadataRepositorySecurity
  
  Overrides:
  
  validateUserForRelationshipReHoming in class OpenMetadataSecurityConnector
  
  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:
  
  InvalidParameterException - one of the elements is invisible to the requesting user.
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.
  
  PropertyServerException - unable to retrieve necessary information to make the decision.
- validateEntityReferenceCopySave
  
  public boolean validateEntityReferenceCopySave(String userId, EntityDetail instance) throws UserNotAuthorizedException, InvalidParameterException, PropertyServerException
  
  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:
  
  InvalidParameterException - one of the elements is invisible to the requesting user.
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.
  
  PropertyServerException - unable to retrieve necessary information to make the decision.
- validateRelationshipReferenceCopySave
  
  public boolean validateRelationshipReferenceCopySave(String userId, Relationship instance) throws UserNotAuthorizedException, InvalidParameterException, PropertyServerException
  
  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:
  
  InvalidParameterException - one of the elements is invisible to the requesting user.
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.
  
  PropertyServerException - unable to retrieve necessary information to make the decision.

Class OpenMetadataAccessSecurityConnector

Nested Class Summary

Nested classes/interfaces inherited from class org.odpi.openmetadata.frameworks.connectors.ConnectorBase

Field Summary

Fields inherited from class org.odpi.openmetadata.metadatasecurity.connectors.OpenMetadataSecurityConnector

Fields inherited from class org.odpi.openmetadata.frameworks.connectors.ConnectorBase

Constructor Summary

Method Summary

Methods inherited from class org.odpi.openmetadata.metadatasecurity.connectors.OpenMetadataSecurityConnector

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.ConnectorBase

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.Connector

Methods inherited from class java.lang.Object

Methods inherited from interface org.odpi.openmetadata.metadatasecurity.OpenMetadataPlatformSecurity

Constructor Details

OpenMetadataAccessSecurityConnector

Method Details

start

getUserAccount

setUserAccount

deleteUserAccount

validateUserInGroup

validateUserForNewServer

validateUserAsOperatorForPlatform

validateUserAsInvestigatorForPlatform

validateUserForServer

validateUserAsServerAdmin

validateUserAsServerOperator

validateUserAsServerInvestigator

validateUserForService

validateUserForServiceOperation

getAssociatedSecurityListForZone

getDefaultZonesForUser

getPublishZonesForUser

getWithdrawZonesForUser

validateZoneAccess

validateUserForElementCreate

validateUserForElementRead

validateUserForAnchorMemberRead

validateUserForElementDetailUpdate

validateUserForElementStatusUpdate

validateUserForElementAttach

validateUserForElementDetach

validateUserForElementAddFeedback

validateUserForElementDeleteFeedback

validateUserForElementClassify

validateUserForElementDeclassify

validateUserForAnchorMemberCreate

validateUserForAnchorMemberUpdate

validateUserForAnchorMemberStatusUpdate

validateUserForAnchorAttach

validateUserForAnchorDetach

validateUserForAnchorAddFeedback

validateUserForAnchorDeleteFeedback

validateUserForAnchorClassify

validateUserForAnchorDeclassify

validateUserForAnchorMemberDelete

validateUserForElementDelete

validateUserForAnchorMemberAdd

selectConnection

validateUserForTypeCreate

validateUserForTypeCreate

validateUserForTypeRead

validateUserForTypeRead

validateUserForTypeUpdate

validateUserForTypeDelete

validateUserForTypeDelete

validateUserForTypeReIdentify

validateUserForTypeReIdentify

validateUserForEntityCreate

validateUserForEntityRead

validateUserForEntitySummaryRead

validateUserForEntityProxyRead

validateUserForEntityUpdate

validateUserForEntityClassificationAdd

validateUserForEntityClassificationUpdate

validateUserForEntityClassificationDelete

validateUserForEntityDelete

validateUserForEntityRestore

validateUserForEntityReIdentification

validateUserForEntityReTyping