Package org.odpi.openmetadata.userinterface.uichassis.springboot.service

Class AssetCatalogOMASService

java.lang.Object

org.odpi.openmetadata.userinterface.uichassis.springboot.service.AssetCatalogOMASService

@Service
public class AssetCatalogOMASService
extends Object

The Asset Catalog OMAS Service provides an interface to search for assets using the Asset Catalog OMAS client

Constructor Summary

Constructors

Constructor	Description
AssetCatalogOMASService(org.odpi.openmetadata.accessservices.assetcatalog.AssetCatalog assetCatalog)

Method Summary

Modifier and Type	Method	Description
org.odpi.openmetadata.accessservices.assetcatalog.model.Elements	getAssetContext(String userId, String assetId, String assetType)	Fetch asset's context
org.odpi.openmetadata.accessservices.assetcatalog.model.AssetCatalogBean	getAssetDetails(String user, String assetId, String assetType)	Fetch asset's header, classification and properties
List<org.odpi.openmetadata.accessservices.assetcatalog.model.Relationship>	getAssetRelationships(String user, String assetId, String assetType, String relationshipTypeGUID, Integer from, Integer pageSize)	Fetch the relationships for a specific asset
org.odpi.openmetadata.accessservices.assetcatalog.model.AssetCatalogBean	getAssetUniverse(String user, String assetId, String assetType)	Fetch asset's header, classification, properties and relationships
List<org.odpi.openmetadata.accessservices.assetcatalog.model.Classification>	getClassificationsForAsset(String user, String assetId, String assetType, String classificationName)	Fetch the classification for a specific asset
List<org.odpi.openmetadata.accessservices.assetcatalog.model.Type>	getSupportedTypes(String userId)	Asset catalog supported types - a list of the types that are returned by the catalog
List<org.odpi.openmetadata.accessservices.assetcatalog.model.Elements>	searchAssets(String user, String searchCriteria, org.odpi.openmetadata.accessservices.assetcatalog.model.rest.body.SearchParameters searchParameters)	Fetch asset's header
List<org.odpi.openmetadata.accessservices.assetcatalog.model.Elements>	searchAssetsByTypeGUID(String user, String typeGUID)	Fetch asset's header by type GUID
List<org.odpi.openmetadata.accessservices.assetcatalog.model.Elements>	searchAssetsByTypeName(String user, String typeName)	Fetch asset's header by type name

Methods inherited from class java.lang.Object

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

Constructor Details

AssetCatalogOMASService

@Autowired
public AssetCatalogOMASService(org.odpi.openmetadata.accessservices.assetcatalog.AssetCatalog assetCatalog)

Method Details

getAssetDetails

public org.odpi.openmetadata.accessservices.assetcatalog.model.AssetCatalogBean getAssetDetails(String user,
 String assetId,
 String assetType)
                                                                                         throws org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException,
org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException

Fetch asset's header, classification and properties

Parameters:

user - userId of the user triggering the request

assetId - the unique identifier for the asset

assetType - the open metadata type

Returns:

the asset with its header and the list of associated classifications and specific properties

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem retrieving information from the property server

org.odpi.openmetadata.commonservices.ffdc.exceptions.InvalidParameterException - one of the parameters is null or invalid

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException

getAssetUniverse

public org.odpi.openmetadata.accessservices.assetcatalog.model.AssetCatalogBean getAssetUniverse(String user,
 String assetId,
 String assetType)
                                                                                          throws org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException,
org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException

Fetch asset's header, classification, properties and relationships

Parameters:

user - userId of the user triggering the request

assetId - the unique identifier for the asset

assetType - the open metadata type

Returns:

the asset with its header and the list of associated classifications

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem retrieving information from the property server

org.odpi.openmetadata.commonservices.ffdc.exceptions.InvalidParameterException - one of the parameters is null or invalid

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException

getAssetRelationships

public List<org.odpi.openmetadata.accessservices.assetcatalog.model.Relationship> getAssetRelationships(String user,
 String assetId,
 String assetType,
 String relationshipTypeGUID,
 Integer from,
 Integer pageSize)
                                                                                                 throws org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException,
org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException

Fetch the relationships for a specific asset

Parameters:

user - userId of the user triggering the request

assetId - the unique identifier for the asset

assetType - the open metadata type

relationshipTypeGUID - the relationships type

from - starting index

pageSize - number of relationships to be returned after starting index

Returns:

list of relationships for the given asset

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem retrieving information from the property server

org.odpi.openmetadata.commonservices.ffdc.exceptions.InvalidParameterException - one of the parameters is null or invalid

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException

getClassificationsForAsset

public List<org.odpi.openmetadata.accessservices.assetcatalog.model.Classification> getClassificationsForAsset(String user,
 String assetId,
 String assetType,
 String classificationName)
                                                                                                        throws org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException,
org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException

Fetch the classification for a specific asset

Parameters:

user - userId of the user triggering the request

assetId - the unique identifier for the asset

assetType - the open metadata type

classificationName - the cname of the classification

Returns:

the classifications for the asset

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem retrieving information from the property server

org.odpi.openmetadata.commonservices.ffdc.exceptions.InvalidParameterException - one of the parameters is null or invalid

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException

searchAssets

public List<org.odpi.openmetadata.accessservices.assetcatalog.model.Elements> searchAssets(String user,
 String searchCriteria,
 org.odpi.openmetadata.accessservices.assetcatalog.model.rest.body.SearchParameters searchParameters)
                                                                                    throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Fetch asset's header

Parameters:

user - userId of the user triggering the request

searchCriteria - the searchCriteria

searchParameters - the search parameters

Returns:

the assets for the search criteria

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem retrieving information from the property server

org.odpi.openmetadata.commonservices.ffdc.exceptions.InvalidParameterException - there is a problem with the parameters

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException

searchAssetsByTypeName

public List<org.odpi.openmetadata.accessservices.assetcatalog.model.Elements> searchAssetsByTypeName(String user,
 String typeName)
                                                                                              throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Fetch asset's header by type name

Parameters:

user - userId of the user triggering the request

typeName - the assets type name to search for

Returns:

list of assets by type name or GUID

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem retrieving information from the property server

org.odpi.openmetadata.commonservices.ffdc.exceptions.InvalidParameterException - there is a problem with the parameters

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException

searchAssetsByTypeGUID

public List<org.odpi.openmetadata.accessservices.assetcatalog.model.Elements> searchAssetsByTypeGUID(String user,
 String typeGUID)
                                                                                              throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Fetch asset's header by type GUID

Parameters:

user - userId of the user triggering the request

typeGUID - the assets type GUID to search for

Returns:

list of assets by type name or GUID

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem retrieving information from the property server

org.odpi.openmetadata.commonservices.ffdc.exceptions.InvalidParameterException - there is a problem with the parameters

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException

getAssetContext

public org.odpi.openmetadata.accessservices.assetcatalog.model.Elements getAssetContext(String userId,
 String assetId,
 String assetType)
                                                                                 throws org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException,
org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException

Fetch asset's context

Parameters:

userId - userId of the user triggering the request

assetId - the id of the asset (usually String representation of a GUID )

assetType - the open metadata type

Returns:

the asset context

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem retrieving information from the property server

org.odpi.openmetadata.commonservices.ffdc.exceptions.InvalidParameterException - there is a problem with the parameters

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException

getSupportedTypes

public List<org.odpi.openmetadata.accessservices.assetcatalog.model.Type> getSupportedTypes(String userId)
                                                                                     throws org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException,
org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException

Asset catalog supported types - a list of the types that are returned by the catalog

Parameters:

userId - userId of the user triggering the request

Returns:

the list of supported types

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem retrieving information from the property server

org.odpi.openmetadata.commonservices.ffdc.exceptions.InvalidParameterException - there is a problem with the parameters

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException