Package org.openmetadata.service.jdbi3

Class RoleRepository

java.lang.Object

org.openmetadata.service.jdbi3.EntityRepository<Role>

org.openmetadata.service.jdbi3.RoleRepository

public class RoleRepository
extends EntityRepository<Role>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	RoleRepository.RoleUpdater	Handles entity updated from PUT and POST operation.

Nested classes/interfaces inherited from class org.openmetadata.service.jdbi3.EntityRepository

EntityRepository.EntityUpdater, EntityRepository.Operation

Field Summary

Fields inherited from class org.openmetadata.service.jdbi3.EntityRepository

allowedFields, CACHE_WITH_ID, CACHE_WITH_NAME, dao, daoCollection, entityType, putFields, quoteFqn, supportsExtension, supportsFollower, supportsOwner, supportsSoftDelete, supportsTags, supportsVotes

Constructor Summary

Constructors

Constructor	Description
RoleRepository(CollectionDAO dao)

Method Summary

Modifier and Type	Method	Description
Role	clearFields(Role role, EntityUtil.Fields fields)	Set the requested fields in an entity.
RoleRepository.RoleUpdater	getUpdater(Role original, Role updated, EntityRepository.Operation operation)
protected void	preDelete(Role entity)
void	prepare(Role role)	If policy does not exist for this role, create a new entity reference.
void	restorePatchAttributes(Role original, Role updated)	PATCH operations can't overwrite certain fields, such as entity ID, fullyQualifiedNames etc.
Role	setFields(Role role, EntityUtil.Fields fields)	Set the requested fields in an entity.
void	storeEntity(Role role, boolean update)	For regular incoming POST, PUT, PATCH operation calls, prepare(Role) would create a policy entity reference if it does not exist.
void	storeRelationships(Role role)	This method is called to store all the relationships of an entity.

Methods inherited from class org.openmetadata.service.jdbi3.EntityRepository

addDerivedTags, addFollower, addRelationship, addRelationship, addRelationship, applyTags, applyTags, bulkAddToRelationship, checkSystemEntityDeletion, cleanup, clearFieldsInternal, create, createInternal, createOrUpdate, createOrUpdateInternal, delete, deleteByName, deleteExtensionAtTimestamp, deleteExtensionBeforeTimestamp, deleteFollower, deleteFrom, deleteInternal, deleteInternalByName, deleteRelationship, deleteTo, ensureSingleRelationship, exportToCsv, find, findBoth, findByName, findByNameOrNull, findFrom, findFromRecords, findTo, findToRecords, get, get, getAllowedFieldsCopy, getAllTags, getByName, getByName, getChildren, getCommonFields, getContainer, getCustomPropertyFQN, getCustomPropertyFQNPrefix, getEntitiesFromSeedData, getEntitiesFromSeedData, getEntitiesFromSeedData, getExtension, getExtensionAtTimestamp, getExtensionAtTimestampWithOperation, getFields, getFields, getFollowers, getFromEntityRef, getHref, getIngestionPipelines, getLatestExtensionFromTimeseries, getOwner, getOwner, getParent, getReference, getReferenceByName, getResultList, getResultList, getResultsFromAndToTimestamps, getResultsFromAndToTimestamps, getReviewers, getTags, getTags, getToEntityRef, getVersion, getVotes, importFromCsv, initializeEntity, initSeedDataFromResources, listAfter, listAfterWithSkipFailure, listAll, listBefore, listVersions, patch, populateOwner, postCreate, postDelete, postUpdate, prepareInternal, removeExtension, restoreEntity, setFieldsInternal, setFullyQualifiedName, setInheritedFields, store, storeExtension, storeOwner, storeRelationshipsInternal, storeTimeSeries, storeTimeSeriesWithOperation, update, update, updateOwner, updateVote, validateOwner, validateRoles, validateUsers, withHref

Methods inherited from class java.lang.Object

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

Constructor Detail

RoleRepository

public RoleRepository(CollectionDAO dao)

Method Detail

setFields

public Role setFields(Role role,
                      EntityUtil.Fields fields)

Description copied from class: EntityRepository

Set the requested fields in an entity. This is used for requesting specific fields in the object during GET operations. It is also used during PUT and PATCH operations to set up fields that can be updated.

Specified by:

setFields in class EntityRepository<Role>

clearFields

public Role clearFields(Role role,
                        EntityUtil.Fields fields)

Description copied from class: EntityRepository

Set the requested fields in an entity. This is used for requesting specific fields in the object during GET operations. It is also used during PUT and PATCH operations to set up fields that can be updated.

Specified by:

clearFields in class EntityRepository<Role>

restorePatchAttributes

public void restorePatchAttributes(Role original,
                                   Role updated)

Description copied from class: EntityRepository

PATCH operations can't overwrite certain fields, such as entity ID, fullyQualifiedNames etc. Instead of throwing an error, we take lenient approach of ignoring the user error and restore those attributes based on what is already stored in the original entity.

Overrides:

restorePatchAttributes in class EntityRepository<Role>

prepare

public void prepare(Role role)

If policy does not exist for this role, create a new entity reference. The actual policy gets created within the storeEntity method call.

Specified by:

prepare in class EntityRepository<Role>

See Also:

for an example implementation

storeEntity

public void storeEntity(Role role,
                        boolean update)

For regular incoming POST, PUT, PATCH operation calls, prepare(Role) would create a policy entity reference if it does not exist.

This method ensures that the role and its policy are stored correctly.

Specified by:

storeEntity in class EntityRepository<Role>

See Also:

for an example implementation

storeRelationships

public void storeRelationships(Role role)

Description copied from class: EntityRepository

This method is called to store all the relationships of an entity. It is expected that all relationships are already validated and completely setup before this method is called and no validation of relationships is required.

Specified by:

storeRelationships in class EntityRepository<Role>

See Also:

for an example implementation

getUpdater

public RoleRepository.RoleUpdater getUpdater(Role original,
                                             Role updated,
                                             EntityRepository.Operation operation)

Overrides:

getUpdater in class EntityRepository<Role>

preDelete

protected void preDelete(Role entity)

Overrides:

preDelete in class EntityRepository<Role>