org.odpi.openmetadata.accessservices.assetcatalog

Class AssetCatalog

java.lang.Object

org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClientBase

org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClient

org.odpi.openmetadata.accessservices.assetcatalog.AssetCatalog

All Implemented Interfaces:

AssetCatalogInterface

public class AssetCatalog
extends FFDCRESTClient
implements AssetCatalogInterface

The Asset Catalog Open Metadata Access Service (OMAS) provides an interface to search for assets including data stores, event feeds, APIs and data sets, related assets and relationships. Also, it can return the connection details for the asset metadata. The Asset Catalog OMAS includes:

• Client-side provides language-specific client packages to make it easier for data tools and applications to call the interface.
• OMAS Server calls to retrieve assets and information related to the assets.

Field Summary

Fields inherited from class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClientBase

auditLog, exceptionHandler, serverName, serverPlatformURLRoot

Constructor Summary

Constructors

Constructor and Description
AssetCatalog(String serverName, String serverPlatformURLRoot) Create a new AssetCatalog client.
AssetCatalog(String serverName, String serverPlatformURLRoot, String userId, String password)

Method Summary

Modifier and Type	Method and Description
AssetResponse	getAssetContext(String userId, String assetGUID, String assetType) Return the full context of an asset/glossary term based on its identifier.
AssetDescriptionResponse	getAssetDetails(String userId, String assetGUID, String assetType) Fetch asset's header, classification and properties
RelationshipListResponse	getAssetRelationships(String userId, String assetGUID, String assetType, String relationshipType, Integer from, Integer pageSize) Fetch the relationships for a specific asset
AssetDescriptionListResponse	getAssetsFromNeighborhood(String userId, String assetGUID, SearchParameters searchParameters) Returns the sub-graph that represents the list of assets that in neighborhood of the given asset
AssetDescriptionResponse	getAssetUniverse(String userId, String assetGUID, String assetType) Fetch asset's header, classification, properties and relationships
ClassificationListResponse	getClassificationsForAsset(String userId, String assetGUID, String assetType, String classificationName) Fetch the classification for a specific asset
AssetDescriptionListResponse	getLinkingAssets(String userId, String startAssetGUID, String endAssetGUID) Returns a sub-graph of intermediate assets that connected two assets
RelationshipListResponse	getLinkingRelationships(String userId, String startAssetGUID, String endAssetGUID) Return a sub-graph of relationships that connect two assets
RelationshipResponse	getRelationshipBetweenEntities(String userId, String entity1GUID, String entity2GUID, String relationshipType) Fetch relationship between entities details based on its unique identifier of the ends Filtering based on the relationship type is supported
AssetCatalogSupportedTypes	getSupportedTypes(String userId, String type) Returns the list with supported types for search, including the sub-types supported
AssetListResponse	searchByType(String userId, String searchCriteria, SearchParameters searchParameters) Return a list of assets matching the search criteria without the full context

Methods inherited from class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClient

callCountGetRESTCall, callGUIDGetRESTCall, callGUIDListGetRESTCall, callGUIDListPostRESTCall, callGUIDPostRESTCall, callNameListGetRESTCall, callStringMapGetRESTCall, callVoidGetRESTCall, callVoidPostRESTCall

Methods inherited from class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClientBase

callDeleteRESTCall, callGetRESTCall, callGetRESTCallNoParams, callPostRESTCall, callPostRESTCallNoParams, callPutRESTCall

Methods inherited from class java.lang.Object

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

Constructor Detail

AssetCatalog

public AssetCatalog(String serverName,
                    String serverPlatformURLRoot)
             throws InvalidParameterException

Create a new AssetCatalog client.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST servers

Throws:

InvalidParameterException - if parameter validation fails

InvalidParameterException

AssetCatalog

public AssetCatalog(String serverName,
                    String serverPlatformURLRoot,
                    String userId,
                    String password)
             throws InvalidParameterException

Throws:

InvalidParameterException

Method Detail

getAssetDetails

public AssetDescriptionResponse getAssetDetails(String userId,
                                                String assetGUID,
                                                String assetType)
                                         throws InvalidParameterException,
                                                PropertyServerException

Fetch asset's header, classification and properties

Specified by:

getAssetDetails in interface AssetCatalogInterface

Parameters:

userId - the unique identifier for the user

assetGUID - the unique identifier for the asset

assetType - the type of the asset

Returns:

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

Throws:

InvalidParameterException - if parameter validation fails

PropertyServerException - if a problem occurs while serving the request

InvalidParameterException

getAssetUniverse

public AssetDescriptionResponse getAssetUniverse(String userId,
                                                 String assetGUID,
                                                 String assetType)
                                          throws InvalidParameterException,
                                                 PropertyServerException

Fetch asset's header, classification, properties and relationships

Specified by:

getAssetUniverse in interface AssetCatalogInterface

Parameters:

userId - the unique identifier for the user

assetGUID - the unique identifier for the asset

assetType - the asset type

Returns:

the asset with its header and the list of associated classifications and relationship

Throws:

InvalidParameterException - if parameter validation fails

PropertyServerException - if a problem occurs while serving the request

InvalidParameterException

getAssetRelationships

public RelationshipListResponse getAssetRelationships(String userId,
                                                      String assetGUID,
                                                      String assetType,
                                                      String relationshipType,
                                                      Integer from,
                                                      Integer pageSize)
                                               throws InvalidParameterException,
                                                      PropertyServerException

Fetch the relationships for a specific asset

Specified by:

getAssetRelationships in interface AssetCatalogInterface

Parameters:

userId - the unique identifier for the user

assetGUID - the unique identifier for the asset

assetType - the type of the asset

relationshipType - the type of the relationship

from - offset

pageSize - limit the number of the assets returned

Returns:

list of relationships for the given asset

Throws:

InvalidParameterException - if parameter validation fails

PropertyServerException - if a problem occurs while serving the request

InvalidParameterException

getClassificationsForAsset

public ClassificationListResponse getClassificationsForAsset(String userId,
                                                             String assetGUID,
                                                             String assetType,
                                                             String classificationName)
                                                      throws InvalidParameterException,
                                                             PropertyServerException

Fetch the classification for a specific asset

Specified by:

getClassificationsForAsset in interface AssetCatalogInterface

Parameters:

userId - the unique identifier for the user

assetGUID - the unique identifier for the asset

assetType - the type of the asset

classificationName - the name of the classification

Returns:

ClassificationsResponse the classification for the asset

Throws:

InvalidParameterException - if parameter validation fails

PropertyServerException - if a problem occurs while serving the request

InvalidParameterException

getLinkingAssets

public AssetDescriptionListResponse getLinkingAssets(String userId,
                                                     String startAssetGUID,
                                                     String endAssetGUID)
                                              throws InvalidParameterException,
                                                     PropertyServerException

Returns a sub-graph of intermediate assets that connected two assets

Specified by:

getLinkingAssets in interface AssetCatalogInterface

Parameters:

userId - the unique identifier for the user

startAssetGUID - the starting asset identifier of the query

endAssetGUID - the ending asset identifier of the query

Returns:

a list of assets between the given assets

Throws:

InvalidParameterException - if parameter validation fails

PropertyServerException - if a problem occurs while serving the request

InvalidParameterException

getLinkingRelationships

public RelationshipListResponse getLinkingRelationships(String userId,
                                                        String startAssetGUID,
                                                        String endAssetGUID)
                                                 throws InvalidParameterException,
                                                        PropertyServerException

Return a sub-graph of relationships that connect two assets

Specified by:

getLinkingRelationships in interface AssetCatalogInterface

Parameters:

userId - the unique identifier for the user

startAssetGUID - the starting asset identifier of the query

endAssetGUID - the ending asset identifier of the query

Returns:

a list of relationships that connects the assets

Throws:

InvalidParameterException - if parameter validation fails

PropertyServerException - if a problem occurs while serving the request

InvalidParameterException

getAssetsFromNeighborhood

public AssetDescriptionListResponse getAssetsFromNeighborhood(String userId,
                                                              String assetGUID,
                                                              SearchParameters searchParameters)
                                                       throws InvalidParameterException,
                                                              PropertyServerException

Returns the sub-graph that represents the list of assets that in neighborhood of the given asset

Specified by:

getAssetsFromNeighborhood in interface AssetCatalogInterface

Parameters:

userId - the unique identifier for the user

assetGUID - the starting asset identifier of the query

searchParameters - constrains to make the assets's search results more precise

Returns:

a list of assets that in neighborhood of the given asset

Throws:

InvalidParameterException - if parameter validation fails

PropertyServerException - if a problem occurs while serving the request

InvalidParameterException

searchByType

public AssetListResponse searchByType(String userId,
                                      String searchCriteria,
                                      SearchParameters searchParameters)
                               throws InvalidParameterException,
                                      PropertyServerException

Return a list of assets matching the search criteria without the full context

Specified by:

searchByType in interface AssetCatalogInterface

Parameters:

userId - the unique identifier for the user

searchCriteria - a string expression of the characteristics of the required assets

searchParameters - constrains to make the assets's search results more precise

Returns:

list of properties used to narrow the search

Throws:

InvalidParameterException - if parameter validation fails

PropertyServerException - if a problem occurs while serving the request

InvalidParameterException

getAssetContext

public AssetResponse getAssetContext(String userId,
                                     String assetGUID,
                                     String assetType)
                              throws InvalidParameterException,
                                     PropertyServerException

Return the full context of an asset/glossary term based on its identifier. The response contains the list of the connections assigned to the asset.

Specified by:

getAssetContext in interface AssetCatalogInterface

Parameters:

userId - the unique identifier for the user

assetGUID - the global unique identifier of the asset

assetType - the type of the asset

Returns:

list of properties used to narrow the search

Throws:

InvalidParameterException - if parameter validation fails

PropertyServerException - if a problem occurs while serving the request

InvalidParameterException

getRelationshipBetweenEntities

public RelationshipResponse getRelationshipBetweenEntities(String userId,
                                                           String entity1GUID,
                                                           String entity2GUID,
                                                           String relationshipType)
                                                    throws InvalidParameterException,
                                                           PropertyServerException

Fetch relationship between entities details based on its unique identifier of the ends Filtering based on the relationship type is supported

Specified by:

getRelationshipBetweenEntities in interface AssetCatalogInterface

Parameters:

userId - the unique identifier for the user

entity1GUID - Entity guid of the first end of the relationship

entity2GUID - Entity guid of the second end of the relationship

relationshipType - Type of the relationship

Returns:

relationships between entities

Throws:

InvalidParameterException - if parameter validation fails

PropertyServerException - if a problem occurs while serving the request

InvalidParameterException

getSupportedTypes

public AssetCatalogSupportedTypes getSupportedTypes(String userId,
                                                    String type)
                                             throws PropertyServerException,
                                                    InvalidParameterException

Description copied from interface: AssetCatalogInterface

Returns the list with supported types for search, including the sub-types supported

Specified by:

getSupportedTypes in interface AssetCatalogInterface

Parameters:

userId - the unique identifier for the user

type - the type

Returns:

list of types and sub-types supported for search

Throws:

PropertyServerException

InvalidParameterException