org.odpi.openmetadata.commonservices.generichandlers

Class RelatedAssetHandler<B>

java.lang.Object

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

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

public class RelatedAssetHandler<B>
extends OpenMetadataAPIGenericHandler<B>

RelatedAssetHandler manages B objects and optionally connections in the property server. It runs server-side in the OMAG Server Platform and retrieves Assets and Connections through the OMRSRepositoryConnector.

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

RelatedAssetHandler(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 asset handler with information needed to work with B objects.

Method Summary

Modifier and Type	Method and Description
int	getRelatedAssetCount(String userId, String elementGUID, String elementGUIDParameterName, String elementTypeName, String relationshipTypeGUID, String relationshipTypeName, List<String> serviceSupportedZones, String methodName) Return the count of related assets.
List<B>	getRelatedAssets(String userId, String elementGUID, String elementGUIDParameterName, String elementTypeName, String relationshipTypeGUID, String relationshipTypeName, List<String> serviceSupportedZones, int startFrom, int pageSize, String methodName) Return the assets and relationship properties attached to an element by the specified relationship type.

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

countAttachments, createBeanFromTemplate, createBeanInRepository, deleteBeanInRepository, deleteBeanInRepository, findBeanGUIDs, findBeans, findBeans, findBeans, findEntities, getAllAttachmentLinks, getAnchorsForAttachedElements, getAttachedElement, getAttachedElement, getAttachedElementGUID, getAttachedElementGUID, getAttachedElementGUIDs, getAttachedElementGUIDs, getAttachedElements, getAttachedElements, getAttachedElements, getAttachedElements, getAttachedEntities, getAttachedEntities, getAttachedEntity, getAttachedEntity, getAttachmentLinks, getAttachmentLinks, getBeanByUniqueName, getBeanByUniqueName, getBeanByValue, getBeanFromRepository, getBeanFromRepository, getBeanGUIDByUniqueName, getBeanGUIDsByClassification, getBeanGUIDsByType, getBeanGUIDsByType, getBeanGUIDsByValue, getBeansByClassification, getBeansByCreator, getBeansByType, getBeansByType, getBeansByValue, getBeansByValue, getBeansByValue, getBeansByValue, getEntitiesByType, getEntitiesByValue, getEntitiesByValue, getEntityByValue, getEntityFromRepository, getEntityFromRepository, getEntityFromRepository, getEntityGUIDByValue, getRepositoryHelper, getServiceName, getUniqueAttachmentLink, linkElementToElement, linkElementToElement, relinkElementToNewElement, relinkElementToNewElement, setSecurityVerifier, unlinkAllElements, unlinkConnectedElement, unlinkElementFromElement, unlinkElementFromElement, updateBeanInRepository, updateBeanInRepository, updateBeanPropertyInRepository, updateBeanStatusInRepository, validateAnchorEntity, validateAnchorEntity, verifyExternalSourceIdentity

Methods inherited from class java.lang.Object

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

Constructor Detail

RelatedAssetHandler

public RelatedAssetHandler(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 asset handler with information needed to work with B objects.

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 B instances from.

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

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

auditLog - destination for audit log events.

Method Detail

getRelatedAssetCount

public int getRelatedAssetCount(String userId,
                                String elementGUID,
                                String elementGUIDParameterName,
                                String elementTypeName,
                                String relationshipTypeGUID,
                                String relationshipTypeName,
                                List<String> serviceSupportedZones,
                                String methodName)
                         throws InvalidParameterException,
                                PropertyServerException,
                                UserNotAuthorizedException

Return the count of related assets.

Parameters:

userId - calling user

elementGUID - identifier for the asset that the related assets are attached to

elementGUIDParameterName - parameter passing the elementGUID

elementTypeName - name of the type of the starting element

relationshipTypeGUID - unique identifier for relationship type

relationshipTypeName - unique name for relationship type

serviceSupportedZones - override the default supported zones.

methodName - calling method

Returns:

unique identifier of the object or null

Throws:

InvalidParameterException - the endpoint bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

getRelatedAssets

public List<B> getRelatedAssets(String userId,
                                String elementGUID,
                                String elementGUIDParameterName,
                                String elementTypeName,
                                String relationshipTypeGUID,
                                String relationshipTypeName,
                                List<String> serviceSupportedZones,
                                int startFrom,
                                int pageSize,
                                String methodName)
                         throws InvalidParameterException,
                                PropertyServerException,
                                UserNotAuthorizedException

Return the assets and relationship properties attached to an element by the specified relationship type. If all related assets are required then specify null for the relationship type GUID and name.

Parameters:

userId - calling user

elementGUID - identifier for the asset that the related assets are attached to

elementGUIDParameterName - parameter passing the elementGUID

elementTypeName - name of the type of the starting element

relationshipTypeGUID - unique identifier for relationship type

relationshipTypeName - unique name for relationship type

serviceSupportedZones - override the default supported zones.

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

pageSize - maximum number of results to return

methodName - calling method

Returns:

list of retrieved objects

Throws:

InvalidParameterException - the input properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server