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(AssetCatalog assetCatalog)

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

AssetCatalogOMASService

@Autowired
public AssetCatalogOMASService(AssetCatalog assetCatalog)

Method Details

getAssetDetails

public AssetCatalogBean getAssetDetails(String user,
 String assetId,
 String assetType)
                                 throws PropertyServerException,
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:

PropertyServerException - there is a problem retrieving information from the property server

InvalidParameterException - one of the parameters is null or invalid

getAssetUniverse

public AssetCatalogBean getAssetUniverse(String user,
 String assetId,
 String assetType)
                                  throws PropertyServerException,
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:

PropertyServerException - there is a problem retrieving information from the property server

InvalidParameterException - one of the parameters is null or invalid

getAssetRelationships

public List<Relationship> getAssetRelationships(String user,
 String assetId,
 String assetType,
 String relationshipTypeGUID,
 Integer from,
 Integer pageSize)
                                         throws PropertyServerException,
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:

PropertyServerException - there is a problem retrieving information from the property server

InvalidParameterException - one of the parameters is null or invalid

getClassificationsForAsset

public List<Classification> getClassificationsForAsset(String user,
 String assetId,
 String assetType,
 String classificationName)
                                                throws PropertyServerException,
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:

PropertyServerException - there is a problem retrieving information from the property server

InvalidParameterException - one of the parameters is null or invalid

searchAssets

public List<Elements> searchAssets(String user,
 String searchCriteria,
 SearchParameters searchParameters)
                            throws InvalidParameterException,
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:

PropertyServerException - there is a problem retrieving information from the property server

InvalidParameterException - there is a problem with the parameters

searchAssetsByTypeName

public List<Elements> searchAssetsByTypeName(String user,
 String typeName)
                                      throws InvalidParameterException,
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:

PropertyServerException - there is a problem retrieving information from the property server

InvalidParameterException - there is a problem with the parameters

searchAssetsByTypeGUID

public List<Elements> searchAssetsByTypeGUID(String user,
 String typeGUID)
                                      throws InvalidParameterException,
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:

PropertyServerException - there is a problem retrieving information from the property server

InvalidParameterException - there is a problem with the parameters

getAssetContext

public Elements getAssetContext(String userId,
 String assetId,
 String assetType)
                         throws PropertyServerException,
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:

PropertyServerException - there is a problem retrieving information from the property server

InvalidParameterException - there is a problem with the parameters

getSupportedTypes

public List<Type> getSupportedTypes(String userId)
                             throws PropertyServerException,
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:

PropertyServerException - there is a problem retrieving information from the property server

InvalidParameterException - there is a problem with the parameters