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.frameworks.connectors.ffdc.InvalidParameterException;
import org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.*;
import org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.repositoryconnector.OMRSRepositoryHelper;
import org.odpi.openmetadata.repositoryservices.ffdc.exception.TypeErrorException;
import java.util.Date;
import java.util.List;
import java.util.Map;
/**
* ReferenceableBuilder creates Open Metadata Repository Services (OMRS) objects based on the
* bean properties supplied in the constructor.
*/
public class ReferenceableBuilder extends OpenMetadataAPIGenericBuilder
{
protected String qualifiedName = null;
private Map additionalProperties = null;
/**
* Constructor for simple creates.
*
* @param repositoryHelper helper methods
* @param serviceName name of this OMAS
* @param serverName name of local server
*/
protected ReferenceableBuilder(OMRSRepositoryHelper repositoryHelper,
String serviceName,
String serverName)
{
super(OpenMetadataAPIMapper.REFERENCEABLE_TYPE_GUID,
OpenMetadataAPIMapper.REFERENCEABLE_TYPE_NAME,
repositoryHelper,
serviceName,
serverName);
}
/**
* Constructor for simple creates.
*
* @param qualifiedName unique name
* @param repositoryHelper helper methods
* @param serviceName name of this OMAS
* @param serverName name of local server
*/
protected ReferenceableBuilder(String qualifiedName,
OMRSRepositoryHelper repositoryHelper,
String serviceName,
String serverName)
{
super(OpenMetadataAPIMapper.REFERENCEABLE_TYPE_GUID,
OpenMetadataAPIMapper.REFERENCEABLE_TYPE_NAME,
repositoryHelper,
serviceName,
serverName);
this.qualifiedName = qualifiedName;
}
/**
* Constructor for simple creates.
*
* @param typeId type GUID to use for the entity
* @param typeName type name to use for the entity
* @param repositoryHelper helper methods
* @param serviceName name of this OMAS
* @param serverName name of local server
*/
protected ReferenceableBuilder(String typeId,
String typeName,
OMRSRepositoryHelper repositoryHelper,
String serviceName,
String serverName)
{
super(typeId,
typeName,
repositoryHelper,
serviceName,
serverName);
}
/**
* Constructor for simple creates.
*
* @param qualifiedName unique name
* @param typeName type name to use for the entity
* @param typeId type GUID to use for the entity
* @param repositoryHelper helper methods
* @param serviceName name of this OMAS
* @param serverName name of local server
*/
protected ReferenceableBuilder(String qualifiedName,
String typeId,
String typeName,
OMRSRepositoryHelper repositoryHelper,
String serviceName,
String serverName)
{
super(typeId,
typeName,
repositoryHelper,
serviceName,
serverName);
this.qualifiedName = qualifiedName;
}
/**
* Constructor for updates.
*
* @param qualifiedName unique name
* @param additionalProperties additional properties
* @param repositoryHelper helper methods
* @param serviceName name of this OMAS
* @param serverName name of local server
*/
protected ReferenceableBuilder(String qualifiedName,
Map additionalProperties,
OMRSRepositoryHelper repositoryHelper,
String serviceName,
String serverName)
{
super(OpenMetadataAPIMapper.REFERENCEABLE_TYPE_GUID,
OpenMetadataAPIMapper.REFERENCEABLE_TYPE_NAME,
repositoryHelper,
serviceName,
serverName);
this.qualifiedName = qualifiedName;
this.additionalProperties = additionalProperties;
}
/**
* Constructor for updates.
*
* @param qualifiedName unique name
* @param additionalProperties additional properties
* @param typeName type name to use for the entity
* @param typeId type GUID to use for the entity
* @param repositoryHelper helper methods
* @param serviceName name of this OMAS
* @param serverName name of local server
*/
protected ReferenceableBuilder(String qualifiedName,
Map additionalProperties,
String typeId,
String typeName,
OMRSRepositoryHelper repositoryHelper,
String serviceName,
String serverName)
{
super(typeId,
typeName,
repositoryHelper,
serviceName,
serverName);
this.qualifiedName = qualifiedName;
this.additionalProperties = additionalProperties;
}
/**
* Constructor for updates.
*
* @param qualifiedName unique name
* @param additionalProperties name value pairs for values that are not formally defined in the type system
* @param typeName type name to use for the entity
* @param typeId type GUID to use for the entity
* @param extendedProperties properties from the subtype.
* @param repositoryHelper helper methods
* @param serviceName name of this OMAS
* @param serverName name of local server
*/
protected ReferenceableBuilder(String qualifiedName,
Map additionalProperties,
String typeId,
String typeName,
Map extendedProperties,
OMRSRepositoryHelper repositoryHelper,
String serviceName,
String serverName)
{
super(typeId,
typeName,
extendedProperties,
null,
null,
repositoryHelper,
serviceName,
serverName);
this.qualifiedName = qualifiedName;
this.additionalProperties = additionalProperties;
}
/**
* Constructor for templated entities.
*
* @param qualifiedName unique name
* @param additionalProperties name value pairs for values that are not formally defined in the type system
* @param typeName type name to use for the entity
* @param typeId type GUID to use for the entity
* @param extendedProperties properties from the subtype
* @param instanceStatus initial instance status for the entity
* @param repositoryHelper helper methods
* @param serviceName name of this OMAS
* @param serverName name of local server
*/
protected ReferenceableBuilder(String qualifiedName,
Map additionalProperties,
String typeId,
String typeName,
Map extendedProperties,
InstanceStatus instanceStatus,
OMRSRepositoryHelper repositoryHelper,
String serviceName,
String serverName)
{
super(typeId,
typeName,
extendedProperties,
instanceStatus,
null,
repositoryHelper,
serviceName,
serverName);
this.qualifiedName = qualifiedName;
this.additionalProperties = additionalProperties;
}
/**
* Set up the Ownership classification for this entity.
* This method overrides an previously defined AssetOwnership classification for this entity.
*
* @param userId calling user
* @param owner name of the owner
* @param ownerTypeName type of element that owner comes from
* @param ownerPropertyName name of property used to identify owner
* @param methodName calling method
* @throws InvalidParameterException Ownership is not supported in the local repository, or any repository
* connected by an open metadata repository cohort
*/
protected void setOwnershipClassification(String userId,
String owner,
String ownerTypeName,
String ownerPropertyName,
String methodName) throws InvalidParameterException
{
if (owner != null)
{
try
{
Classification classification = repositoryHelper.getNewClassification(serviceName,
null,
null,
InstanceProvenanceType.LOCAL_COHORT,
userId,
OpenMetadataAPIMapper.OWNERSHIP_CLASSIFICATION_TYPE_NAME,
typeName,
ClassificationOrigin.ASSIGNED,
null,
getOwnershipProperties(owner,
ownerTypeName,
ownerPropertyName,
methodName));
newClassifications.put(classification.getName(), classification);
}
catch (TypeErrorException error)
{
errorHandler.handleUnsupportedType(error, methodName, OpenMetadataAPIMapper.OWNERSHIP_CLASSIFICATION_TYPE_NAME);
}
}
}
/**
* Return the bean properties describing the element's owner in an InstanceProperties object.
*
* @param owner name of the owner
* @param ownerTypeName type of element that owner comes from
* @param ownerPropertyName name of property used to identify owner
* @param methodName name of the calling method
* @return InstanceProperties object
* @throws InvalidParameterException the owner enum type is not supported
*/
InstanceProperties getOwnershipProperties(String owner,
String ownerTypeName,
String ownerPropertyName,
String methodName)
{
InstanceProperties properties = null;
if (owner != null)
{
properties = repositoryHelper.addStringPropertyToInstance(serviceName,
null,
OpenMetadataAPIMapper.OWNER_PROPERTY_NAME,
owner,
methodName);
properties = repositoryHelper.addStringPropertyToInstance(serviceName,
properties,
OpenMetadataAPIMapper.OWNER_TYPE_NAME_PROPERTY_NAME,
ownerTypeName,
methodName);
properties = repositoryHelper.addStringPropertyToInstance(serviceName,
properties,
OpenMetadataAPIMapper.OWNER_PROPERTY_NAME_PROPERTY_NAME,
ownerPropertyName,
methodName);
}
return properties;
}
/**
* Set up the Template classification.
*
* @param userId calling user
* @param name template name
* @param description template description
* @param additionalProperties additional properties about the template
* @param methodName calling method
* @throws InvalidParameterException Template classification not available in the repositories
*/
public void setTemplate(String userId,
String name,
String description,
Map additionalProperties,
String methodName) throws InvalidParameterException
{
try
{
Classification classification = repositoryHelper.getNewClassification(serviceName,
null,
null,
InstanceProvenanceType.LOCAL_COHORT,
userId,
OpenMetadataAPIMapper.TEMPLATE_CLASSIFICATION_TYPE_NAME,
typeName,
ClassificationOrigin.ASSIGNED,
null,
getTemplateProperties(name,
description,
additionalProperties,
methodName));
newClassifications.put(classification.getName(), classification);
}
catch (TypeErrorException error)
{
errorHandler.handleUnsupportedType(error, methodName, OpenMetadataAPIMapper.TEMPLATE_CLASSIFICATION_TYPE_NAME);
}
}
/**
* Return the template properties in an InstanceProperties object.
*
* @param name template name
* @param description template description
* @param additionalProperties additional properties about the template
* @param methodName name of the calling method
* @return InstanceProperties object
*/
InstanceProperties getTemplateProperties(String name,
String description,
Map additionalProperties,
String methodName)
{
InstanceProperties properties = null;
if (name != null)
{
properties = repositoryHelper.addStringPropertyToInstance(serviceName,
null,
OpenMetadataAPIMapper.TEMPLATE_NAME_PROPERTY_NAME,
name,
methodName);
}
if (description != null)
{
properties = repositoryHelper.addStringPropertyToInstance(serviceName,
null,
OpenMetadataAPIMapper.TEMPLATE_DESCRIPTION_PROPERTY_NAME,
description,
methodName);
}
if (additionalProperties != null)
{
properties = repositoryHelper.addStringMapPropertyToInstance(serviceName,
properties,
OpenMetadataAPIMapper.TEMPLATE_ADDITIONAL_PROPERTIES_PROPERTY_NAME,
additionalProperties,
methodName);
}
return properties;
}
/**
* Set up the Memento classification.
*
* @param userId calling user
* @param archiveDate timestamp that the archive either occurred or was detected
* @param archiveUser name of user responsible for performing the archive (or detecting it)
* @param archiveProcess process responsible for performing the archive (or detecting it)
* @param archiveProperties additional properties to locate the archived asset/artifact (if known)
* @param methodName calling method
* @throws InvalidParameterException Template classification not available in the repositories
*/
public void setMemento(String userId,
Date archiveDate,
String archiveUser,
String archiveProcess,
Map archiveProperties,
String methodName) throws InvalidParameterException
{
try
{
Classification classification = repositoryHelper.getNewClassification(serviceName,
null,
null,
InstanceProvenanceType.LOCAL_COHORT,
userId,
OpenMetadataAPIMapper.MEMENTO_CLASSIFICATION_TYPE_NAME,
typeName,
ClassificationOrigin.ASSIGNED,
null,
getMementoProperties(archiveDate,
archiveUser,
archiveProcess,
archiveProperties,
methodName));
newClassifications.put(classification.getName(), classification);
}
catch (TypeErrorException error)
{
errorHandler.handleUnsupportedType(error, methodName, OpenMetadataAPIMapper.MEMENTO_CLASSIFICATION_TYPE_NAME);
}
}
/**
* Return the template properties in an InstanceProperties object.
*
* @param archiveDate timestamp that the archive either occurred or was detected
* @param archiveUser name of user responsible for performing the archive (or detecting it)
* @param archiveProcess process responsible for performing the archive (or detecting it)
* @param archiveProperties additional properties to locate the archived asset/artifact (if known)
* @param methodName name of the calling method
* @return InstanceProperties object
*/
InstanceProperties getMementoProperties(Date archiveDate,
String archiveUser,
String archiveProcess,
Map archiveProperties,
String methodName)
{
InstanceProperties properties = repositoryHelper.addDatePropertyToInstance(serviceName,
null,
OpenMetadataAPIMapper.ARCHIVE_DATE_PROPERTY_NAME,
archiveDate != null ? archiveDate : new Date(),
methodName);
if (archiveUser != null)
{
properties = repositoryHelper.addStringPropertyToInstance(serviceName,
properties,
OpenMetadataAPIMapper.ARCHIVE_USER_PROPERTY_NAME,
archiveUser,
methodName);
}
if (archiveProcess != null)
{
properties = repositoryHelper.addStringPropertyToInstance(serviceName,
properties,
OpenMetadataAPIMapper.ARCHIVE_PROCESS_PROPERTY_NAME,
archiveProcess,
methodName);
}
if (archiveProperties != null)
{
properties = repositoryHelper.addStringMapPropertyToInstance(serviceName,
properties,
OpenMetadataAPIMapper.ARCHIVE_PROPERTIES_PROPERTY_NAME,
archiveProperties,
methodName);
}
properties = repositoryHelper.addStringPropertyToInstance(serviceName,
properties,
OpenMetadataAPIMapper.ARCHIVE_SERVICE_PROPERTY_NAME,
serviceName,
methodName);
properties = repositoryHelper.addStringPropertyToInstance(serviceName,
properties,
OpenMetadataAPIMapper.ARCHIVE_METHOD_PROPERTY_NAME,
methodName,
methodName);
return properties;
}
/**
* Set up the SecurityTags classification for this entity.
* This method overrides an previously defined SecurityTags classification for this entity.
*
* @param userId calling user
* @param securityLabels list of security labels
* @param securityProperties map of name value pairs
* @param methodName calling method
* @throws InvalidParameterException security tags is not supported in the local repository, or any repository
* connected by an open metadata repository cohort
*/
public void setSecurityTags(String userId,
List securityLabels,
Map securityProperties,
String methodName) throws InvalidParameterException
{
try
{
Classification classification = repositoryHelper.getNewClassification(serviceName,
null,
null,
InstanceProvenanceType.LOCAL_COHORT,
userId,
OpenMetadataAPIMapper.SECURITY_TAG_CLASSIFICATION_TYPE_NAME,
typeName,
ClassificationOrigin.ASSIGNED,
null,
getSecurityTagProperties(securityLabels,
securityProperties,
methodName));
newClassifications.put(classification.getName(), classification);
}
catch (TypeErrorException error)
{
errorHandler.handleUnsupportedType(error, methodName, OpenMetadataAPIMapper.SECURITY_TAG_CLASSIFICATION_TYPE_NAME);
}
}
/**
* Return the security tag properties in an InstanceProperties object.
*
* @param methodName name of the calling method
* @param securityLabels list of security labels
* @param securityProperties map of name value pairs
* @return InstanceProperties object
*/
InstanceProperties getSecurityTagProperties(List securityLabels,
Map securityProperties,
String methodName)
{
InstanceProperties properties = repositoryHelper.addStringArrayPropertyToInstance(serviceName,
null,
OpenMetadataAPIMapper.SECURITY_LABELS_PROPERTY_NAME,
securityLabels,
methodName);
properties = repositoryHelper.addMapPropertyToInstance(serviceName,
properties,
OpenMetadataAPIMapper.SECURITY_PROPERTIES_PROPERTY_NAME,
securityProperties,
methodName);
return properties;
}
/**
* Return the security tag properties in an InstanceProperties object.
*
* @param methodName name of the calling method
* @param description description of why this is significant
* @param scope scope of its business significance
* @param businessCapabilityGUID unique identifier of the business capability that rates this as significant
* @return InstanceProperties object
*/
InstanceProperties getBusinessSignificanceProperties(String description,
String scope,
String businessCapabilityGUID,
String methodName)
{
InstanceProperties properties = repositoryHelper.addStringPropertyToInstance(serviceName,
null,
OpenMetadataAPIMapper.DESCRIPTION_PROPERTY_NAME,
description,
methodName);
properties = repositoryHelper.addStringPropertyToInstance(serviceName,
properties,
OpenMetadataAPIMapper.SCOPE_PROPERTY_NAME,
scope,
methodName);
properties = repositoryHelper.addStringPropertyToInstance(serviceName,
properties,
OpenMetadataAPIMapper.BUSINESS_CAPABILITY_GUID_PROPERTY_NAME,
businessCapabilityGUID,
methodName);
return properties;
}
/**
* Return the qualified name so the handler can check for uniqueness.
*
* @return string name
*/
public String getQualifiedName()
{
return qualifiedName;
}
/**
* Return the supplied bean properties in an InstanceProperties object.
*
* @param methodName name of the calling method
* @return InstanceProperties object
* @throws InvalidParameterException there is a problem with the properties
*/
@Override
public InstanceProperties getInstanceProperties(String methodName) throws InvalidParameterException
{
InstanceProperties properties = super.getInstanceProperties(methodName);
if (qualifiedName != null)
{
properties = repositoryHelper.addStringPropertyToInstance(serviceName,
properties,
OpenMetadataAPIMapper.QUALIFIED_NAME_PROPERTY_NAME,
qualifiedName,
methodName);
}
if (additionalProperties != null)
{
properties = repositoryHelper.addStringMapPropertyToInstance(serviceName,
properties,
OpenMetadataAPIMapper.ADDITIONAL_PROPERTIES_PROPERTY_NAME,
additionalProperties,
methodName);
}
return properties;
}
}
