Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/* SPDX-License-Identifier: Apache-2.0 */
/* Copyright Contributors to the ODPi Egeria project. */
package org.odpi.openmetadata.commonservices.generichandlers;
import org.odpi.openmetadata.commonservices.ffdc.InvalidParameterHandler;
import org.odpi.openmetadata.commonservices.repositoryhandler.RepositoryHandler;
import org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException;
import org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException;
import org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException;
import org.odpi.openmetadata.metadatasecurity.server.OpenMetadataServerSecurityVerifier;
import org.odpi.openmetadata.frameworks.auditlog.AuditLog;
import org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityDetail;
import org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityProxy;
import org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.Relationship;
import org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.repositoryconnector.OMRSRepositoryHelper;
import java.util.ArrayList;
import java.util.Date;
import java.util.List;
/**
* 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.
*/
public class RelatedAssetHandler extends OpenMetadataAPIGenericHandler
{
/**
* Construct the handler with information needed to work with B objects.
*
* @param converter specific converter for this bean class
* @param beanClass name of bean class that is represented by the generic class B
* @param serviceName name of this service
* @param serverName name of the local server
* @param invalidParameterHandler handler for managing parameter errors
* @param repositoryHandler manages calls to the repository services
* @param repositoryHelper provides utilities for manipulating the repository services objects
* @param localServerUserId userId for this server
* @param securityVerifier open metadata security services verifier
* @param supportedZones list of zones that the access service is allowed to serve B instances from.
* @param defaultZones list of zones that the access service should set in all new B instances.
* @param publishZones list of zones that the access service sets up in published B instances.
* @param auditLog destination for audit log events.
*/
public RelatedAssetHandler(OpenMetadataAPIGenericConverter converter,
Class beanClass,
String serviceName,
String serverName,
InvalidParameterHandler invalidParameterHandler,
RepositoryHandler repositoryHandler,
OMRSRepositoryHelper repositoryHelper,
String localServerUserId,
OpenMetadataServerSecurityVerifier securityVerifier,
List supportedZones,
List defaultZones,
List publishZones,
AuditLog auditLog)
{
super(converter,
beanClass,
serviceName,
serverName,
invalidParameterHandler,
repositoryHandler,
repositoryHelper,
localServerUserId,
securityVerifier,
supportedZones,
defaultZones,
publishZones,
auditLog);
}
/**
* Return the count of related assets.
*
* @param userId calling user
* @param elementGUID identifier for the asset that the related assets are attached to
* @param elementGUIDParameterName parameter passing the elementGUID
* @param elementTypeName name of the type of the starting element
* @param relationshipTypeGUID unique identifier for relationship type
* @param relationshipTypeName unique name for relationship type
* @param serviceSupportedZones override the default supported zones.
* @param effectiveTime the time that the retrieved elements must be effective for (null for any time, new Date() for now)
* @param methodName calling method
* @return unique identifier of the object or null
* @throws InvalidParameterException the endpoint bean properties are invalid
* @throws UserNotAuthorizedException user not authorized to issue this request
* @throws PropertyServerException problem accessing the property server
*/
public int getRelatedAssetCount(String userId,
String elementGUID,
String elementGUIDParameterName,
String elementTypeName,
String relationshipTypeGUID,
String relationshipTypeName,
List serviceSupportedZones,
Date effectiveTime,
String methodName) throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException
{
List relatedAssets = this.getRelatedAssets(userId,
elementGUID,
elementGUIDParameterName,
elementTypeName,
relationshipTypeGUID,
relationshipTypeName,
serviceSupportedZones,
0,
invalidParameterHandler.getMaxPagingSize(),
effectiveTime,
methodName);
if (relatedAssets == null)
{
return 0;
}
else
{
return relatedAssets.size();
}
}
/**
* 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.
*
* @param userId calling user
* @param elementGUID identifier for the asset that the related assets are attached to
* @param elementGUIDParameterName parameter passing the elementGUID
* @param elementTypeName name of the type of the starting element
* @param relationshipTypeGUID unique identifier for relationship type
* @param relationshipTypeName unique name for relationship type
* @param serviceSupportedZones override the default supported zones.
* @param startFrom starting element (used in paging through large result sets)
* @param pageSize maximum number of results to return
* @param effectiveTime the time that the retrieved elements must be effective for (null for any time, new Date() for now)
* @param methodName calling method
*
* @return list of retrieved objects
*
* @throws InvalidParameterException the input properties are invalid
* @throws UserNotAuthorizedException user not authorized to issue this request
* @throws PropertyServerException problem accessing the property server
*/
public List getRelatedAssets(String userId,
String elementGUID,
String elementGUIDParameterName,
String elementTypeName,
String relationshipTypeGUID,
String relationshipTypeName,
List serviceSupportedZones,
int startFrom,
int pageSize,
Date effectiveTime,
String methodName) throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException
{
List relationships = this.getAttachmentLinks(userId,
elementGUID,
elementGUIDParameterName,
elementTypeName,
relationshipTypeGUID,
relationshipTypeName,
OpenMetadataAPIMapper.ASSET_TYPE_NAME,
startFrom,
pageSize,
effectiveTime,
methodName);
List results = new ArrayList<>();
final String entityGUIDParameterName = "entityProxy.getGUID()";
if (relationships != null)
{
for (Relationship relationship : relationships)
{
if (relationship != null)
{
EntityProxy otherEnd = repositoryHandler.getOtherEnd(elementGUID, elementTypeName, relationship, methodName);
if ((otherEnd != null) && (otherEnd.getType() != null))
{
try
{
EntityDetail entity = this.getEntityFromRepository(userId,
otherEnd.getGUID(),
entityGUIDParameterName,
otherEnd.getType().getTypeDefName(),
null,
null,
false,
false,
serviceSupportedZones,
new Date(),
methodName);
if (entity != null)
{
B bean = converter.getNewBean(beanClass, entity, relationship, methodName);
if (bean != null)
{
results.add(bean);
}
}
}
catch (UserNotAuthorizedException notVisible)
{
// skip this one
}
}
}
}
}
if (results.isEmpty())
{
return null;
}
else
{
return results;
}
}
}
