org.odpi.openmetadata.commonservices.generichandlers

Class ReferenceableHandler<B>

java.lang.Object

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

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

Direct Known Subclasses:

ActorProfileHandler, AnnotationHandler, AssetHandler, CertificationHandler, CollectionHandler, CommentHandler, ConnectionHandler, ConnectorTypeHandler, EndpointHandler, ExternalIdentifierHandler, ExternalReferenceHandler, GlossaryCategoryHandler, GlossaryHandler, GlossaryTermHandler, GovernanceDefinitionHandler, GovernanceDomainHandler, LicenseHandler, LocationHandler, NoteHandler, NoteLogHandler, PersonRoleHandler, ProcessHandler, RelatedMediaHandler, SchemaAttributeHandler, SchemaTypeHandler, SoftwareServerCapabilityHandler, UserIdentityHandler, ValidValuesHandler

public class ReferenceableHandler<B>
extends OpenMetadataAPIGenericHandler<B>

ReferenceableHandler manages methods on generic referenceables.

Field Summary

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

auditLog, beanClass, converter, defaultZones, errorHandler, invalidParameterHandler, localServerUserId, publishZones, repositoryHandler, repositoryHelper, securityVerifier, serverName, serviceName, supportedZones

Constructor Summary

Constructors

Constructor and Description

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

Method Summary

Modifier and Type	Method and Description
void	addOwner(String userId, String beanGUID, String beanGUIDParameterName, String beanGUIDTypeName, String owner, String ownerTypeName, String ownerPropertyName, String methodName) Add or replace the ownership for a referenceable.
void	addSecurityTags(String userId, String beanGUID, String beanGUIDParameterName, String beanGUIDTypeName, List<String> securityLabels, Map<String,Object> securityProperties, String methodName) Add or replace the security tags for a referenceable.
void	addTemplateClassification(String userId, String beanGUID, String beanGUIDParameterName, String beanGUIDTypeName, String name, String description, Map<String,String> additionalProperties, String methodName) Classify an asset as suitable to be used as a template for cataloguing assets of a similar types.
void	clearBusinessSignificant(String userId, String beanGUID, String beanGUIDParameterName, String beanGUIDTypeName, String methodName) Remove the "BusinessSignificant" designation from the element.
List<String>	findBeanGUIDsByQualifiedName(String userId, String typeGUID, String typeName, String name, String nameParameterName, int startFrom, int pageSize, String methodName) Return a list of unique identifiers for referenceables with the requested qualified name.
List<String>	findBeanGUIDsByQualifiedName(String userId, String typeGUID, String typeName, String name, String nameParameterName, List<String> serviceSupportedZones, int startFrom, int pageSize, String methodName) Return a list of unique identifiers for referenceables with the requested qualified name.
List<B>	findBeansByQualifiedName(String userId, String typeGUID, String typeName, String name, String nameParameterName, int startFrom, int pageSize, String methodName) Return a list of referenceables with the requested qualified name.
List<B>	findBeansByQualifiedName(String userId, String typeGUID, String typeName, String name, String nameParameterName, List<String> serviceSupportedZones, int startFrom, int pageSize, String methodName) Return a list of referenceables with the requested qualified name.
B	getBeanByQualifiedName(String userId, String typeGUID, String typeName, String name, String nameParameterName, List<String> serviceSupportedZones, String methodName) Return the bean with the requested qualified name.
B	getBeanByQualifiedName(String userId, String typeGUID, String typeName, String name, String nameParameterName, String methodName) Return the bean with the requested qualified name.
String	getBeanGUIDByQualifiedName(String userId, String typeGUID, String typeName, String name, String nameParameterName, List<String> serviceSupportedZones, String methodName) Return the bean with the requested qualified name.
String	getBeanGUIDByQualifiedName(String userId, String typeGUID, String typeName, String name, String nameParameterName, String methodName) Return the unique identifier of the bean with the requested qualified name.
List<String>	getBeanGUIDsByQualifiedName(String userId, String typeGUID, String typeName, String name, String nameParameterName, int startFrom, int pageSize, String methodName) Return a list of unique identifiers for referenceables with the requested qualified name.
List<String>	getBeanGUIDsByQualifiedName(String userId, String typeGUID, String typeName, String name, String nameParameterName, List<String> serviceSupportedZones, int startFrom, int pageSize, String methodName) Return a list of unique identifiers for referenceables with the requested qualified name.
List<B>	getBeansByQualifiedName(String userId, String typeGUID, String typeName, String name, String nameParameterName, int startFrom, int pageSize, String methodName) Return a list of referenceables with the requested qualified name.
List<B>	getBeansByQualifiedName(String userId, String typeGUID, String typeName, String name, String nameParameterName, List<String> serviceSupportedZones, int startFrom, int pageSize, String methodName) Return a list of referenceables with the requested qualified name.
List<B>	getCollectionMembers(String userId, String collectionGUID, String collectionGUIDParameterName, int startFrom, int pageSize, String methodName) Return the list of elements associated with a definition.
EntityDetail	getEntityByUniqueQualifiedName(String userId, String typeGUID, String typeName, String name, String nameParameterName, String methodName) Return the entity for a qualified name - if multiple entities have this name, an exception is thrown.
List<B>	getMoreInformation(String userId, String startingGUID, String startingGUIDParameterName, String suppliedStartingTypeName, String suppliedResultingTypeName, int startFrom, int pageSize, String methodName) Returns the list of elements that are linked to provide more information.
List<B>	getMoreInformation(String userId, String startingGUID, String startingGUIDParameterName, String suppliedStartingTypeName, String suppliedResultingTypeName, List<String> serviceSupportedZones, int startFrom, int pageSize, String methodName) Returns the list of elements that are linked to provide more information.
Map<String,String>	getVendorProperties(String userId, String referenceableGUID, String methodName) Retrieve the property facet for the vendor properties.
void	linkElementsAsDuplicates(String userId, String element1GUID, String element1GUIDParameter, String element2GUID, String element2GUIDParameter, String methodName) Create a simple relationship between two elements in an Asset description (typically the asset itself or attributes in their schema).
void	removeOwner(String userId, String beanGUID, String beanGUIDParameterName, String beanGUIDTypeName, String methodName) Remove the ownership classification from a referenceable.
void	removeResourceListMember(String userId, String externalSourceGUID, String externalSourceName, String beanGUID, String beanGUIDParameter, String memberGUID, String memberGUIDParameter, String methodName) Remove the relationship between a referenceable and a resource it uses.
void	removeSecurityTags(String userId, String beanGUID, String beanGUIDParameterName, String beanGUIDTypeName, String methodName) Remove the security tags classification from a referenceable.
void	removeSemanticAssignment(String userId, String externalSourceGUID, String externalSourceName, String beanGUID, String beanGUIDParameter, String glossaryTermGUID, String glossaryTermGUIDParameter, String methodName) Remove the relationship between a glossary term and a referenceable (typically a field in the schema).
void	removeTemplateClassification(String userId, String beanGUID, String beanGUIDParameterName, String beanGUIDTypeName, String methodName) Remove the classification that indicates that this asset can be used as a template.
void	saveResourceListMember(String userId, String externalSourceGUID, String externalSourceName, String beanGUID, String beanGUIDParameter, String memberGUID, String memberGUIDParameter, String resourceUse, boolean watchResource, String methodName) Create a relationship between a referenceable and a resource it uses.
void	saveSemanticAssignment(String userId, String externalSourceGUID, String externalSourceName, String beanGUID, String beanGUIDParameter, String glossaryTermGUID, String glossaryTermGUIDParameter, String methodName) Create a simple relationship between a glossary term and a referenceable.
void	saveSemanticAssignment(String userId, String externalSourceGUID, String externalSourceName, String beanGUID, String beanGUIDParameter, String glossaryTermGUID, String glossaryTermGUIDParameter, String description, String expression, int statusOrdinal, int confidence, String createdBy, String steward, String source, String methodName) Create a simple relationship between a glossary term and a referenceable.
void	setBusinessSignificant(String userId, String beanGUID, String beanGUIDParameterName, String beanGUIDTypeName, String description, String scope, String businessCapabilityGUID, String methodName) Classify a referenceable as "BusinessSignificant" (this may effect the way that lineage is displayed).
void	unlinkElementsAsDuplicates(String userId, String element1GUID, String element1GUIDParameter, String element2GUID, String element2GUIDParameter, String methodName) Remove the relationship between two elements that marks them as duplicates.

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

archiveBeanInRepository, archiveBeanInRepository, countAttachments, createBeanFromTemplate, createBeanInRepository, deleteBeanInRepository, deleteBeanInRepository, findAttachmentLinks, findBeanGUIDs, findBeans, findBeans, findBeans, findBeans, findEntities, getAllAttachmentLinks, getAnchorsForAttachedElements, getAttachedElement, getAttachedElement, getAttachedElementGUID, getAttachedElementGUID, getAttachedElementGUIDs, getAttachedElementGUIDs, getAttachedElements, getAttachedElements, getAttachedElements, getAttachedElements, getAttachedEntities, getAttachedEntities, getAttachedEntities, getAttachedEntity, getAttachedEntity, getAttachmentLinks, getAttachmentLinks, getAttachmentLinks, getBeanByUniqueName, getBeanByUniqueName, getBeanByValue, getBeanFromEntity, getBeanFromRepository, getBeanFromRepository, getBeanGUIDByUniqueName, getBeanGUIDByUniqueName, getBeanGUIDsByClassification, getBeanGUIDsByType, getBeanGUIDsByType, getBeanGUIDsByValue, getBeansByClassification, getBeansByCreator, getBeansByIntValue, getBeansByType, getBeansByType, getBeansByValue, getBeansByValue, getBeansByValue, getBeansByValue, getBeansByValue, getEntitiesByIntValue, getEntitiesByType, getEntitiesByValue, getEntitiesByValue, getEntitiesByValue, getEntitiesByValue, getEntityByValue, getEntityFromRepository, getEntityFromRepository, getEntityFromRepository, getEntityFromRepository, getEntityGUIDByValue, getEntityGUIDsByValue, getRepositoryHelper, getServiceName, getUniqueAttachmentLink, getUniqueAttachmentLink, linkElementToElement, linkElementToElement, maintainSupplementaryProperties, relinkElementToNewElement, relinkElementToNewElement, removeClassificationFromRepository, setClassificationInRepository, setClassificationInRepository, setSecurityVerifier, unlinkAllElements, unlinkAllElements, unlinkConnectedElement, unlinkConnectedElement, unlinkElementFromElement, unlinkElementFromElement, unlinkElementFromElement, unlinkElementFromElement, updateBeanEffectivityDates, updateBeanInRepository, updateBeanInRepository, updateBeanPropertyInRepository, updateBeanStatusInRepository, updateBeanStatusInRepository, updateClassificationEffectivityDates, updateElementToElementLink, updateElementToElementLink, updateRelationshipEffectivityDates, updateRelationshipProperties, validateAnchorEntity, validateAnchorEntity, verifyExternalSourceIdentity

Methods inherited from class java.lang.Object

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

Constructor Detail

ReferenceableHandler

public ReferenceableHandler(OpenMetadataAPIGenericConverter<B> converter,
                            Class<B> beanClass,
                            String serviceName,
                            String serverName,
                            InvalidParameterHandler invalidParameterHandler,
                            RepositoryHandler repositoryHandler,
                            OMRSRepositoryHelper repositoryHelper,
                            String localServerUserId,
                            OpenMetadataServerSecurityVerifier securityVerifier,
                            List<String> supportedZones,
                            List<String> defaultZones,
                            List<String> publishZones,
                            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

supportedZones - list of zones that the access service is allowed to serve Asset instances from.

defaultZones - list of zones that the access service should set in all new Asset instances.

publishZones - list of zones that the access service sets up in published Asset instances.

auditLog - destination for audit log events.

Method Detail

getBeanGUIDByQualifiedName

public String getBeanGUIDByQualifiedName(String userId,
                                         String typeGUID,
                                         String typeName,
                                         String name,
                                         String nameParameterName,
                                         String methodName)
                                  throws InvalidParameterException,
                                         PropertyServerException,
                                         UserNotAuthorizedException

Return the unique identifier of the bean with the requested qualified name. The match is exact. It uses the supportedZones supplied with the service.

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

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.

getBeanGUIDByQualifiedName

public String getBeanGUIDByQualifiedName(String userId,
                                         String typeGUID,
                                         String typeName,
                                         String name,
                                         String nameParameterName,
                                         List<String> serviceSupportedZones,
                                         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

serviceSupportedZones - list of supported zones for this service

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.

getBeanByQualifiedName

public B getBeanByQualifiedName(String userId,
                                String typeGUID,
                                String typeName,
                                String name,
                                String nameParameterName,
                                String methodName)
                         throws InvalidParameterException,
                                PropertyServerException,
                                UserNotAuthorizedException

Return the bean with the requested qualified name. The match is exact. It uses the supportedZones supplied with the service.

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

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.

getBeanByQualifiedName

public B getBeanByQualifiedName(String userId,
                                String typeGUID,
                                String typeName,
                                String name,
                                String nameParameterName,
                                List<String> serviceSupportedZones,
                                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

serviceSupportedZones - list of supported zones for this service

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.

getBeanGUIDsByQualifiedName

public List<String> getBeanGUIDsByQualifiedName(String userId,
                                                String typeGUID,
                                                String typeName,
                                                String name,
                                                String nameParameterName,
                                                int startFrom,
                                                int pageSize,
                                                String methodName)
                                         throws InvalidParameterException,
                                                PropertyServerException,
                                                UserNotAuthorizedException

Return a list of unique identifiers for referenceables with the requested qualified name. The match is exact. It uses the supportedZones supplied with the service.

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

startFrom - starting element (used in paging through large result sets)

pageSize - maximum number of results to return

methodName - calling method

Returns:

list of B beans

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.

getBeanGUIDsByQualifiedName

public List<String> getBeanGUIDsByQualifiedName(String userId,
                                                String typeGUID,
                                                String typeName,
                                                String name,
                                                String nameParameterName,
                                                List<String> serviceSupportedZones,
                                                int startFrom,
                                                int pageSize,
                                                String methodName)
                                         throws InvalidParameterException,
                                                PropertyServerException,
                                                UserNotAuthorizedException

Return a list of unique identifiers for referenceables 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

serviceSupportedZones - list of supported zones for this service

startFrom - starting element (used in paging through large result sets)

pageSize - maximum number of results to return

methodName - calling method

Returns:

list of B beans

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.

getBeansByQualifiedName

public List<B> getBeansByQualifiedName(String userId,
                                       String typeGUID,
                                       String typeName,
                                       String name,
                                       String nameParameterName,
                                       int startFrom,
                                       int pageSize,
                                       String methodName)
                                throws InvalidParameterException,
                                       PropertyServerException,
                                       UserNotAuthorizedException

Return a list of referenceables with the requested qualified name. The match is exact. It uses the supportedZones supplied with the service.

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

startFrom - starting element (used in paging through large result sets)

pageSize - maximum number of results to return

methodName - calling method

Returns:

list of B beans

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.

getBeansByQualifiedName

public List<B> getBeansByQualifiedName(String userId,
                                       String typeGUID,
                                       String typeName,
                                       String name,
                                       String nameParameterName,
                                       List<String> serviceSupportedZones,
                                       int startFrom,
                                       int pageSize,
                                       String methodName)
                                throws InvalidParameterException,
                                       PropertyServerException,
                                       UserNotAuthorizedException

Return a list of referenceables 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

serviceSupportedZones - list of supported zones for this service

startFrom - starting element (used in paging through large result sets)

pageSize - maximum number of results to return

methodName - calling method

Returns:

list of B beans

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.

getEntityByUniqueQualifiedName

public EntityDetail getEntityByUniqueQualifiedName(String userId,
                                                   String typeGUID,
                                                   String typeName,
                                                   String name,
                                                   String nameParameterName,
                                                   String methodName)
                                            throws InvalidParameterException,
                                                   PropertyServerException,
                                                   UserNotAuthorizedException

Return the entity for a qualified name - if multiple entities have this name, an exception is thrown.

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

methodName - calling method

Returns:

list of B beans

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.

findBeanGUIDsByQualifiedName

public List<String> findBeanGUIDsByQualifiedName(String userId,
                                                 String typeGUID,
                                                 String typeName,
                                                 String name,
                                                 String nameParameterName,
                                                 int startFrom,
                                                 int pageSize,
                                                 String methodName)
                                          throws InvalidParameterException,
                                                 PropertyServerException,
                                                 UserNotAuthorizedException

Return a list of unique identifiers for referenceables with the requested qualified name. The match is via a Regular Expression (RegEx). It uses the supportedZones supplied with the service.

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 - this is a regular expression (RegEx)

nameParameterName - property that provided the name

startFrom - starting element (used in paging through large result sets)

pageSize - maximum number of results to return

methodName - calling method

Returns:

list of B beans

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.

findBeanGUIDsByQualifiedName

public List<String> findBeanGUIDsByQualifiedName(String userId,
                                                 String typeGUID,
                                                 String typeName,
                                                 String name,
                                                 String nameParameterName,
                                                 List<String> serviceSupportedZones,
                                                 int startFrom,
                                                 int pageSize,
                                                 String methodName)
                                          throws InvalidParameterException,
                                                 PropertyServerException,
                                                 UserNotAuthorizedException

Return a list of unique identifiers for referenceables with the requested qualified name. The match is via a Regular Expression (RegEx).

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 - this is a regular expression (RegEx)

nameParameterName - property that provided the name

serviceSupportedZones - list of supported zones for this service

startFrom - starting element (used in paging through large result sets)

pageSize - maximum number of results to return

methodName - calling method

Returns:

list of B beans

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.

findBeansByQualifiedName

public List<B> findBeansByQualifiedName(String userId,
                                        String typeGUID,
                                        String typeName,
                                        String name,
                                        String nameParameterName,
                                        int startFrom,
                                        int pageSize,
                                        String methodName)
                                 throws InvalidParameterException,
                                        PropertyServerException,
                                        UserNotAuthorizedException

Return a list of referenceables with the requested qualified name. The match is via a Regular Expression (RegEx). It uses the supportedZones supplied with the service.

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 - this is a regular expression (RegEx)

nameParameterName - property that provided the name

startFrom - starting element (used in paging through large result sets)

pageSize - maximum number of results to return

methodName - calling method

Returns:

list of B beans

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.

findBeansByQualifiedName

public List<B> findBeansByQualifiedName(String userId,
                                        String typeGUID,
                                        String typeName,
                                        String name,
                                        String nameParameterName,
                                        List<String> serviceSupportedZones,
                                        int startFrom,
                                        int pageSize,
                                        String methodName)
                                 throws InvalidParameterException,
                                        PropertyServerException,
                                        UserNotAuthorizedException

Return a list of referenceables with the requested qualified name. The match is via a Regular Expression (RegEx).

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 - this is a regular expression (RegEx)

nameParameterName - property that provided the name

serviceSupportedZones - list of supported zones for this service

startFrom - starting element (used in paging through large result sets)

pageSize - maximum number of results to return

methodName - calling method

Returns:

list of B beans

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.

addOwner

public void addOwner(String userId,
                     String beanGUID,
                     String beanGUIDParameterName,
                     String beanGUIDTypeName,
                     String owner,
                     String ownerTypeName,
                     String ownerPropertyName,
                     String methodName)
              throws InvalidParameterException,
                     UserNotAuthorizedException,
                     PropertyServerException

Add or replace the ownership for a referenceable.

Parameters:

userId - calling user

beanGUID - unique identifier of bean

beanGUIDParameterName - name of parameter supplying the beanGUID

beanGUIDTypeName - type of bean

owner - name of the owner

ownerTypeName - type of element that owner comes from

ownerPropertyName - name of property used to identify owner

methodName - calling method

Throws:

InvalidParameterException - entity not known, null userId or guid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

removeOwner

public void removeOwner(String userId,
                        String beanGUID,
                        String beanGUIDParameterName,
                        String beanGUIDTypeName,
                        String methodName)
                 throws InvalidParameterException,
                        UserNotAuthorizedException,
                        PropertyServerException

Remove the ownership classification from a referenceable.

Parameters:

userId - calling user

beanGUID - unique identifier of entity to update

beanGUIDParameterName - name of parameter providing beanGUID

beanGUIDTypeName - type of bean

methodName - calling method

Throws:

InvalidParameterException - entity not known, null userId or guid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

addSecurityTags

public void addSecurityTags(String userId,
                            String beanGUID,
                            String beanGUIDParameterName,
                            String beanGUIDTypeName,
                            List<String> securityLabels,
                            Map<String,Object> securityProperties,
                            String methodName)
                     throws InvalidParameterException,
                            UserNotAuthorizedException,
                            PropertyServerException

Add or replace the security tags for a referenceable.

Parameters:

userId - calling user

beanGUID - unique identifier of bean

beanGUIDParameterName - name of parameter supplying the beanGUID

beanGUIDTypeName - type of bean

securityLabels - list of security labels defining the security characteristics of the element

securityProperties - Descriptive labels describing origin of the asset

methodName - calling method

Throws:

InvalidParameterException - entity not known, null userId or guid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

removeSecurityTags

public void removeSecurityTags(String userId,
                               String beanGUID,
                               String beanGUIDParameterName,
                               String beanGUIDTypeName,
                               String methodName)
                        throws InvalidParameterException,
                               UserNotAuthorizedException,
                               PropertyServerException

Remove the security tags classification from a referenceable.

Parameters:

userId - calling user

beanGUID - unique identifier of entity to update

beanGUIDParameterName - name of parameter providing beanGUID

beanGUIDTypeName - type of bean

methodName - calling method

Throws:

InvalidParameterException - entity not known, null userId or guid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

setBusinessSignificant

public void setBusinessSignificant(String userId,
                                   String beanGUID,
                                   String beanGUIDParameterName,
                                   String beanGUIDTypeName,
                                   String description,
                                   String scope,
                                   String businessCapabilityGUID,
                                   String methodName)
                            throws InvalidParameterException,
                                   UserNotAuthorizedException,
                                   PropertyServerException

Classify a referenceable as "BusinessSignificant" (this may effect the way that lineage is displayed).

Parameters:

userId - calling user

beanGUID - unique identifier of entity to update

beanGUIDParameterName - name of parameter providing beanGUID

beanGUIDTypeName - type of bean

description - description of why this is significant

scope - scope of its business significance

businessCapabilityGUID - unique identifier of the business capability that rates this as significant

methodName - calling method

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

clearBusinessSignificant

public void clearBusinessSignificant(String userId,
                                     String beanGUID,
                                     String beanGUIDParameterName,
                                     String beanGUIDTypeName,
                                     String methodName)
                              throws InvalidParameterException,
                                     UserNotAuthorizedException,
                                     PropertyServerException

Remove the "BusinessSignificant" designation from the element.

Parameters:

userId - calling user

beanGUID - unique identifier of entity to update

beanGUIDParameterName - name of parameter providing beanGUID

beanGUIDTypeName - type of bean

methodName - calling method

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

addTemplateClassification

public void addTemplateClassification(String userId,
                                      String beanGUID,
                                      String beanGUIDParameterName,
                                      String beanGUIDTypeName,
                                      String name,
                                      String description,
                                      Map<String,String> additionalProperties,
                                      String methodName)
                               throws InvalidParameterException,
                                      UserNotAuthorizedException,
                                      PropertyServerException

Classify an asset as suitable to be used as a template for cataloguing assets of a similar types.

Parameters:

userId - calling user

beanGUID - unique identifier of bean

beanGUIDParameterName - name of parameter supplying the beanGUID

beanGUIDTypeName - type of bean

name - name of the template

description - description of when, where and how to use the template

additionalProperties - any additional properties

methodName - calling method

Throws:

InvalidParameterException - asset or element not known, null userId or guid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

removeTemplateClassification

public void removeTemplateClassification(String userId,
                                         String beanGUID,
                                         String beanGUIDParameterName,
                                         String beanGUIDTypeName,
                                         String methodName)
                                  throws InvalidParameterException,
                                         UserNotAuthorizedException,
                                         PropertyServerException

Remove the classification that indicates that this asset can be used as a template.

Parameters:

userId - calling user

beanGUID - unique identifier of bean

beanGUIDParameterName - name of parameter supplying the beanGUID

beanGUIDTypeName - type of bean

methodName - calling method

Throws:

InvalidParameterException - asset or element not known, null userId or guid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getMoreInformation

public List<B> getMoreInformation(String userId,
                                  String startingGUID,
                                  String startingGUIDParameterName,
                                  String suppliedStartingTypeName,
                                  String suppliedResultingTypeName,
                                  int startFrom,
                                  int pageSize,
                                  String methodName)
                           throws InvalidParameterException,
                                  PropertyServerException,
                                  UserNotAuthorizedException

Returns the list of elements that are linked to provide more information. It uses the supportedZones supplied with the service.

Parameters:

userId - String userId of user making request.

startingGUID - String unique id for element.

startingGUIDParameterName - name of parameter supplying the GUID

suppliedStartingTypeName - name of the type of object that the search begins with - null means referenceable

suppliedResultingTypeName - name of the type of object that the search returns - null mean referenceable

startFrom - int starting position for fist returned element.

pageSize - int maximum number of elements to return on the call.

methodName - String calling method

Returns:

a list of assets or

Throws:

InvalidParameterException - - the GUID is not recognized or the paging values are invalid or

PropertyServerException - - there is a problem retrieving the asset properties from the property server or

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

getMoreInformation

public List<B> getMoreInformation(String userId,
                                  String startingGUID,
                                  String startingGUIDParameterName,
                                  String suppliedStartingTypeName,
                                  String suppliedResultingTypeName,
                                  List<String> serviceSupportedZones,
                                  int startFrom,
                                  int pageSize,
                                  String methodName)
                           throws InvalidParameterException,
                                  PropertyServerException,
                                  UserNotAuthorizedException

Returns the list of elements that are linked to provide more information.

Parameters:

userId - String userId of user making request.

startingGUID - String unique id for element.

startingGUIDParameterName - name of parameter supplying the GUID

suppliedStartingTypeName - name of the type of object that the search begins with - null means referenceable

suppliedResultingTypeName - name of the type of object that the search returns - null mean referenceable

serviceSupportedZones - supported zones for calling service

startFrom - int starting position for fist returned element.

pageSize - int maximum number of elements to return on the call.

methodName - String calling method

Returns:

a list of assets or

Throws:

InvalidParameterException - - the GUID is not recognized or the paging values are invalid or

PropertyServerException - - there is a problem retrieving the asset properties from the property server or

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

saveSemanticAssignment

public void saveSemanticAssignment(String userId,
                                   String externalSourceGUID,
                                   String externalSourceName,
                                   String beanGUID,
                                   String beanGUIDParameter,
                                   String glossaryTermGUID,
                                   String glossaryTermGUIDParameter,
                                   String methodName)
                            throws InvalidParameterException,
                                   PropertyServerException,
                                   UserNotAuthorizedException

Create a simple relationship between a glossary term and a referenceable.

Parameters:

userId - calling user

externalSourceGUID - guid of the software server capability entity that represented the external source - null for local

externalSourceName - name of the software server capability entity that represented the external source - null for local

beanGUID - unique identifier of the asset that is being described

beanGUIDParameter - parameter supply the beanGUID

glossaryTermGUID - unique identifier of the glossary term

glossaryTermGUIDParameter - parameter supplying the list of GlossaryTermGUID

methodName - calling method

Throws:

InvalidParameterException - the guid properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

saveSemanticAssignment

public void saveSemanticAssignment(String userId,
                                   String externalSourceGUID,
                                   String externalSourceName,
                                   String beanGUID,
                                   String beanGUIDParameter,
                                   String glossaryTermGUID,
                                   String glossaryTermGUIDParameter,
                                   String description,
                                   String expression,
                                   int statusOrdinal,
                                   int confidence,
                                   String createdBy,
                                   String steward,
                                   String source,
                                   String methodName)
                            throws InvalidParameterException,
                                   PropertyServerException,
                                   UserNotAuthorizedException

Create a simple relationship between a glossary term and a referenceable.

Parameters:

userId - calling user

externalSourceGUID - guid of the software server capability entity that represented the external source - null for local

externalSourceName - name of the software server capability entity that represented the external source - null for local

beanGUID - unique identifier of the element that is being described

beanGUIDParameter - parameter supply the beanGUID

glossaryTermGUID - unique identifier of the glossary term

glossaryTermGUIDParameter - parameter supplying the list of GlossaryTermGUID

description - description of the assignment

expression - expression used to determine the assignment

statusOrdinal - the status of the assignment

confidence - how confident is the assignment - no confidence = 0 to complete confidence = 100

createdBy - who/what created the assignment

steward - which steward is responsible for assignment

source - where was the source of the assignment

methodName - calling method

Throws:

InvalidParameterException - the guid properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

removeSemanticAssignment

public void removeSemanticAssignment(String userId,
                                     String externalSourceGUID,
                                     String externalSourceName,
                                     String beanGUID,
                                     String beanGUIDParameter,
                                     String glossaryTermGUID,
                                     String glossaryTermGUIDParameter,
                                     String methodName)
                              throws InvalidParameterException,
                                     UserNotAuthorizedException,
                                     PropertyServerException

Remove the relationship between a glossary term and a referenceable (typically a field in the schema).

Parameters:

userId - calling user

externalSourceGUID - guid of the software server capability entity that represented the external source - null for local

externalSourceName - name of the software server capability entity that represented the external source

beanGUID - unique identifier of the element that is being described

beanGUIDParameter - parameter supply the beanGUID

glossaryTermGUID - unique identifier of the glossary term

glossaryTermGUIDParameter - parameter supplying the list of GlossaryTermGUID

methodName - calling method

Throws:

InvalidParameterException - one of the parameters is null or invalid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

saveResourceListMember

public void saveResourceListMember(String userId,
                                   String externalSourceGUID,
                                   String externalSourceName,
                                   String beanGUID,
                                   String beanGUIDParameter,
                                   String memberGUID,
                                   String memberGUIDParameter,
                                   String resourceUse,
                                   boolean watchResource,
                                   String methodName)
                            throws InvalidParameterException,
                                   PropertyServerException,
                                   UserNotAuthorizedException

Create a relationship between a referenceable and a resource it uses.

Parameters:

userId - calling user

externalSourceGUID - guid of the software server capability entity that represented the external source - null for local

externalSourceName - name of the software server capability entity that represented the external source - null for local

beanGUID - unique identifier of the startign element

beanGUIDParameter - parameter supplying the beanGUID

memberGUID - unique identifier of the element to link

memberGUIDParameter - parameter supplying the memberGUID

resourceUse - description of the way that the resource list is used

watchResource - should changes in the members result in notifications

methodName - calling method

Throws:

InvalidParameterException - the guid properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

removeResourceListMember

public void removeResourceListMember(String userId,
                                     String externalSourceGUID,
                                     String externalSourceName,
                                     String beanGUID,
                                     String beanGUIDParameter,
                                     String memberGUID,
                                     String memberGUIDParameter,
                                     String methodName)
                              throws InvalidParameterException,
                                     UserNotAuthorizedException,
                                     PropertyServerException

Remove the relationship between a referenceable and a resource it uses.

Parameters:

userId - calling user

externalSourceGUID - guid of the software server capability entity that represented the external source - null for local

externalSourceName - name of the software server capability entity that represented the external source

beanGUID - unique identifier of the referenceable

beanGUIDParameter - parameter supplying beanGUID

memberGUID - unique identifier of the glossary term

memberGUIDParameter - parameter supplying memberGUID

methodName - calling method

Throws:

InvalidParameterException - one of the parameters is null or invalid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getCollectionMembers

public List<B> getCollectionMembers(String userId,
                                    String collectionGUID,
                                    String collectionGUIDParameterName,
                                    int startFrom,
                                    int pageSize,
                                    String methodName)
                             throws InvalidParameterException,
                                    UserNotAuthorizedException,
                                    PropertyServerException

Return the list of elements associated with a definition.

Parameters:

userId - calling user

collectionGUID - unique identifier of the collection to query

collectionGUIDParameterName - name of the parameter supplying collectionGUID

startFrom - paging start point

pageSize - maximum results that can be returned

methodName - calling method

Returns:

list of metadata elements describing the definitions associated with the requested definition

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

linkElementsAsDuplicates

public void linkElementsAsDuplicates(String userId,
                                     String element1GUID,
                                     String element1GUIDParameter,
                                     String element2GUID,
                                     String element2GUIDParameter,
                                     String methodName)
                              throws InvalidParameterException,
                                     UserNotAuthorizedException,
                                     PropertyServerException

Create a simple relationship between two elements in an Asset description (typically the asset itself or attributes in their schema).

Parameters:

userId - calling user

element1GUID - unique identifier of first element

element1GUIDParameter - name of parameter supplying element1GUID

element2GUID - unique identifier of second element

element2GUIDParameter - name of parameter supplying element2GUID

methodName - calling method

Throws:

InvalidParameterException - one of the parameters is null or invalid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

unlinkElementsAsDuplicates

public void unlinkElementsAsDuplicates(String userId,
                                       String element1GUID,
                                       String element1GUIDParameter,
                                       String element2GUID,
                                       String element2GUIDParameter,
                                       String methodName)
                                throws InvalidParameterException,
                                       UserNotAuthorizedException,
                                       PropertyServerException

Remove the relationship between two elements that marks them as duplicates.

Parameters:

userId - calling user

element1GUID - unique identifier of first element

element1GUIDParameter - name of parameter supplying element1GUID

element2GUID - unique identifier of second element

element2GUIDParameter - name of parameter supplying element2GUID

methodName - calling method

Throws:

InvalidParameterException - one of the parameters is null or invalid or the elements are not linked as duplicates

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getVendorProperties

public Map<String,String> getVendorProperties(String userId,
                                              String referenceableGUID,
                                              String methodName)
                                       throws InvalidParameterException,
                                              UserNotAuthorizedException,
                                              PropertyServerException

Retrieve the property facet for the vendor properties. It uses the supportedZones supplied with the service.

Parameters:

userId - calling user

referenceableGUID - unique identifier of the metadata element

methodName - calling method

Returns:

map of properties

Throws:

InvalidParameterException - one of the parameters is null or invalid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem