Class AssetCatalogOMASService
java.lang.Object
org.odpi.openmetadata.userinterface.uichassis.springboot.service.AssetCatalogOMASService
The Asset Catalog OMAS Service provides an interface to search for assets using the Asset Catalog OMAS client
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiongetAssetContext
(String userId, String assetId, String assetType) Fetch asset's contextgetAssetDetails
(String user, String assetId, String assetType) Fetch asset's header, classification and propertiesgetAssetRelationships
(String user, String assetId, String assetType, String relationshipTypeGUID, Integer from, Integer pageSize) Fetch the relationships for a specific assetgetAssetUniverse
(String user, String assetId, String assetType) Fetch asset's header, classification, properties and relationshipsgetClassificationsForAsset
(String user, String assetId, String assetType, String classificationName) Fetch the classification for a specific assetgetSupportedTypes
(String userId) Asset catalog supported types - a list of the types that are returned by the catalogsearchAssets
(String user, String searchCriteria, SearchParameters searchParameters) Fetch asset's headersearchAssetsByTypeGUID
(String user, String typeGUID) Fetch asset's header by type GUIDsearchAssetsByTypeName
(String user, String typeName) Fetch asset's header by type name
-
Constructor Details
-
AssetCatalogOMASService
-
-
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 requestassetId
- the unique identifier for the assetassetType
- 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 serverInvalidParameterException
- one of the parameters is null or invalidInvalidParameterException
-
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 requestassetId
- the unique identifier for the assetassetType
- 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 serverInvalidParameterException
- one of the parameters is null or invalidInvalidParameterException
-
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 requestassetId
- the unique identifier for the assetassetType
- the open metadata typerelationshipTypeGUID
- the relationships typefrom
- starting indexpageSize
- 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 serverInvalidParameterException
- one of the parameters is null or invalidInvalidParameterException
-
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 requestassetId
- the unique identifier for the assetassetType
- the open metadata typeclassificationName
- the cname of the classification- Returns:
- the classifications for the asset
- Throws:
PropertyServerException
- there is a problem retrieving information from the property serverInvalidParameterException
- one of the parameters is null or invalidInvalidParameterException
-
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 requestsearchCriteria
- the searchCriteriasearchParameters
- the search parameters- Returns:
- the assets for the search criteria
- Throws:
PropertyServerException
- there is a problem retrieving information from the property serverInvalidParameterException
- there is a problem with the parametersInvalidParameterException
-
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 requesttypeName
- 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 serverInvalidParameterException
- there is a problem with the parametersInvalidParameterException
-
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 requesttypeGUID
- 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 serverInvalidParameterException
- there is a problem with the parametersInvalidParameterException
-
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 requestassetId
- 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 serverInvalidParameterException
- there is a problem with the parametersInvalidParameterException
-
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 serverInvalidParameterException
- there is a problem with the parametersInvalidParameterException
-