Package org.odpi.openmetadata.repositoryservices.enterprise.repositoryconnector.executors

Class PurgeEntityExecutor

java.lang.Object

org.odpi.openmetadata.repositoryservices.enterprise.repositoryconnector.executors.RepositoryExecutorBase

org.odpi.openmetadata.repositoryservices.enterprise.repositoryconnector.executors.PurgeEntityExecutor

All Implemented Interfaces:

RepositoryExecutor

public class PurgeEntityExecutor
extends RepositoryExecutorBase

PurgeEntityExecutor provides the executor for the purgeEntity method. This is a tricky request because the entity has been deleted, so it is not retrievable until restored. The only possible approach is to step through the repositories hoping that one will respond positively.

Field Summary

Fields inherited from class org.odpi.openmetadata.repositoryservices.enterprise.repositoryconnector.executors.RepositoryExecutorBase

methodName, userId

Constructor Summary

Constructors

Constructor	Description
PurgeEntityExecutor(String userId, String typeDefGUID, String typeDefName, String entityGUID, AuditLog auditLog, String methodName)	Constructor takes the parameters for the request.

Method Summary

Modifier and Type	Method	Description
void	getResult()	Return the result of the execution.
boolean	issueRequestToRepository(String metadataCollectionId, OMRSMetadataCollection metadataCollection)	Perform the required action for the supplied repository.

Methods inherited from class org.odpi.openmetadata.repositoryservices.enterprise.repositoryconnector.executors.RepositoryExecutorBase

getMethodName

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.odpi.openmetadata.repositoryservices.enterprise.repositoryconnector.executors.RepositoryExecutor

augmentResultFromRepository, getResultsForAugmentation

Constructor Details

PurgeEntityExecutor

public PurgeEntityExecutor(String userId,
 String typeDefGUID,
 String typeDefName,
 String entityGUID,
 AuditLog auditLog,
 String methodName)

Constructor takes the parameters for the request.

Parameters:

userId - unique identifier for requesting user

typeDefGUID - unique identifier of the type of the entity to purge

typeDefName - unique name of the type of the entity to purge

entityGUID - String unique identifier (guid) for the entity

auditLog - logging destination

methodName - calling method

Method Details

issueRequestToRepository

public boolean issueRequestToRepository(String metadataCollectionId,
 OMRSMetadataCollection metadataCollection)

Perform the required action for the supplied repository. Create requests occur in the first repository that accepts the call. Some repositories may produce exceptions. These exceptions are saved and will be returned if there are no positive results from any repository.

Specified by:

issueRequestToRepository in interface RepositoryExecutor

Specified by:

issueRequestToRepository in class RepositoryExecutorBase

Parameters:

metadataCollectionId - unique identifier for the metadata collection for the repository

metadataCollection - metadata collection object for the repository

Returns:

boolean true means that the required results have been achieved

getResult

public void getResult()
               throws InvalidParameterException,
RepositoryErrorException,
EntityNotKnownException,
EntityNotDeletedException,
FunctionNotSupportedException,
UserNotAuthorizedException

Return the result of the execution. Hopefully this is a result - but may be an exception

Throws:

InvalidParameterException - one of the parameters is invalid or null.

RepositoryErrorException - there is a problem communicating with the metadata repository where the metadata collection is stored.

EntityNotKnownException - the entity identified by the guid is not found in the metadata collection

EntityNotDeletedException - the entity is not in DELETED status and so can not be purged

FunctionNotSupportedException - the repository does not support maintenance of metadata.

UserNotAuthorizedException - the userId is not permitted to perform this operation.