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

Class RestoreEntityExecutor

java.lang.Object

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

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

All Implemented Interfaces:

RepositoryExecutor

public class RestoreEntityExecutor
extends RepositoryExecutorBase

RestoreEntityExecutor provides the executor for the restoreEntity method. This is a tricky request because the entity has been deleted so it is not retrievable until restored. Also, this is an optional function so the repository where the entity has its home may not support restore. 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
RestoreEntityExecutor(String userId, String entityGUID, AuditLog auditLog, String methodName)	Constructor takes the parameters for the request.

Method Summary

Modifier and Type	Method	Description
EntityDetail	getRestoredEntity()	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

RestoreEntityExecutor

public RestoreEntityExecutor(String userId,
 String entityGUID,
 AuditLog auditLog,
 String methodName)

Constructor takes the parameters for the request.

Parameters:

userId - unique identifier for requesting user

entityGUID - 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

getRestoredEntity

public EntityDetail getRestoredEntity()
                               throws InvalidParameterException,
RepositoryErrorException,
EntityNotKnownException,
EntityNotDeletedException,
FunctionNotSupportedException,
UserNotAuthorizedException

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

Returns:

EntityDetail showing the restored entity header, properties and classifications.

Throws:

InvalidParameterException - the guid is 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 currently not in DELETED status and so it can not be restored

FunctionNotSupportedException - the repository does not support soft-deletes.

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