Package org.odpi.openmetadata.accessservices.assetcatalog.service

Class AssetCatalogRESTService

java.lang.Object
org.odpi.openmetadata.accessservices.assetcatalog.service.AssetCatalogRESTService
public class AssetCatalogRESTService extends Object
The AssetCatalogService provides the server-side implementation of the Asset Catalog Open Metadata Assess Service (OMAS). This service provide the functionality to fetch asset's header, classification and properties.

  • Constructor Summary

    Constructors
    Constructor
    Description
    AssetCatalogRESTService()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    org.odpi.openmetadata.accessservices.assetcatalog.model.rest.responses.AssetResponse
    buildContext(String serverName, String userId, String assetGUID, String assetType)
    Return the full context of an asset/glossary term based on its identifier.
    org.odpi.openmetadata.accessservices.assetcatalog.model.rest.responses.AssetCatalogResponse
    getAssetDetailsByGUID(String serverName, String userId, String assetGUID, String assetTypeName)
    Fetch asset's header, classification and properties
    org.odpi.openmetadata.accessservices.assetcatalog.model.rest.responses.RelationshipListResponse
    getAssetRelationships(String serverName, String userId, String assetGUID, String assetTypeName, String relationshipTypeName, Integer startFrom, Integer limit)
     
    org.odpi.openmetadata.accessservices.assetcatalog.model.rest.responses.AssetCatalogResponse
    getAssetUniverseByGUID(String serverName, String userId, String assetGUID, String assetTypeName)
    Fetch asset's header, classification, properties and relationships
    org.odpi.openmetadata.accessservices.assetcatalog.model.rest.responses.ClassificationListResponse
    getClassificationByAssetGUID(String serverName, String userId, String assetGUID, String assetTypeName, String classificationName)
    Fetch the classification for a specific asset
    org.odpi.openmetadata.commonservices.ffdc.rest.ConnectionResponse
    getOutTopicConnection(String serverName, String userId, String callerId)
    Return the connection object for the Asset Catalog OMAS's out topic.
    org.odpi.openmetadata.accessservices.assetcatalog.model.rest.responses.AssetCatalogSupportedTypes
    getSupportedTypes(String serverName, String userId, String type)
    Returns supported types for search with all sub-types.
    org.odpi.openmetadata.accessservices.assetcatalog.model.rest.responses.AssetListResponse
    searchByType(String serverName, String userId, String searchCriteria, org.odpi.openmetadata.accessservices.assetcatalog.model.rest.body.SearchParameters searchParameters)
    Return a list of assets/glossary terms/schema elements matching the search criteria without the full context.
    org.odpi.openmetadata.accessservices.assetcatalog.model.rest.responses.AssetListResponse
    searchByTypeGUID(String serverName, String userId, String typeGUID)
    Return a list of assets/glossary terms/schema elements matching the type GUID without the full context.
    org.odpi.openmetadata.accessservices.assetcatalog.model.rest.responses.AssetListResponse
    searchByTypeName(String serverName, String userId, String typeName)
    Return a list of assets/glossary terms/schema elements matching the type name without the full context.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • AssetCatalogRESTService

      public AssetCatalogRESTService()

  • Method Details

    • getAssetDetailsByGUID

      public org.odpi.openmetadata.accessservices.assetcatalog.model.rest.responses.AssetCatalogResponse getAssetDetailsByGUID(String serverName, String userId, String assetGUID, String assetTypeName)
      Fetch asset's header, classification and properties
      Parameters:
      serverName - unique identifier for requested server.
      userId - the unique identifier for the user
      assetGUID - the unique identifier for the asset
      assetTypeName - the type of the asset
      Returns:
      the asset with its header and the list of associated classifications and specific properties

    • getAssetUniverseByGUID

      public org.odpi.openmetadata.accessservices.assetcatalog.model.rest.responses.AssetCatalogResponse getAssetUniverseByGUID(String serverName, String userId, String assetGUID, String assetTypeName)
      Fetch asset's header, classification, properties and relationships
      Parameters:
      serverName - unique identifier for requested server.
      userId - the unique identifier for the user
      assetGUID - the unique identifier for the asset
      assetTypeName - the asset type
      Returns:
      the asset with its header and the list of associated classifications and relationship

    • getClassificationByAssetGUID

      public org.odpi.openmetadata.accessservices.assetcatalog.model.rest.responses.ClassificationListResponse getClassificationByAssetGUID(String serverName, String userId, String assetGUID, String assetTypeName, String classificationName)
      Fetch the classification for a specific asset
      Parameters:
      serverName - unique identifier for requested server.
      userId - the unique identifier for the user
      assetGUID - the unique identifier for the asset
      assetTypeName - the type of the asset
      classificationName - the name of the classification
      Returns:
      ClassificationsResponse the classification for the asset

    • getAssetRelationships

      public org.odpi.openmetadata.accessservices.assetcatalog.model.rest.responses.RelationshipListResponse getAssetRelationships(String serverName, String userId, String assetGUID, String assetTypeName, String relationshipTypeName, Integer startFrom, Integer limit)

    • searchByType

      public org.odpi.openmetadata.accessservices.assetcatalog.model.rest.responses.AssetListResponse searchByType(String serverName, String userId, String searchCriteria, org.odpi.openmetadata.accessservices.assetcatalog.model.rest.body.SearchParameters searchParameters)
      Return a list of assets/glossary terms/schema elements matching the search criteria without the full context. If the searchParameters have an empty list of entity types, the response contains Glossary Terms, Schema Elements, Assets
      Parameters:
      serverName - unique identifier for requested server
      userId - the unique identifier for the user
      searchCriteria - a string expression of the characteristics of the required assets
      searchParameters - constraints to make the assets' search results more precise
      Returns:
      list of properties used to narrow the search

    • searchByTypeName

      public org.odpi.openmetadata.accessservices.assetcatalog.model.rest.responses.AssetListResponse searchByTypeName(String serverName, String userId, String typeName)
      Return a list of assets/glossary terms/schema elements matching the type name without the full context. If the typeName is null or doesn't exist, the response contains an empty list. The list includes also subtypes.
      Parameters:
      serverName - unique identifier for requested server
      userId - the unique identifier for the user
      typeName - the assets type name to search for
      Returns:
      list of assets by type name or GUID

    • searchByTypeGUID

      public org.odpi.openmetadata.accessservices.assetcatalog.model.rest.responses.AssetListResponse searchByTypeGUID(String serverName, String userId, String typeGUID)
      Return a list of assets/glossary terms/schema elements matching the type GUID without the full context. If the typeGUID is null or doesn't exist, the response contains an empty list. The list includes also subtypes.
      Parameters:
      serverName - unique identifier for requested server
      userId - the unique identifier for the user
      typeGUID - the assets type GUID to search for
      Returns:
      list of assets by type name or GUID

    • buildContext

      public org.odpi.openmetadata.accessservices.assetcatalog.model.rest.responses.AssetResponse buildContext(String serverName, String userId, String assetGUID, String assetType)
      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.
      Parameters:
      serverName - unique identifier for requested server.
      userId - the unique identifier for the user
      assetGUID - the global unique identifier of the asset
      assetType - the type of the asset
      Returns:
      the context of the given asset/glossary term/schema element

    • getSupportedTypes

      public org.odpi.openmetadata.accessservices.assetcatalog.model.rest.responses.AssetCatalogSupportedTypes getSupportedTypes(String serverName, String userId, String type)
      Returns supported types for search with all sub-types. If type name is provided, it returns the type itself and the list of sub-types for it
      Parameters:
      serverName - unique identifier for requested server.
      userId - user identifier that issues the call
      type - optional type name
      Returns:
      supported types

    • getOutTopicConnection

      public org.odpi.openmetadata.commonservices.ffdc.rest.ConnectionResponse getOutTopicConnection(String serverName, String userId, String callerId)
      Return the connection object for the Asset Catalog OMAS's out topic.
      Parameters:
      serverName - name of the service to route the request to.
      userId - identifier of calling user.
      callerId - unique identifier of the caller
      Returns:
      connection object for the out topic or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem retrieving the discovery engine definition.