org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore

Interface OpenMetadataRepositorySecurity

All Known Implementing Classes:

OMRSMetadataSecurity

public interface OpenMetadataRepositorySecurity

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

Method Summary

Modifier and Type	Method and Description
void	validateUserForEntityClassificationUpdate(String userId, String metadataCollectionName, EntityDetail instance, Classification classification) 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, EntityDetail instance) Tests for whether a specific user should have the right to create a instance within a repository.
void	validateUserForEntityDelete(String userId, String metadataCollectionName, EntityDetail instance) Tests for whether a specific user should have the right to delete a 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.
void	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	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 a instance within a repository.
void	validateUserForRelationshipCreate(String userId, String metadataCollectionName, Relationship instance) Tests for whether a specific user should have the right to create a instance within a repository.
void	validateUserForRelationshipDelete(String userId, String metadataCollectionName, Relationship instance) Tests for whether a specific user should have the right to delete a instance within a repository.
void	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	validateUserForRelationshipUpdate(String userId, String metadataCollectionName, Relationship instance) Tests for whether a specific user should have the right to update a instance within a repository.
void	validateUserForTypeCreate(String userId, String metadataCollectionName, TypeDef typeDef) Tests for whether a specific user should have the right to create a typeDef within a repository.
void	validateUserForTypeDelete(String userId, String metadataCollectionName, TypeDef typeDef) Tests for whether a specific user should have the right to delete a typeDef within a repository.
void	validateUserForTypeRead(String userId, String metadataCollectionName, TypeDef typeDef) Tests for whether a specific user should have read access to a specific typeDef within a repository.
void	validateUserForTypeUpdate(String userId, String metadataCollectionName, TypeDef typeDef) Tests for whether a specific user should have the right to update a typeDef within a repository.

Method Detail

validateUserForTypeCreate

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

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

Parameters:

userId - identifier of user

metadataCollectionName - configurable name of the metadata collection

typeDef - typeDef details

Throws:

UserNotAuthorizedException - the user is not authorized to maintain types

validateUserForTypeRead

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

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

Parameters:

userId - identifier of user

metadataCollectionName - configurable name of the metadata collection

typeDef - typeDef details

Throws:

UserNotAuthorizedException - the user is not authorized to retrieve types

validateUserForTypeUpdate

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

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

Parameters:

userId - identifier of user

metadataCollectionName - configurable name of the metadata collection

typeDef - typeDef details

Throws:

UserNotAuthorizedException - the user is not authorized to maintain types

validateUserForTypeDelete

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

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

Parameters:

userId - identifier of user

metadataCollectionName - configurable name of the metadata collection

typeDef - typeDef details

Throws:

UserNotAuthorizedException - the user is not authorized to maintain types

validateUserForEntityCreate

void validateUserForEntityCreate(String userId,
                                 String metadataCollectionName,
                                 EntityDetail instance)
                          throws UserNotAuthorizedException

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

Parameters:

userId - identifier of user

metadataCollectionName - configurable name of the metadata collection

instance - instance details

Throws:

UserNotAuthorizedException - the user is not authorized to maintain instances

validateUserForEntityRead

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

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

Parameters:

userId - identifier of user

metadataCollectionName - configurable name of the metadata collection

instance - instance details

Throws:

UserNotAuthorizedException - the user is not authorized to retrieve instances

validateUserForEntitySummaryRead

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

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

Parameters:

userId - identifier of user

metadataCollectionName - configurable name of the metadata collection

instance - instance details

Throws:

UserNotAuthorizedException - the user is not authorized to retrieve instances

validateUserForEntityProxyRead

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

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

Parameters:

userId - identifier of user

metadataCollectionName - configurable name of the metadata collection

instance - instance details

Throws:

UserNotAuthorizedException - the user is not authorized to retrieve instances

validateUserForEntityUpdate

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

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

Parameters:

userId - identifier of user

metadataCollectionName - configurable name of the metadata collection

instance - instance details

Throws:

UserNotAuthorizedException - the user is not authorized to maintain instances

validateUserForEntityClassificationUpdate

void validateUserForEntityClassificationUpdate(String userId,
                                               String metadataCollectionName,
                                               EntityDetail instance,
                                               Classification classification)
                                        throws UserNotAuthorizedException

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

Parameters:

userId - identifier of user

metadataCollectionName - configurable name of the metadata collection

instance - instance details

classification - classification details

Throws:

UserNotAuthorizedException - the user is not authorized to maintain instances

validateUserForEntityDelete

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

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

Parameters:

userId - identifier of user

metadataCollectionName - configurable name of the metadata collection

instance - instance details

Throws:

UserNotAuthorizedException - the user is not authorized to maintain instances

validateUserForRelationshipCreate

void validateUserForRelationshipCreate(String userId,
                                       String metadataCollectionName,
                                       Relationship instance)
                                throws UserNotAuthorizedException

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

Parameters:

userId - identifier of user

metadataCollectionName - configurable name of the metadata collection

instance - instance details

Throws:

UserNotAuthorizedException - the user is not authorized to maintain instances

validateUserForRelationshipRead

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

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

Parameters:

userId - identifier of user

metadataCollectionName - configurable name of the metadata collection

instance - instance details

Throws:

UserNotAuthorizedException - the user is not authorized to retrieve instances

validateUserForRelationshipUpdate

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

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

Parameters:

userId - identifier of user

metadataCollectionName - configurable name of the metadata collection

instance - instance details

Throws:

UserNotAuthorizedException - the user is not authorized to maintain instances

validateUserForRelationshipDelete

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

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

Parameters:

userId - identifier of user

metadataCollectionName - configurable name of the metadata collection

instance - instance details

Throws:

UserNotAuthorizedException - the user is not authorized to maintain instances