Package org.odpi.openmetadata.accessservices.assetconsumer.client

Class AssetConsumer

java.lang.Object
org.odpi.openmetadata.frameworkservices.ocf.metadatamanagement.client.ConnectedAssetClientBase
org.odpi.openmetadata.accessservices.assetconsumer.client.AssetConsumer
All Implemented Interfaces:
org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerAssetInterface, org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerFeedbackInterface, org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerGlossaryInterface, org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerLoggingInterface, org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerTaggingInterface, org.odpi.openmetadata.frameworkservices.ocf.metadatamanagement.api.ConnectorFactoryInterface
public class AssetConsumer extends org.odpi.openmetadata.frameworkservices.ocf.metadatamanagement.client.ConnectedAssetClientBase implements org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerAssetInterface, org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerFeedbackInterface, org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerGlossaryInterface, org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerLoggingInterface, org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerTaggingInterface
The Asset Consumer Open Metadata Access Service (OMAS) is used by applications and tools as a factory for Open Connector Framework (OCF) connectors. The configuration for the connectors is managed as open metadata in a Connection definition. The caller to the Asset Consumer OMAS passes either the name, GUID or URL for the connection to the appropriate method to retrieve a connector. The Asset Consumer OMAS retrieves the connection from the metadata repository and creates an appropriate connector as described the connection and returns it to the caller. The Asset Consumer OMAS supports access to the asset properties either through the connector, or by a direct call to Asset Consumer API. It is also possible to look up the definitions of terms associated with the assets. It supports the ability to add and remove feedback for an asset. This feedback may be in the form of reviews, likes and comments. Asset Consumer OMAS also supports the maintenance of informal tags and their attachments to assets. Finally, Asset Consumer OMAS supports the ability to add audit log records to the local server's audit log about an asset.

  • Constructor Summary

    Constructors
    Constructor
    Description
    AssetConsumer(String serverName, String serverPlatformURLRoot)
    Create a new client with no authentication embedded in the HTTP request.
    AssetConsumer(String serverName, String serverPlatformURLRoot, String userId, String password)
    Create a new client that passes userId and password in each HTTP request.
    AssetConsumer(String serverName, String serverPlatformURLRoot, String userId, String password, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog)
    Create a new client that passes userId and password in each HTTP request.
    AssetConsumer(String serverName, String serverPlatformURLRoot, AssetConsumerRESTClient restClient, int maxPageSize, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog)
    Create a new client that is going to be used in an OMAG Server (view service or integration service typically).
    AssetConsumer(String serverName, String serverPlatformURLRoot, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog)
    Create a new client with no authentication embedded in the HTTP request.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    addCommentReply(String userId, String assetGUID, String commentGUID, org.odpi.openmetadata.frameworks.openmetadata.enums.CommentType commentType, String commentText, boolean isPublic)
    Adds a comment to another comment.
    String
    addCommentToAsset(String userId, String assetGUID, org.odpi.openmetadata.frameworks.openmetadata.enums.CommentType commentType, String commentText, boolean isPublic)
    Adds a comment to the asset.
    void
    addLikeToAsset(String userId, String assetGUID, boolean isPublic)
    Adds a "LikeProperties" to the asset.
    void
    addLogMessageToAsset(String userId, String assetGUID, String connectorInstanceId, String connectionName, String connectorType, String contextId, String message)
    Creates an Audit log record about the asset.
    void
    addRatingToAsset(String userId, String assetGUID, org.odpi.openmetadata.frameworks.openmetadata.enums.StarRating starRating, String review, boolean isPublic)
    Adds a star rating and optional review text to the asset.
    void
    addTagToAsset(String userId, String assetGUID, String tagGUID, boolean isPublic)
    Adds a tag (either private of public) to an asset.
    void
    addTagToElement(String userId, String elementGUID, String tagGUID, boolean isPublic)
    Adds a tag (either private of public) to an element attached to an asset - such as schema element, glossary term, ...
    String
    createPrivateTag(String userId, String tagName, String tagDescription)
    Creates a new private informal tag and returns the unique identifier for it.
    String
    createPublicTag(String userId, String tagName, String tagDescription)
    Creates a new public informal tag and returns the unique identifier for it.
    void
    deleteTag(String userId, String tagGUID)
    Removes a tag from the repository.
    List<String>
    findAssets(String userId, String searchString, int startFrom, int pageSize)
    Return a list of assets with the requested search string in their name, qualified name or description.
    List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.AssetSearchMatches>
    findAssetsInDomain(String userId, String searchString, int startFrom, int pageSize)
    Locate string value in elements that are anchored to assets.
    List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.MeaningElement>
    findMeanings(String userId, String term, int startFrom, int pageSize)
    Return the full definition (meaning) of the terms matching the supplied name.
    List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.InformalTagElement>
    findMyTags(String userId, String tag, int startFrom, int pageSize)
    Return the list of the calling user's private tags containing the supplied string in either the name or description.
    List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.InformalTagElement>
    findTags(String userId, String tag, int startFrom, int pageSize)
    Return the list of tags containing the supplied string in either the name or description.
    String
    getAssetForConnection(String userId, String connectionGUID)
    Returns the unique identifier for the asset connected to the requested connection.
    String
    getAssetForConnectionName(String userId, String connectionName)
    Returns the asset corresponding to the supplied connection name.
    org.odpi.openmetadata.frameworks.openmetadata.metadataelements.AssetGraph
    getAssetGraph(String userId, String assetGUID, int startFrom, int pageSize)
    Return all the elements that are anchored to an asset plus relationships between these elements and to other elements.
    List<String>
    getAssetsByMeaning(String userId, String termGUID, int startFrom, int pageSize)
    Return the list of unique identifiers for assets that are linked to a specific (meaning) either directly or via fields in the schema.
    List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.AssetElement>
    getAssetsByMetadataCollectionId(String userId, String metadataCollectionId, String typeName, int startFrom, int pageSize)
    Return a list of assets with the requested name.
    List<String>
    getAssetsByName(String userId, String name, int startFrom, int pageSize)
    Return a list of assets with the requested name.
    List<String>
    getAssetsByTag(String userId, String tagGUID, int startFrom, int pageSize)
    Return the list of unique identifiers for assets that are linked to a specific tag either directly, or via one of its schema elements.
    List<String>
    getAssetsByToken(String userId, String assetToken, int startFrom, int pageSize)
    Returns a list of assets that match the token.
    org.odpi.openmetadata.frameworks.openmetadata.metadataelements.MeaningElement
    getMeaning(String userId, String guid)
    Return the full definition (meaning) of a term using the unique identifier of the glossary term that contains the definition.
    List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.MeaningElement>
    getMeaningByName(String userId, String term, int startFrom, int pageSize)
    Return the full definition (meaning) of the terms exactly matching the supplied name.
    List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.InformalTagElement>
    getMyTagsByName(String userId, String tag, int startFrom, int pageSize)
    Return the list of the calling user's private tags exactly matching the supplied name.
    org.odpi.openmetadata.frameworks.openmetadata.metadataelements.InformalTagElement
    getTag(String userId, String guid)
    Return the tag for the supplied unique identifier (guid).
    List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.InformalTagElement>
    getTagsByName(String userId, String tag, int startFrom, int pageSize)
    Return the list of tags exactly matching the supplied name.
    void
    removeComment(String userId, String assetGUID, String commentGUID)
    Removes a comment added to the asset by this user.
    void
    removeLikeFromAsset(String userId, String assetGUID)
    Removes a "LikeProperties" added to the asset by this user.
    void
    removeRatingFromAsset(String userId, String assetGUID)
    Removes of a review that was added to the asset by this user.
    void
    removeTagFromAsset(String userId, String assetGUID, String tagGUID)
    Removes a tag from the asset that was added by this user.
    void
    removeTagFromElement(String userId, String elementGUID, String tagGUID)
    Removes a tag from an element attached to an asset - such as schema element, glossary term, ...
    void
    updateComment(String userId, String assetGUID, String commentGUID, org.odpi.openmetadata.frameworks.openmetadata.enums.CommentType commentType, String commentText, boolean isPublic)
    Update an existing comment.
    void
    updateTagDescription(String userId, String tagGUID, String tagDescription)
    Updates the description of an existing tag (either private or public).

    Methods inherited from class org.odpi.openmetadata.frameworkservices.ocf.metadatamanagement.client.ConnectedAssetClientBase

    getAnchorAssetFromGUID, getAssetProperties, getConnectionForAsset, getConnectorByConnection, getConnectorByGUID, getConnectorByName, getConnectorForAsset, getConnectorForAsset, logAssetAuditMessage, saveConnection, saveConnection

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerAssetInterface

    getAssetProperties

  • Constructor Details

    • AssetConsumer

      public AssetConsumer(String serverName, String serverPlatformURLRoot, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
      Create a new client with no authentication embedded in the HTTP request.
      Parameters:
      serverName - name of the server to connect to
      serverPlatformURLRoot - the network address of the server running the OMAS REST services
      auditLog - logging destination
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - null URL or server name

    • AssetConsumer

      public AssetConsumer(String serverName, String serverPlatformURLRoot) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
      Create a new client with no authentication embedded in the HTTP request.
      Parameters:
      serverName - name of the server to connect to
      serverPlatformURLRoot - the network address of the server running the OMAS REST services
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - null URL or server name

    • AssetConsumer

      public AssetConsumer(String serverName, String serverPlatformURLRoot, String userId, String password, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
      Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.
      Parameters:
      serverName - name of the server to connect to
      serverPlatformURLRoot - the network address of the server running the OMAS REST services
      userId - caller's userId embedded in all HTTP requests
      password - caller's userId embedded in all HTTP requests
      auditLog - logging destination
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - null URL or server name

    • AssetConsumer

      public AssetConsumer(String serverName, String serverPlatformURLRoot, String userId, String password) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
      Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.
      Parameters:
      serverName - name of the server to connect to
      serverPlatformURLRoot - the network address of the server running the OMAS REST services
      userId - caller's userId embedded in all HTTP requests
      password - caller's userId embedded in all HTTP requests
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - null URL or server name

    • AssetConsumer

      public AssetConsumer(String serverName, String serverPlatformURLRoot, AssetConsumerRESTClient restClient, int maxPageSize, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
      Create a new client that is going to be used in an OMAG Server (view service or integration service typically).
      Parameters:
      serverName - name of the server to connect to
      serverPlatformURLRoot - the network address of the server running the OMAS REST services
      restClient - client that issues the REST API calls
      maxPageSize - maximum number of results supported by this server
      auditLog - logging destination
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

  • Method Details

    • getAssetForConnection

      public String getAssetForConnection(String userId, String connectionGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Returns the unique identifier for the asset connected to the requested connection.
      Specified by:
      getAssetForConnection in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerAssetInterface
      Parameters:
      userId - the userId of the requesting user.
      connectionGUID - unique identifier for the connection.
      Returns:
      unique identifier of asset.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem retrieving information from the property server.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • getAssetForConnectionName

      public String getAssetForConnectionName(String userId, String connectionName) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Returns the asset corresponding to the supplied connection name.
      Specified by:
      getAssetForConnectionName in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerAssetInterface
      Parameters:
      userId - userId of user making request.
      connectionName - this may be the qualifiedName or displayName of the connection.
      Returns:
      unique identifier of asset.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem retrieving information from the property server(s).
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • getAssetsByMetadataCollectionId

      public List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.AssetElement> getAssetsByMetadataCollectionId(String userId, String metadataCollectionId, String typeName, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Return a list of assets with the requested name. The name must match exactly.
      Parameters:
      userId - calling user
      metadataCollectionId - unique identifier of the metadata collection to search for
      typeName - optional type name to limit the search results
      startFrom - starting element (used in paging through large result sets)
      pageSize - maximum number of results to return
      Returns:
      list of unique identifiers of assets with matching name.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the name is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem access in the property server
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user does not have access to the properties

    • getAssetGraph

      public org.odpi.openmetadata.frameworks.openmetadata.metadataelements.AssetGraph getAssetGraph(String userId, String assetGUID, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Return all the elements that are anchored to an asset plus relationships between these elements and to other elements.
      Parameters:
      userId - calling user
      assetGUID - unique identifier of the asset
      startFrom - starting element (used in paging through large result sets)
      pageSize - maximum number of results to return
      Returns:
      graph of elements
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the name is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem access in the property server
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user does not have access to the properties

    • findAssetsInDomain

      public List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.AssetSearchMatches> findAssetsInDomain(String userId, String searchString, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Locate string value in elements that are anchored to assets. The search string may be a regEx.
      Parameters:
      userId - calling user
      searchString - value to search for (maybe regEx)
      startFrom - starting element (used in paging through large result sets)
      pageSize - maximum number of results to return
      Returns:
      found elements organized by asset
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the searchString is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem access in the property server
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user does not have access to the properties

    • findAssets

      public List<String> findAssets(String userId, String searchString, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Return a list of assets with the requested search string in their name, qualified name or description. The search string is interpreted as a regular expression (RegEx).
      Specified by:
      findAssets in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerAssetInterface
      Parameters:
      userId - calling user
      searchString - string to search for in text
      startFrom - starting element (used in paging through large result sets)
      pageSize - maximum number of results to return
      Returns:
      list of assets that match the search string.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the searchString is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem access in the property server
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user does not have access to the properties

    • getAssetsByName

      public List<String> getAssetsByName(String userId, String name, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Return a list of assets with the requested name.
      Specified by:
      getAssetsByName in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerAssetInterface
      Parameters:
      userId - calling user
      name - name to search for
      startFrom - starting element (used in paging through large result sets)
      pageSize - maximum number of results to return
      Returns:
      list of unique identifiers of assets with matching name.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the name is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem access in the property server
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user does not have access to the properties

    • getAssetsByToken

      public List<String> getAssetsByToken(String userId, String assetToken, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Returns a list of assets that match the token. The following calls are issued in order for find the asset. - getAssetProperties passing the token as the GUID - getAssetByName passing the token as the name
      Specified by:
      getAssetsByToken in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerAssetInterface
      Parameters:
      userId - userId of user making request.
      assetToken - token used to find the Asset - may be a name or GUID
      startFrom - starting element (used in paging through large result sets)
      pageSize - maximum number of results to return
      Returns:
      a list of unique identifiers for the matching assets
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem retrieving the asset properties from the property servers.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • addRatingToAsset

      public void addRatingToAsset(String userId, String assetGUID, org.odpi.openmetadata.frameworks.openmetadata.enums.StarRating starRating, String review, boolean isPublic) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Adds a star rating and optional review text to the asset. If the user has already attached a rating then the original one is over-ridden.
      Specified by:
      addRatingToAsset in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerFeedbackInterface
      Parameters:
      userId - userId of user making request.
      assetGUID - unique identifier for the asset.
      starRating - StarRating enumeration for not recommended, one to five stars.
      review - user review of asset. This can be null.
      isPublic - indicates whether the feedback should be shared or only be visible to the originating user
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem adding the asset properties to the property server.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • removeRatingFromAsset

      public void removeRatingFromAsset(String userId, String assetGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Removes of a review that was added to the asset by this user.
      Specified by:
      removeRatingFromAsset in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerFeedbackInterface
      Parameters:
      userId - userId of user making request.
      assetGUID - unique identifier for the attached asset.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem updating the asset properties in the property server.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • addLikeToAsset

      public void addLikeToAsset(String userId, String assetGUID, boolean isPublic) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Adds a "LikeProperties" to the asset.
      Specified by:
      addLikeToAsset in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerFeedbackInterface
      Parameters:
      userId - userId of user making request
      assetGUID - unique identifier for the asset
      isPublic - indicates whether the feedback should be shared or only be visible to the originating user
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem adding the asset properties to the property server.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • removeLikeFromAsset

      public void removeLikeFromAsset(String userId, String assetGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Removes a "LikeProperties" added to the asset by this user.
      Specified by:
      removeLikeFromAsset in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerFeedbackInterface
      Parameters:
      userId - userId of user making request.
      assetGUID - unique identifier for the like object.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem updating the asset properties in the property server.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • addCommentToAsset

      public String addCommentToAsset(String userId, String assetGUID, org.odpi.openmetadata.frameworks.openmetadata.enums.CommentType commentType, String commentText, boolean isPublic) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Adds a comment to the asset.
      Specified by:
      addCommentToAsset in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerFeedbackInterface
      Parameters:
      userId - userId of user making request.
      assetGUID - unique identifier for the asset.
      commentType - type of comment enum.
      commentText - the text of the comment.
      isPublic - indicates whether the feedback should be shared or only be visible to the originating user
      Returns:
      guid of new comment.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem adding the asset properties to the property server.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • addCommentReply

      public String addCommentReply(String userId, String assetGUID, String commentGUID, org.odpi.openmetadata.frameworks.openmetadata.enums.CommentType commentType, String commentText, boolean isPublic) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Adds a comment to another comment.
      Specified by:
      addCommentReply in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerFeedbackInterface
      Parameters:
      userId - userId of user making request.
      assetGUID - String - unique id of asset that this chain of comments is linked.
      commentGUID - unique identifier for an existing comment. Used to add a reply to a comment.
      commentType - type of comment enum.
      commentText - the text of the comment.
      isPublic - indicates whether the feedback should be shared or only be visible to the originating user
      Returns:
      guid of new comment.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem adding the asset properties to the property server.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • updateComment

      public void updateComment(String userId, String assetGUID, String commentGUID, org.odpi.openmetadata.frameworks.openmetadata.enums.CommentType commentType, String commentText, boolean isPublic) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Update an existing comment.
      Specified by:
      updateComment in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerFeedbackInterface
      Parameters:
      userId - userId of user making request.
      assetGUID - unique identifier for the asset that the comment is attached to (directly or indirectly).
      commentGUID - unique identifier for the comment to change.
      commentType - type of comment enum.
      commentText - the text of the comment.
      isPublic - indicates whether the feedback should be shared or only be visible to the originating user
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem adding the asset properties to the property server.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • removeComment

      public void removeComment(String userId, String assetGUID, String commentGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Removes a comment added to the asset by this user.
      Specified by:
      removeComment in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerFeedbackInterface
      Parameters:
      userId - userId of user making request.
      assetGUID - unique identifier for the asset object.
      commentGUID - unique identifier for the comment object.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem updating the asset properties in the property server.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user does not have permission to perform this request.

    • getMeaning

      public org.odpi.openmetadata.frameworks.openmetadata.metadataelements.MeaningElement getMeaning(String userId, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Return the full definition (meaning) of a term using the unique identifier of the glossary term that contains the definition.
      Specified by:
      getMeaning in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerGlossaryInterface
      Parameters:
      userId - userId of the user making the request.
      guid - unique identifier of the glossary term.
      Returns:
      properties that describe the meaning
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the userId is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem retrieving information from the property server(s).
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • getMeaningByName

      public List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.MeaningElement> getMeaningByName(String userId, String term, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Return the full definition (meaning) of the terms exactly matching the supplied name.
      Specified by:
      getMeaningByName in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerGlossaryInterface
      Parameters:
      userId - the name of the calling user.
      term - name of term.
      startFrom - index of the list to start from (0 for start)
      pageSize - maximum number of elements to return.
      Returns:
      list of glossary terms that contain the properties that describe the term name, and it's meaning.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the userId is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem retrieving information from the property server(s).
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • findMeanings

      public List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.MeaningElement> findMeanings(String userId, String term, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Return the full definition (meaning) of the terms matching the supplied name.
      Specified by:
      findMeanings in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerGlossaryInterface
      Parameters:
      userId - the name of the calling user.
      term - name of term. This may include wild card characters.
      startFrom - index of the list to start from (0 for start)
      pageSize - maximum number of elements to return.
      Returns:
      meaning list response or
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the userId is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem retrieving information from the property server(s).
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • getAssetsByMeaning

      public List<String> getAssetsByMeaning(String userId, String termGUID, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Return the list of unique identifiers for assets that are linked to a specific (meaning) either directly or via fields in the schema.
      Specified by:
      getAssetsByMeaning in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerGlossaryInterface
      Parameters:
      userId - the name of the calling user.
      termGUID - unique identifier of term.
      startFrom - index of the list to start from (0 for start)
      pageSize - maximum number of elements to return.
      Returns:
      asset guid list
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the userId is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem retrieving information from the property server(s).
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • addLogMessageToAsset

      public void addLogMessageToAsset(String userId, String assetGUID, String connectorInstanceId, String connectionName, String connectorType, String contextId, String message) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Creates an Audit log record about the asset. This log record is stored in the local server's Audit Log.
      Specified by:
      addLogMessageToAsset in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerLoggingInterface
      Parameters:
      userId - userId of user making request.
      assetGUID - unique id for the asset.
      connectorInstanceId - (optional) id of connector in use (if any).
      connectionName - (optional) name of the connection (extracted from the connector).
      connectorType - (optional) type of connector in use (if any).
      contextId - (optional) function name, or processId of the activity that the caller is performing.
      message - log record content.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - There is a problem adding the asset properties to the property server.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • createPublicTag

      public String createPublicTag(String userId, String tagName, String tagDescription) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Creates a new public informal tag and returns the unique identifier for it.
      Specified by:
      createPublicTag in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerTaggingInterface
      Parameters:
      userId - userId of user making request.
      tagName - name of the tag.
      tagDescription - (optional) description of the tag. Setting a description, particularly in a public tag makes the tag more valuable to other users and can act as an embryonic glossary term.
      Returns:
      GUID for new tag.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem adding the asset properties to the property server.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • createPrivateTag

      public String createPrivateTag(String userId, String tagName, String tagDescription) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Creates a new private informal tag and returns the unique identifier for it.
      Specified by:
      createPrivateTag in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerTaggingInterface
      Parameters:
      userId - userId of user making request.
      tagName - name of the tag.
      tagDescription - (optional) description of the tag. Setting a description, particularly in a public tag makes the tag more valuable to other users and can act as an embryonic glossary term.
      Returns:
      GUID for new tag.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem adding the asset properties to the property server.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • updateTagDescription

      public void updateTagDescription(String userId, String tagGUID, String tagDescription) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Updates the description of an existing tag (either private or public).
      Specified by:
      updateTagDescription in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerTaggingInterface
      Parameters:
      userId - userId of user making request.
      tagGUID - unique identifier for the tag.
      tagDescription - description of the tag. Setting a description, particularly in a public tag makes the tag more valuable to other users and can act as an embryonic glossary term.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem adding the asset properties to the property server.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • deleteTag

      public void deleteTag(String userId, String tagGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Removes a tag from the repository. A private tag can be deleted by its creator and all the references are lost; a public tag can be deleted by anyone, but only if it is not attached to any referenceable.
      Specified by:
      deleteTag in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerTaggingInterface
      Parameters:
      userId - userId of user making request.
      tagGUID - unique id for the tag.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem updating the asset properties in the property server.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • getTag

      public org.odpi.openmetadata.frameworks.openmetadata.metadataelements.InformalTagElement getTag(String userId, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Return the tag for the supplied unique identifier (guid).
      Specified by:
      getTag in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerTaggingInterface
      Parameters:
      userId - userId of the user making the request.
      guid - unique identifier of the tag.
      Returns:
      tag
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the userId is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem retrieving information from the property server(s).
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • getTagsByName

      public List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.InformalTagElement> getTagsByName(String userId, String tag, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Return the list of tags exactly matching the supplied name.
      Specified by:
      getTagsByName in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerTaggingInterface
      Parameters:
      userId - the name of the calling user.
      tag - name of tag.
      startFrom - index of the list to start from (0 for start)
      pageSize - maximum number of elements to return.
      Returns:
      tag list
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the userId is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem retrieving information from the property server(s).
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • getMyTagsByName

      public List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.InformalTagElement> getMyTagsByName(String userId, String tag, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Return the list of the calling user's private tags exactly matching the supplied name.
      Specified by:
      getMyTagsByName in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerTaggingInterface
      Parameters:
      userId - the name of the calling user.
      tag - name of tag.
      startFrom - index of the list to start from (0 for start)
      pageSize - maximum number of elements to return.
      Returns:
      tag list
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the userId is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem retrieving information from the property server(s).
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • findTags

      public List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.InformalTagElement> findTags(String userId, String tag, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Return the list of tags containing the supplied string in either the name or description.
      Specified by:
      findTags in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerTaggingInterface
      Parameters:
      userId - the name of the calling user.
      tag - name of tag. This may include wild card characters.
      startFrom - index of the list to start from (0 for start)
      pageSize - maximum number of elements to return.
      Returns:
      tag list
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the userId is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem retrieving information from the property server(s).
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • findMyTags

      public List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.InformalTagElement> findMyTags(String userId, String tag, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Return the list of the calling user's private tags containing the supplied string in either the name or description.
      Specified by:
      findMyTags in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerTaggingInterface
      Parameters:
      userId - the name of the calling user.
      tag - name of tag. This may include wild card characters.
      startFrom - index of the list to start from (0 for start)
      pageSize - maximum number of elements to return.
      Returns:
      tag list
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the userId is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem retrieving information from the property server(s).
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • addTagToAsset

      public void addTagToAsset(String userId, String assetGUID, String tagGUID, boolean isPublic) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Adds a tag (either private of public) to an asset.
      Specified by:
      addTagToAsset in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerTaggingInterface
      Parameters:
      userId - userId of user making request.
      assetGUID - unique id for the asset.
      tagGUID - unique id of the tag.
      isPublic - flag indicating whether the attachment of the tag is public or not
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem adding the asset properties to the property server.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • addTagToElement

      public void addTagToElement(String userId, String elementGUID, String tagGUID, boolean isPublic) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Adds a tag (either private of public) to an element attached to an asset - such as schema element, glossary term, ...
      Specified by:
      addTagToElement in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerTaggingInterface
      Parameters:
      userId - userId of user making request.
      elementGUID - unique id for the element.
      tagGUID - unique id of the tag.
      isPublic - flag indicating whether the attachment of the tag is public or not
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem adding the asset properties to the property server.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • removeTagFromAsset

      public void removeTagFromAsset(String userId, String assetGUID, String tagGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Removes a tag from the asset that was added by this user.
      Specified by:
      removeTagFromAsset in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerTaggingInterface
      Parameters:
      userId - userId of user making request.
      assetGUID - unique id for the asset.
      tagGUID - unique id for the tag.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem updating the asset properties in the property server.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • removeTagFromElement

      public void removeTagFromElement(String userId, String elementGUID, String tagGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Removes a tag from an element attached to an asset - such as schema element, glossary term, ... that was added by this user.
      Specified by:
      removeTagFromElement in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerTaggingInterface
      Parameters:
      userId - userId of user making request.
      elementGUID - unique id for the element.
      tagGUID - unique id for the tag.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem updating the asset properties in the property server.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • getAssetsByTag

      public List<String> getAssetsByTag(String userId, String tagGUID, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Return the list of unique identifiers for assets that are linked to a specific tag either directly, or via one of its schema elements. An Asset's GUID may appear multiple times in the results if it is tagged multiple times with the requested tag.
      Specified by:
      getAssetsByTag in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerTaggingInterface
      Parameters:
      userId - the name of the calling user.
      tagGUID - unique identifier of tag.
      startFrom - index of the list to start from (0 for start)
      pageSize - maximum number of elements to return.
      Returns:
      asset guid list
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the userId is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem retrieving information from the property server(s).
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.