Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/* SPDX-License-Identifier: Apache 2.0 */
/* Copyright Contributors to the ODPi Egeria project. */
package org.odpi.openmetadata.commonservices.generichandlers;
import org.odpi.openmetadata.commonservices.ffdc.InvalidParameterHandler;
import org.odpi.openmetadata.commonservices.repositoryhandler.RepositoryHandler;
import org.odpi.openmetadata.frameworks.auditlog.AuditLog;
import org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException;
import org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException;
import org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException;
import org.odpi.openmetadata.metadatasecurity.server.OpenMetadataServerSecurityVerifier;
import org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceStatus;
import org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.repositoryconnector.OMRSRepositoryHelper;
import java.util.Date;
import java.util.List;
import java.util.Map;
/**
* DiscoveryAnalysisReportHandler manages the storage and retrieval of metadata relating to discovery
* analysis reports as defined in the Open Discovery Framework (ODF).
*/
public class DiscoveryAnalysisReportHandler extends OpenMetadataAPIGenericHandler
{
/**
* Construct the handler with information needed to work with B objects.
*
* @param converter specific converter for this bean class
* @param beanClass name of bean class that is represented by the generic class B
* @param serviceName name of this service
* @param serverName name of the local server
* @param invalidParameterHandler handler for managing parameter errors
* @param repositoryHandler manages calls to the repository services
* @param repositoryHelper provides utilities for manipulating the repository services objects
* @param localServerUserId userId for this server
* @param securityVerifier open metadata security services verifier
* @param supportedZones list of zones that the access service is allowed to serve B instances from.
* @param defaultZones list of zones that the access service should set in all new B instances.
* @param publishZones list of zones that the access service sets up in published B instances.
* @param auditLog destination for audit log events.
*/
public DiscoveryAnalysisReportHandler(OpenMetadataAPIGenericConverter converter,
Class beanClass,
String serviceName,
String serverName,
InvalidParameterHandler invalidParameterHandler,
RepositoryHandler repositoryHandler,
OMRSRepositoryHelper repositoryHelper,
String localServerUserId,
OpenMetadataServerSecurityVerifier securityVerifier,
List supportedZones,
List defaultZones,
List publishZones,
AuditLog auditLog)
{
super(converter,
beanClass,
serviceName,
serverName,
invalidParameterHandler,
repositoryHandler,
repositoryHelper,
localServerUserId,
securityVerifier,
supportedZones,
defaultZones,
publishZones,
auditLog);
}
/**
* Create a new discovery analysis report and chain it to its asset, discovery engine and discovery service.
*
* @param userId calling user
* @param qualifiedName unique name for the report
* @param displayName short name for the report
* @param description description of the report
* @param creationDate data of the report
* @param analysisParameters analysis parameters passed to the discovery service
* @param discoveryRequestStatus current status of the discovery processing
* @param assetGUID unique identifier of the asset being analysed
* @param discoveryEngineGUID unique identifier of the discovery engine that is running the discovery service
* @param discoveryServiceGUID unique identifier of the discovery service creating the report
* @param additionalProperties additional properties for the report
* @param methodName calling method
*
* @return The new discovery report.
* @throws InvalidParameterException one of the parameters is invalid
* @throws UserNotAuthorizedException the user is not authorized to access the asset and/or report
* @throws PropertyServerException there was a problem in the store whether the asset/report properties are kept.
*/
public String createDiscoveryAnalysisReport(String userId,
String qualifiedName,
String displayName,
String description,
Date creationDate,
Map analysisParameters,
int discoveryRequestStatus,
String assetGUID,
String discoveryEngineGUID,
String discoveryServiceGUID,
Map additionalProperties,
String methodName) throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException
{
final String nameParameterName = "qualifiedName";
final String assetGUIDParameterName = "assetGUID";
final String discoveryEngineGUIDParameterName = "discoveryEngineGUID";
final String discoveryServiceGUIDParameterName = "discoveryServiceGUID";
invalidParameterHandler.validateName(qualifiedName, nameParameterName, methodName);
invalidParameterHandler.validateGUID(assetGUID, assetGUIDParameterName, methodName);
invalidParameterHandler.validateGUID(discoveryEngineGUID, discoveryEngineGUIDParameterName, methodName);
invalidParameterHandler.validateGUID(discoveryServiceGUID, discoveryServiceGUIDParameterName, methodName);
Date effectiveTime = new Date();
repositoryHandler.getEntityByGUID(userId,
assetGUID,
assetGUIDParameterName,
OpenMetadataAPIMapper.ASSET_TYPE_NAME,
false,
false,
effectiveTime,
methodName);
repositoryHandler.getEntityByGUID(userId,
discoveryEngineGUIDParameterName,
assetGUID,
OpenMetadataAPIMapper.DISCOVERY_ENGINE_TYPE_NAME,
false,
false,
effectiveTime,
methodName);
DiscoveryAnalysisReportBuilder builder = new DiscoveryAnalysisReportBuilder(qualifiedName,
displayName,
description,
creationDate,
analysisParameters,
discoveryRequestStatus,
additionalProperties,
null,
repositoryHelper,
serviceName,
serverName);
if (assetGUID != null)
{
builder.setAnchors(userId, assetGUID, methodName);
}
String reportGUID = repositoryHandler.createEntity(userId,
OpenMetadataAPIMapper.DISCOVERY_ANALYSIS_REPORT_TYPE_GUID,
OpenMetadataAPIMapper.DISCOVERY_ANALYSIS_REPORT_TYPE_NAME,
null,
null,
builder.getInstanceProperties(methodName),
null,
InstanceStatus.ACTIVE,
methodName);
if (reportGUID != null)
{
repositoryHandler.createRelationship(userId,
OpenMetadataAPIMapper.REPORT_TO_ASSET_TYPE_GUID,
null,
null,
assetGUID,
reportGUID,
null,
methodName);
repositoryHandler.createRelationship(userId,
OpenMetadataAPIMapper.REPORT_TO_ENGINE_TYPE_GUID,
null,
null,
discoveryEngineGUID,
reportGUID,
null,
methodName);
repositoryHandler.createRelationship(userId,
OpenMetadataAPIMapper.REPORT_TO_SERVICE_TYPE_GUID,
null,
null,
discoveryServiceGUID,
reportGUID,
null,
methodName);
}
return reportGUID;
}
/**
* Update the properties of the discovery analysis report.
*
* @param userId calling user.
* @param discoveryReportGUID identifier of the discovery report
* @param qualifiedName unique name for the report
* @param displayName short name for the report
* @param description description of the report
* @param creationDate data of the report
* @param analysisParameters analysis parameters passed to the discovery service
* @param discoveryRequestStatus current status of the discovery processing
* @param additionalProperties additional properties for the report
* @param methodName calling method
* @throws InvalidParameterException one of the parameters is null or invalid.
* @throws UserNotAuthorizedException user not authorized to issue this request.
* @throws PropertyServerException there was a problem that occurred within the property server.
*/
public void updateDiscoveryAnalysisReport(String userId,
String discoveryReportGUID,
String qualifiedName,
String displayName,
String description,
Date creationDate,
Map analysisParameters,
int discoveryRequestStatus,
Map additionalProperties,
String methodName) throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException
{
final String discoveryReportGUIDParameterName = "discoveryReportGUID";
DiscoveryAnalysisReportBuilder builder = new DiscoveryAnalysisReportBuilder(qualifiedName,
displayName,
description,
creationDate,
analysisParameters,
discoveryRequestStatus,
additionalProperties,
null,
repositoryHelper,
serviceName,
serverName);
this.updateBeanInRepository(userId,
null,
null,
discoveryReportGUID,
discoveryReportGUIDParameterName,
OpenMetadataAPIMapper.DISCOVERY_ANALYSIS_REPORT_TYPE_GUID,
OpenMetadataAPIMapper.DISCOVERY_ANALYSIS_REPORT_TYPE_NAME,
false,
false,
supportedZones,
builder.getInstanceProperties(methodName),
true,
new Date(),
methodName);
}
/**
* Request the discovery report for a discovery request that has completed.
*
* @param userId identifier of calling user
* @param discoveryReportGUID identifier of the discovery request.
* @param methodName calling method
*
* @return discovery report
*
* @throws InvalidParameterException one of the parameters is null or invalid.
* @throws UserNotAuthorizedException user not authorized to issue this request.
* @throws PropertyServerException there was a problem that occurred within the property server.
*/
public B getDiscoveryAnalysisReport(String userId,
String discoveryReportGUID,
String methodName) throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException
{
final String reportGUIDParameterName = "discoveryReportGUID";
return getBeanFromRepository(userId,
discoveryReportGUID,
reportGUIDParameterName,
OpenMetadataAPIMapper.DISCOVERY_ANALYSIS_REPORT_TYPE_NAME,
false,
false,
supportedZones,
new Date(),
methodName);
}
/**
* Return the discovery analysis reports about the asset.
*
* @param userId calling user
* @param assetGUID unique identifier of the asset
* @param startingFrom position in the list (used when there are so many reports that paging is needed
* @param maximumResults maximum number of elements to return an this call
* @param methodName calling method
*
* @return list of discovery analysis reports
*
* @throws InvalidParameterException one of the parameters is null or invalid.
* @throws UserNotAuthorizedException user not authorized to issue this request.
* @throws PropertyServerException there was a problem that occurred within the property server.
*/
public List getDiscoveryAnalysisReports(String userId,
String assetGUID,
int startingFrom,
int maximumResults,
String methodName) throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException
{
final String assetGUIDParameter = "assetGUID";
return this.getAttachedElements(userId,
assetGUID,
assetGUIDParameter,
OpenMetadataAPIMapper.ASSET_TYPE_NAME,
OpenMetadataAPIMapper.REPORT_TO_ASSET_TYPE_GUID,
OpenMetadataAPIMapper.REPORT_TO_ASSET_TYPE_NAME,
OpenMetadataAPIMapper.DISCOVERY_ANALYSIS_REPORT_TYPE_NAME,
startingFrom,
maximumResults,
new Date(),
methodName);
}
}
