Package org.odpi.openmetadata.commonservices.generichandlers

Class ReferenceableHandler<B>

java.lang.Object

org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIRootHandler<B>

org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIAnchorHandler<B>

org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIGenericHandler<B>

org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPITemplateHandler<B>

org.odpi.openmetadata.commonservices.generichandlers.ReferenceableHandler<B>

Direct Known Subclasses:

AssetHandler, ConnectionHandler, ConnectorTypeHandler, EndpointHandler, MetadataElementHandler, SoftwareCapabilityHandler

public class ReferenceableHandler<B>
extends OpenMetadataAPITemplateHandler<B>

ReferenceableHandler manages methods on generic referenceables.

Nested Class Summary

Nested classes/interfaces inherited from class org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIAnchorHandler

OpenMetadataAPIAnchorHandler.AnchorIdentifiers

Field Summary

Fields inherited from class org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIRootHandler

assetActionDescription, auditLog, beanClass, converter, errorHandler, invalidParameterHandler, localServerUserId, qualifiedNamePropertyNamesList, repositoryHandler, repositoryHelper, securityVerifier, serverName, serviceName

Constructor Summary

Constructors

Constructor	Description
ReferenceableHandler(OpenMetadataAPIGenericConverter<B> converter, Class<B> beanClass, String serviceName, String serverName, InvalidParameterHandler invalidParameterHandler, RepositoryHandler repositoryHandler, OMRSRepositoryHelper repositoryHelper, String localServerUserId, OpenMetadataServerSecurityVerifier securityVerifier, AuditLog auditLog)	Construct the handler information needed to interact with the repository services

Method Summary

Modifier and Type	Method	Description
String	getBeanGUIDByQualifiedName(String userId, String typeGUID, String typeName, String name, String nameParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName)	Return the bean with the requested qualified name.
void	setVendorProperties(String userId, String referenceableGUID, Map<String,String> vendorProperties, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName)	Create the property facet for the vendor properties.

Methods inherited from class org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPITemplateHandler

createBeanFromTemplate

Methods inherited from class org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIGenericHandler

addAnchorGUIDToBuilder, archiveBeanInRepository, createBeanInRepository, createBeanInRepository, deleteAnchoredBeanInRepository, deleteBeanInRepository, deleteIfAppropriatelyAnchoredEntity, findAttachmentLinks, findBeans, findBeans, findEntities, findEntities, getAllAttachmentLinks, getAttachedElements, getAttachedEntities, getAttachedEntities, getAttachedEntity, getAttachmentLink, getAttachmentLinks, getAttachmentLinks, getBeanByUniqueName, getBeanByValue, getBeanFromRepository, getBeanFromRepository, getBeanFromRepository, getBeanGUIDByUniqueName, getBeanHistory, getBeansByValue, getClassificationHistory, getEntitiesByType, getEntitiesByValue, getEntityByValue, getEntityFromRepository, getEntityFromRepository, getEntityZones, getRelationshipHistory, getUniqueAttachmentLink, getValidatedBeans, getValidatedEntities, getValidatedEntities, linkElementToElement, multiLinkElementToElement, publishElement, removeClassificationFromRepository, removeCollectionMembers, removeDataStructureMembers, removeDeployedAssets, removeFolderContents, removeLinkedDatabaseSchemas, removeLinkedDataClasses, removeNestedComments, removeNestedDataFields, setClassificationInRepository, setClassificationInRepository, uncheckedLinkElementToElement, undoBeanUpdateInRepository, unlinkAllElements, unlinkElementFromElement, unlinkElementFromElement, updateBeanEffectivityDates, updateBeanInRepository, updateBeanInRepository, updateBeanInRepository, updateBeanPropertyInRepository, updateClassificationEffectivityDates, updateElementToElementLink, updateRelationshipEffectivityDates, updateRelationshipProperties, validateAnchorEntity, validateAnchorGUID, validateEntitiesAndAnchorsForRead, validateEntityAndAnchorForRead, validateEntityAndAnchorForRead, validateRelationship, validateUniqueProperty, withdrawElement

Methods inherited from class org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIAnchorHandler

addAnchorsClassification, getAnchoredEntities, getAnchorGUIDForEntity, getAnchorScopeGUIDFromAnchorsClassification, getAnchorsFromAnchorsClassification, getDomainName, getDomainName, refreshAnchorsClassification, setUpAnchorsClassificationFromAnchor, setUpAnchorsClassificationFromParent

Methods inherited from class org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIRootHandler

getConverter, getElementStub, getRepositoryHandler, getRepositoryHelper, getServerName, getServiceName, getTypeDefByName, setSecurityVerifier

Methods inherited from class java.lang.Object

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

Constructor Details

ReferenceableHandler

public ReferenceableHandler(OpenMetadataAPIGenericConverter<B> converter,
 Class<B> beanClass,
 String serviceName,
 String serverName,
 InvalidParameterHandler invalidParameterHandler,
 RepositoryHandler repositoryHandler,
 OMRSRepositoryHelper repositoryHelper,
 String localServerUserId,
 OpenMetadataServerSecurityVerifier securityVerifier,
 AuditLog auditLog)

Construct the handler information needed to interact with the repository services

Parameters:

converter - specific converter for this bean class

beanClass - name of bean class that is represented by the generic class B

serviceName - name of this service

serverName - name of the local server

invalidParameterHandler - handler for managing parameter errors

repositoryHandler - manages calls to the repository services

repositoryHelper - provides utilities for manipulating the repository services objects

localServerUserId - userId for this server

securityVerifier - open metadata security services verifier

auditLog - destination for audit log events.

Method Details

getBeanGUIDByQualifiedName

public String getBeanGUIDByQualifiedName(String userId,
 String typeGUID,
 String typeName,
 String name,
 String nameParameterName,
 boolean forLineage,
 boolean forDuplicateProcessing,
 Date effectiveTime,
 String methodName)
                                  throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Return the bean with the requested qualified name. The match is exact.

Parameters:

userId - calling user

typeGUID - unique identifier of the asset type to search for (null for the generic Asset type)

typeName - unique identifier of the asset type to search for (null for the generic Asset type)

name - name to search for

nameParameterName - property that provided the name

forLineage - the request is to support lineage retrieval this means entities with the Memento classification can be returned

forDuplicateProcessing - the request is for duplicate processing and so must not deduplicate

effectiveTime - the time that the retrieved elements must be effective for

methodName - calling method

Returns:

matching B bean

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - there is a problem retrieving information from the property server(s).

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

setVendorProperties

public void setVendorProperties(String userId,
 String referenceableGUID,
 Map<String,String> vendorProperties,
 boolean forLineage,
 boolean forDuplicateProcessing,
 Date effectiveTime,
 String methodName)
                         throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create the property facet for the vendor properties.

Parameters:

userId - calling user

referenceableGUID - unique identifier of the software capability

vendorProperties - properties for the vendor

forLineage - the request is to support lineage retrieval this means entities with the Memento classification can be returned

forDuplicateProcessing - the request is for duplicate processing and so must not deduplicate

effectiveTime - the time that the retrieved elements must be effective for

methodName - calling method

Throws:

InvalidParameterException - one of the parameters is null or invalid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem