Package org.odpi.openmetadata.accessservices.assetowner.client

Class AssetOwner

java.lang.Object
org.odpi.openmetadata.frameworkservices.ocf.metadatamanagement.client.ConnectedAssetClientBase
org.odpi.openmetadata.accessservices.assetowner.client.AssetOwner
All Implemented Interfaces:
org.odpi.openmetadata.accessservices.assetowner.api.AssetClassificationInterface, org.odpi.openmetadata.accessservices.assetowner.api.AssetConnectionManagementInterface, org.odpi.openmetadata.accessservices.assetowner.api.AssetDecommissioningInterface, org.odpi.openmetadata.accessservices.assetowner.api.AssetKnowledgeInterface, org.odpi.openmetadata.accessservices.assetowner.api.AssetOnboardingInterface, org.odpi.openmetadata.accessservices.assetowner.api.AssetReviewInterface, org.odpi.openmetadata.frameworkservices.ocf.metadatamanagement.api.ConnectorFactoryInterface
Direct Known Subclasses:
AvroFileAssetOwner, CSVFileAssetOwner, FileSystemAssetOwner, ValidValuesAssetOwner
public class AssetOwner extends org.odpi.openmetadata.frameworkservices.ocf.metadatamanagement.client.ConnectedAssetClientBase implements org.odpi.openmetadata.accessservices.assetowner.api.AssetKnowledgeInterface, org.odpi.openmetadata.accessservices.assetowner.api.AssetOnboardingInterface, org.odpi.openmetadata.accessservices.assetowner.api.AssetClassificationInterface, org.odpi.openmetadata.accessservices.assetowner.api.AssetConnectionManagementInterface, org.odpi.openmetadata.accessservices.assetowner.api.AssetReviewInterface, org.odpi.openmetadata.accessservices.assetowner.api.AssetDecommissioningInterface
AssetOwner provides the generic client-side interface for the Asset Owner Open Metadata Access Service (OMAS). There are other clients that provide specialized methods for specific types of Asset. This client is initialized with the URL and name of the server that is running the Asset Owner OMAS. This server is responsible for locating and managing the asset owner's definitions exchanged with this client.

  • Constructor Summary

    Constructors
    Constructor
    Description
    AssetOwner(String serverName, String serverPlatformURLRoot)
    Create a new client with no authentication embedded in the HTTP request.
    AssetOwner(String serverName, String serverPlatformURLRoot, String userId, String password)
    Create a new client that passes userId and password in each HTTP request.
    AssetOwner(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.
    AssetOwner(String serverName, String serverPlatformURLRoot, AssetOwnerRESTClient 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).
    AssetOwner(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
    void
    addAssetOrigin(String userId, String assetGUID, String organizationGUID, String businessCapabilityGUID, Map<String,String> otherOriginValues)
    Add the asset origin classification to an asset.
    String
    addAssetToCatalog(String userId, String typeName, String qualifiedName, String name, String description, Map<String,String> additionalProperties, Map<String,Object> extendedProperties)
    Add a simple asset description to the catalog.
    String
    addAssetToCatalog(String userId, org.odpi.openmetadata.accessservices.assetowner.properties.AssetProperties assetProperties)
    Add a comprehensive asset description to the catalog.
    String
    addAssetToCatalogUsingTemplate(String userId, String templateGUID, org.odpi.openmetadata.accessservices.assetowner.properties.TemplateProperties templateProperties)
    Create a new metadata element to represent an asset using an existing asset as a template.
    String
    addCombinedSchemaToAsset(String userId, String assetGUID, org.odpi.openmetadata.accessservices.assetowner.properties.SchemaTypeProperties schemaType, List<org.odpi.openmetadata.accessservices.assetowner.properties.SchemaAttributeProperties> schemaAttributes)
    Stores the supplied schema details in the catalog and attaches it to the asset.
    void
    addConnectionToAsset(String userId, String assetGUID, String assetSummary, org.odpi.openmetadata.frameworks.connectors.properties.beans.Connection connection)
    Deprecated.
    String
    addSchemaAttribute(String serverName, String userId, String assetGUID, String parentGUID, org.odpi.openmetadata.accessservices.assetowner.properties.SchemaAttributeProperties schemaAttribute)
    Adds a schema attribute to a complex schema type like a relational table, avro schema or a structured document.
    void
    addSchemaAttributes(String serverName, String userId, String assetGUID, String parentGUID, List<org.odpi.openmetadata.accessservices.assetowner.properties.SchemaAttributeProperties> schemaAttributes)
    Adds attributes to a complex schema type like a relational table, avro schema or a structured document.
    String
    addSchemaTypeToAsset(String userId, String assetGUID, org.odpi.openmetadata.accessservices.assetowner.properties.SchemaTypeProperties schemaType)
    Stores the supplied schema type in the catalog and attaches it to the asset.
    void
    addSecurityTags(String userId, String assetGUID, String assetElementGUID, List<String> securityLabels, Map<String,Object> securityProperties, Map<String,List<String>> accessGroups)
    Add or replace the security tags for an asset or one of its elements.
    void
    addSemanticAssignment(String userId, String assetGUID, String glossaryTermGUID, String assetElementGUID)
    Create a simple relationship between a glossary term and an element in an Asset description (typically a field in the schema).
    void
    addTemplateClassification(String userId, String assetGUID, String name, String description, Map<String,String> additionalProperties)
    Classify an asset as suitable to be used as a template for cataloguing assets of a similar types.
    void
    attachSchemaTypeToAsset(String userId, String assetGUID, String schemaTypeGUID)
    Links the supplied schema type directly to the asset.
    void
    clearAssetConnection(String userId, String assetGUID, String connectionGUID)
    Remove a relationship between an asset and its connection.
    void
    clearConnectorType(String userId, String connectionGUID, String connectorTypeGUID)
    Remove a relationship between a connection and a connector type.
    void
    clearEmbeddedConnection(String userId, String connectionGUID, String embeddedConnectionGUID)
    Remove a relationship between a virtual connection and an embedded connection.
    void
    clearEndpoint(String userId, String connectionGUID, String endpointGUID)
    Remove a relationship between a connection and an endpoint.
    String
    createConnection(String userId, org.odpi.openmetadata.accessservices.assetowner.properties.ConnectionProperties connectionProperties)
    Create a new metadata element to represent a connection.
    String
    createConnectionFromTemplate(String userId, String templateGUID, org.odpi.openmetadata.accessservices.assetowner.properties.TemplateProperties templateProperties)
    Create a new metadata element to represent a connection using an existing metadata element as a template.
    String
    createEndpoint(String userId, org.odpi.openmetadata.accessservices.assetowner.properties.EndpointProperties endpointProperties)
    Create a new metadata element to represent an endpoint.
    String
    createEndpointFromTemplate(String userId, String templateGUID, org.odpi.openmetadata.accessservices.assetowner.properties.TemplateProperties templateProperties)
    Create a new metadata element to represent an endpoint using an existing metadata element as a template.
    void
    deleteAsset(String userId, String assetGUID)
    Deletes an asset and all of its associated elements such as schema, connections (unless they are linked to another asset), discovery reports and associated feedback.
    void
    deleteAssetSchemaType(String userId, String assetGUID)
    Detaches and deletes an asset's schema.
    String
    detachSchemaTypeFromAsset(String userId, String assetGUID)
    Unlinks the schema from the asset but does not delete it.
    List<org.odpi.openmetadata.accessservices.assetowner.metadataelements.AssetElement>
    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.accessservices.assetowner.metadataelements.ConnectionElement>
    findConnections(String userId, String searchString, int startFrom, int pageSize)
    Retrieve the list of connection metadata elements that contain the search string.
    List<org.odpi.openmetadata.accessservices.assetowner.metadataelements.ConnectorTypeElement>
    findConnectorTypes(String userId, String searchString, int startFrom, int pageSize)
    Retrieve the list of connectorType metadata elements that contain the search string.
    List<org.odpi.openmetadata.accessservices.assetowner.metadataelements.EndpointElement>
    findEndpoints(String userId, String searchString, int startFrom, int pageSize)
    Retrieve the list of endpoint metadata elements that contain the search string.
    org.odpi.openmetadata.frameworks.connectors.properties.AssetUniverse
    getAssetProperties(String userId, String assetGUID)
    Returns a comprehensive collection of properties about the requested asset.
    List<org.odpi.openmetadata.accessservices.assetowner.metadataelements.AssetElement>
    getAssetsByName(String userId, String name, int startFrom, int pageSize)
    Return a list of assets with the requested name.
    org.odpi.openmetadata.accessservices.assetowner.metadataelements.AssetElement
    getAssetSummary(String userId, String assetGUID)
    Return the basic attributes of an asset.
    org.odpi.openmetadata.accessservices.assetowner.metadataelements.ConnectionElement
    getConnectionByGUID(String userId, String connectionGUID)
    Retrieve the connection metadata element with the supplied unique identifier.
    List<org.odpi.openmetadata.accessservices.assetowner.metadataelements.ConnectionElement>
    getConnectionsByName(String userId, String name, int startFrom, int pageSize)
    Retrieve the list of connection metadata elements with a matching qualified or display name.
    org.odpi.openmetadata.frameworks.connectors.Connector
    getConnectorToAsset(String userId, String assetGUID)
    Return a connector for the asset to enable the calling user to access the content.
    org.odpi.openmetadata.accessservices.assetowner.metadataelements.ConnectorTypeElement
    getConnectorTypeByGUID(String userId, String connectorTypeGUID)
    Retrieve the connectorType metadata element with the supplied unique identifier.
    List<org.odpi.openmetadata.accessservices.assetowner.metadataelements.ConnectorTypeElement>
    getConnectorTypesByName(String userId, String name, int startFrom, int pageSize)
    Retrieve the list of connectorType metadata elements with a matching qualified or display name.
    List<org.odpi.openmetadata.frameworks.discovery.properties.DiscoveryAnalysisReport>
    getDiscoveryAnalysisReports(String userId, String assetGUID, int startingFrom, int maximumResults)
    Return the discovery analysis reports about the asset.
    List<org.odpi.openmetadata.frameworks.discovery.properties.Annotation>
    getDiscoveryReportAnnotations(String userId, String discoveryReportGUID, org.odpi.openmetadata.frameworks.discovery.properties.AnnotationStatus annotationStatus, int startingFrom, int maximumResults)
    Return the annotations linked directly to the report.
    org.odpi.openmetadata.accessservices.assetowner.metadataelements.EndpointElement
    getEndpointByGUID(String userId, String endpointGUID)
    Retrieve the endpoint metadata element with the supplied unique identifier.
    List<org.odpi.openmetadata.accessservices.assetowner.metadataelements.EndpointElement>
    getEndpointsByName(String userId, String name, int startFrom, int pageSize)
    Retrieve the list of endpoint metadata elements with a matching qualified or display name.
    List<org.odpi.openmetadata.frameworks.discovery.properties.Annotation>
    getExtendedAnnotations(String userId, String annotationGUID, org.odpi.openmetadata.frameworks.discovery.properties.AnnotationStatus annotationStatus, int startingFrom, int maximumResults)
    Return any annotations attached to this annotation.
    List<String>
    getTypesOfAnnotation(String userId)
    Return the annotation subtype names.
    Map<String,String>
    getTypesOfAnnotationWithDescriptions(String userId)
    Return the annotation subtype names mapped to their descriptions.
    List<String>
    getTypesOfAsset(String userId)
    Return the asset subtype names.
    Map<String,String>
    getTypesOfAssetWithDescriptions(String userId)
    Return the asset subtype names.
    void
    publishAsset(String userId, String assetGUID)
    Update the zones for a specific asset to the zone list specified in the publishZones.
    void
    removeAssetOrigin(String userId, String assetGUID)
    Remove the asset origin classification to an asset.
    void
    removeConnection(String userId, String connectionGUID)
    Remove the metadata element representing a connection.
    void
    removeEndpoint(String userId, String endpointGUID)
    Remove the metadata element representing a endpoint.
    void
    removeSecurityTags(String userId, String assetGUID, String assetElementGUID)
    Remove the security tags classification to an asset or one of its elements.
    void
    removeSemanticAssignment(String userId, String assetGUID, String glossaryTermGUID, String assetElementGUID)
    Remove the relationship between a glossary term and an element in an Asset description (typically a field in the schema).
    void
    removeTemplateClassification(String userId, String assetGUID)
    Remove the classification that indicates that this asset can be used as a template.
    List<org.odpi.openmetadata.accessservices.assetowner.metadataelements.ConnectionElement>
    scanConnections(String userId, int startFrom, int pageSize)
    Step through the connections visible to this caller.
    void
    setupAssetConnection(String userId, String assetGUID, String assetSummary, String connectionGUID)
    Create a relationship between an asset and its connection.
    void
    setupConnectorType(String userId, String connectionGUID, String connectorTypeGUID)
    Create a relationship between a connection and a connector type.
    void
    setupEmbeddedConnection(String userId, String connectionGUID, int position, String displayName, Map<String,Object> arguments, String embeddedConnectionGUID)
    Create a relationship between a virtual connection and an embedded connection.
    void
    setupEndpoint(String userId, String connectionGUID, String endpointGUID)
    Create a relationship between a connection and an endpoint.
    void
    updateAsset(String userId, String assetGUID, boolean isMergeUpdate, org.odpi.openmetadata.accessservices.assetowner.properties.AssetProperties assetProperties)
    Update the metadata element representing an asset.
    void
    updateAssetOwner(String userId, String assetGUID, String ownerId, String ownerTypeName, String ownerPropertyName)
    Update the owner information for a specific asset.
    void
    updateAssetOwner(String userId, String assetGUID, String ownerId, org.odpi.openmetadata.frameworks.connectors.properties.beans.OwnerType ownerType)
    Deprecated.
    void
    updateAssetZones(String userId, String assetGUID, List<String> assetZones)
    Update the zones for a specific asset.
    void
    updateConnection(String userId, String connectionGUID, boolean isMergeUpdate, org.odpi.openmetadata.accessservices.assetowner.properties.ConnectionProperties connectionProperties)
    Update the metadata element representing a connection.
    void
    updateEndpoint(String userId, boolean isMergeUpdate, String endpointGUID, org.odpi.openmetadata.accessservices.assetowner.properties.EndpointProperties endpointProperties)
    Update the metadata element representing a endpoint.
    void
    withdrawAsset(String userId, String assetGUID)
    Update the zones for a specific asset to the zone list specified in the defaultZones.

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

    getAnchorAssetFromGUID, getAssetProperties, getConnectorByConnection, getConnectorByGUID, getConnectorByName, getConnectorForAsset

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • AssetOwner

      public AssetOwner(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 - there is a problem creating the client-side components to issue any REST API calls.

    • AssetOwner

      public AssetOwner(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 - there is a problem creating the client-side components to issue any REST API calls.

    • AssetOwner

      public AssetOwner(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 - there is a problem creating the client-side components to issue any REST API calls.

    • AssetOwner

      public AssetOwner(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 - there is a problem creating the client-side components to issue any REST API calls.

    • AssetOwner

      public AssetOwner(String serverName, String serverPlatformURLRoot, AssetOwnerRESTClient 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

    • getAssetProperties

      public org.odpi.openmetadata.frameworks.connectors.properties.AssetUniverse getAssetProperties(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
      Returns a comprehensive collection of properties about the requested asset.
      Specified by:
      getAssetProperties in interface org.odpi.openmetadata.accessservices.assetowner.api.AssetReviewInterface
      Parameters:
      userId - userId of user making request.
      assetGUID - unique identifier for asset.
      Returns:
      a comprehensive collection of properties about the 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 the asset properties from the property servers).
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • getTypesOfAsset

      public List<String> getTypesOfAsset(String userId) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Return the asset subtype names.
      Specified by:
      getTypesOfAsset in interface org.odpi.openmetadata.accessservices.assetowner.api.AssetKnowledgeInterface
      Parameters:
      userId - calling user
      Returns:
      list of type names that are subtypes of asset
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - userId is null
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

    • getTypesOfAssetWithDescriptions

      public Map<String,String> getTypesOfAssetWithDescriptions(String userId) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Return the asset subtype names.
      Specified by:
      getTypesOfAssetWithDescriptions in interface org.odpi.openmetadata.accessservices.assetowner.api.AssetKnowledgeInterface
      Parameters:
      userId - calling user
      Returns:
      list of type names that are subtypes of asset
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - full path or userId is null
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

    • addAssetToCatalog

      public String addAssetToCatalog(String userId, String typeName, String qualifiedName, String name, String description, Map<String,String> additionalProperties, Map<String,Object> extendedProperties) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Add a simple asset description to the catalog.
      Specified by:
      addAssetToCatalog in interface org.odpi.openmetadata.accessservices.assetowner.api.AssetOnboardingInterface
      Parameters:
      userId - calling user (assumed to be the owner)
      typeName - specific type of the asset - this must match a defined subtype
      qualifiedName - unique name for the asset in the catalog
      name - resource name for the asset in the catalog
      description - resource description for the asset in the catalog
      Returns:
      unique identifier (guid) of the asset
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - full path or userId is null
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

    • addAssetToCatalog

      public String addAssetToCatalog(String userId, org.odpi.openmetadata.accessservices.assetowner.properties.AssetProperties assetProperties) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Add a comprehensive asset description to the catalog.
      Specified by:
      addAssetToCatalog in interface org.odpi.openmetadata.accessservices.assetowner.api.AssetOnboardingInterface
      Parameters:
      userId - calling user
      assetProperties - properties for the asset
      Returns:
      unique identifier (guid) of the asset
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - full path or userId is null
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

    • addAssetToCatalogUsingTemplate

      public String addAssetToCatalogUsingTemplate(String userId, String templateGUID, org.odpi.openmetadata.accessservices.assetowner.properties.TemplateProperties templateProperties) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Create a new metadata element to represent an asset using an existing asset as a template.
      Specified by:
      addAssetToCatalogUsingTemplate in interface org.odpi.openmetadata.accessservices.assetowner.api.AssetOnboardingInterface
      Parameters:
      userId - calling user
      templateGUID - unique identifier of the metadata element to copy
      templateProperties - properties that override the template
      Returns:
      unique identifier of the new metadata element
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • updateAsset

      public void updateAsset(String userId, String assetGUID, boolean isMergeUpdate, org.odpi.openmetadata.accessservices.assetowner.properties.AssetProperties assetProperties) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Update the metadata element representing an asset.
      Specified by:
      updateAsset in interface org.odpi.openmetadata.accessservices.assetowner.api.AssetOnboardingInterface
      Parameters:
      userId - calling user
      assetGUID - unique identifier of the metadata element to update
      isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
      assetProperties - new properties for this element
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • addCombinedSchemaToAsset

      public String addCombinedSchemaToAsset(String userId, String assetGUID, org.odpi.openmetadata.accessservices.assetowner.properties.SchemaTypeProperties schemaType, List<org.odpi.openmetadata.accessservices.assetowner.properties.SchemaAttributeProperties> schemaAttributes) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Stores the supplied schema details in the catalog and attaches it to the asset. If another schema is currently attached to the asset, it is unlinked and deleted. If more attributes need to be added in addition to the ones supplied then this can be done with addSchemaAttributesToSchemaType().
      Specified by:
      addCombinedSchemaToAsset in interface org.odpi.openmetadata.accessservices.assetowner.api.AssetOnboardingInterface
      Parameters:
      userId - calling user
      assetGUID - unique identifier of the asset that the schema is to be attached to
      schemaType - schema type to create and attach directly to the asset.
      schemaAttributes - optional schema attributes.
      Returns:
      guid of the schema type or
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - full path or userId is null
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

    • addSchemaTypeToAsset

      public String addSchemaTypeToAsset(String userId, String assetGUID, org.odpi.openmetadata.accessservices.assetowner.properties.SchemaTypeProperties schemaType) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Stores the supplied schema type in the catalog and attaches it to the asset. If another schema is currently attached to the asset, it is unlinked and deleted.
      Specified by:
      addSchemaTypeToAsset in interface org.odpi.openmetadata.accessservices.assetowner.api.AssetOnboardingInterface
      Parameters:
      userId - calling user
      assetGUID - unique identifier of the asset that the schema is to be attached to
      schemaType - schema type to create and attach directly to the asset.
      Returns:
      guid of the new schema type or
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - full path or userId is null
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

    • attachSchemaTypeToAsset

      public void attachSchemaTypeToAsset(String userId, String assetGUID, String schemaTypeGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Links the supplied schema type directly to the asset. If this schema is either not found, or already attached to an asset, then an error occurs. If another schema is currently attached to the asset, it is unlinked and deleted.
      Specified by:
      attachSchemaTypeToAsset in interface org.odpi.openmetadata.accessservices.assetowner.api.AssetOnboardingInterface
      Parameters:
      userId - calling user
      assetGUID - unique identifier of the asset that the schema is to be attached to
      schemaTypeGUID - unique identifier of the schema type to attach
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - full path or userId is null
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

    • detachSchemaTypeFromAsset

      public String detachSchemaTypeFromAsset(String userId, String assetGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Unlinks the schema from the asset but does not delete it. This means it can be reattached to a different asset.
      Specified by:
      detachSchemaTypeFromAsset in interface org.odpi.openmetadata.accessservices.assetowner.api.AssetOnboardingInterface
      Parameters:
      userId - calling user
      assetGUID - unique identifier of the asset that the schema is to be attached to
      Returns:
      guid of detached schema type
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - full path or userId is null
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

    • deleteAssetSchemaType

      public void deleteAssetSchemaType(String userId, String assetGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Detaches and deletes an asset's schema.
      Specified by:
      deleteAssetSchemaType in interface org.odpi.openmetadata.accessservices.assetowner.api.AssetOnboardingInterface
      Parameters:
      userId - calling user
      assetGUID - unique identifier of the asset that the schema is to be attached to
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - full path or userId is null
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

    • addSchemaAttributes

      public void addSchemaAttributes(String serverName, String userId, String assetGUID, String parentGUID, List<org.odpi.openmetadata.accessservices.assetowner.properties.SchemaAttributeProperties> schemaAttributes) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Adds attributes to a complex schema type like a relational table, avro schema or a structured document. This method can be called repeatedly to add many attributes to a schema.
      Specified by:
      addSchemaAttributes in interface org.odpi.openmetadata.accessservices.assetowner.api.AssetOnboardingInterface
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      assetGUID - unique identifier of the asset that the schema is to be attached to
      parentGUID - unique identifier of the schema element to anchor these attributes to.
      schemaAttributes - list of schema attribute objects.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - full path or userId is null
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

    • addSchemaAttribute

      public String addSchemaAttribute(String serverName, String userId, String assetGUID, String parentGUID, org.odpi.openmetadata.accessservices.assetowner.properties.SchemaAttributeProperties schemaAttribute) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Adds a schema attribute to a complex schema type like a relational table, avro schema or a structured document. This method can be called repeatedly to add many attributes to a schema. The GUID returned can be used to add nested attributes.
      Specified by:
      addSchemaAttribute in interface org.odpi.openmetadata.accessservices.assetowner.api.AssetOnboardingInterface
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      assetGUID - unique identifier of the asset that the schema is to be attached to
      parentGUID - unique identifier of the schema element to anchor these attributes to.
      schemaAttribute - schema attribute object to add.
      Returns:
      unique identifier for the new schema attribute or
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - full path or userId is null
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

    • addConnectionToAsset

      @Deprecated public void addConnectionToAsset(String userId, String assetGUID, String assetSummary, org.odpi.openmetadata.frameworks.connectors.properties.beans.Connection connection) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Deprecated.
      Adds a connection to an asset. Assets can have multiple connections attached.
      Specified by:
      addConnectionToAsset in interface org.odpi.openmetadata.accessservices.assetowner.api.AssetOnboardingInterface
      Parameters:
      userId - calling user
      assetGUID - unique identifier of the asset to attach the connection to
      assetSummary - summary of the asset that is stored in the relationship between the asset and the connection.
      connection - connection object. If the connection is already stored (matching guid) then the existing connection is used.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - full path or userId is null
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

    • addSemanticAssignment

      public void addSemanticAssignment(String userId, String assetGUID, String glossaryTermGUID, String assetElementGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Create a simple relationship between a glossary term and an element in an Asset description (typically a field in the schema).
      Specified by:
      addSemanticAssignment in interface org.odpi.openmetadata.accessservices.assetowner.api.AssetClassificationInterface
      Parameters:
      userId - calling user
      assetGUID - unique identifier of asset
      glossaryTermGUID - unique identifier of the glossary term
      assetElementGUID - element to link it to - its type must inherit from Referenceable. If null then the assetGUID is used.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

    • removeSemanticAssignment

      public void removeSemanticAssignment(String userId, String assetGUID, String glossaryTermGUID, String assetElementGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Remove the relationship between a glossary term and an element in an Asset description (typically a field in the schema).
      Specified by:
      removeSemanticAssignment in interface org.odpi.openmetadata.accessservices.assetowner.api.AssetClassificationInterface
      Parameters:
      userId - calling user
      assetGUID - unique identifier of asset
      glossaryTermGUID - unique identifier of the glossary term
      assetElementGUID - element to link it to - its type must inherit from Referenceable. If null then the assetGUID is used.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

    • addAssetOrigin

      public void addAssetOrigin(String userId, String assetGUID, String organizationGUID, String businessCapabilityGUID, Map<String,String> otherOriginValues) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Add the asset origin classification to an asset.
      Specified by:
      addAssetOrigin in interface org.odpi.openmetadata.accessservices.assetowner.api.AssetClassificationInterface
      Parameters:
      userId - calling user
      assetGUID - unique identifier of asset
      organizationGUID - Unique identifier (GUID) of the organization where this asset originated from - or null
      businessCapabilityGUID - Unique identifier (GUID) of the business capability where this asset originated from.
      otherOriginValues - Descriptive labels describing origin of the asset
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - entity not known, null userId or guid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

    • removeAssetOrigin

      public void removeAssetOrigin(String userId, String assetGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Remove the asset origin classification to an asset.
      Specified by:
      removeAssetOrigin in interface org.odpi.openmetadata.accessservices.assetowner.api.AssetClassificationInterface
      Parameters:
      userId - calling user
      assetGUID - unique identifier of asset
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - entity not known, null userId or guid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

    • publishAsset

      public void publishAsset(String userId, String assetGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Update the zones for a specific asset to the zone list specified in the publishZones.
      Specified by:
      publishAsset in interface org.odpi.openmetadata.accessservices.assetowner.api.AssetClassificationInterface
      Parameters:
      userId - calling user
      assetGUID - unique identifier for the asset to update
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - entity not known, null userId or guid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

    • withdrawAsset

      public void withdrawAsset(String userId, String assetGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Update the zones for a specific asset to the zone list specified in the defaultZones.
      Specified by:
      withdrawAsset in interface org.odpi.openmetadata.accessservices.assetowner.api.AssetClassificationInterface
      Parameters:
      userId - calling user
      assetGUID - unique identifier for the asset to update
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - entity not known, null userId or guid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

    • updateAssetZones

      public void updateAssetZones(String userId, String assetGUID, List<String> assetZones) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Update the zones for a specific asset.
      Specified by:
      updateAssetZones in interface org.odpi.openmetadata.accessservices.assetowner.api.AssetClassificationInterface
      Parameters:
      userId - calling user
      assetGUID - unique identifier for the asset to update
      assetZones - list of zones for the asset - these values override the current values - null means belongs to no zones.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - guid or userId is null
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

    • updateAssetOwner

      @Deprecated public void updateAssetOwner(String userId, String assetGUID, String ownerId, org.odpi.openmetadata.frameworks.connectors.properties.beans.OwnerType ownerType) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Deprecated.
      Update the owner information for a specific asset.
      Specified by:
      updateAssetOwner in interface org.odpi.openmetadata.accessservices.assetowner.api.AssetClassificationInterface
      Parameters:
      userId - calling user
      assetGUID - unique identifier for the asset to update
      ownerId - userId or profileGUID of the owner - or null to clear the field
      ownerType - indicator of the type of identifier provided above - or null to clear the field
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - userId is null
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

    • updateAssetOwner

      public void updateAssetOwner(String userId, String assetGUID, String ownerId, String ownerTypeName, String ownerPropertyName) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Update the owner information for a specific asset.
      Specified by:
      updateAssetOwner in interface org.odpi.openmetadata.accessservices.assetowner.api.AssetClassificationInterface
      Parameters:
      userId - calling user
      assetGUID - unique identifier for the asset to update
      ownerId - unique identifier/property of the owner - or null to clear the field
      ownerTypeName - name of the type of identifier provided above - or null to clear the field
      ownerPropertyName - name of the property that describes the ownerId
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - userId is null
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

    • addSecurityTags

      public void addSecurityTags(String userId, String assetGUID, String assetElementGUID, List<String> securityLabels, Map<String,Object> securityProperties, Map<String,List<String>> accessGroups) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Add or replace the security tags for an asset or one of its elements.
      Specified by:
      addSecurityTags in interface org.odpi.openmetadata.accessservices.assetowner.api.AssetClassificationInterface
      Parameters:
      userId - calling user
      assetGUID - unique identifier of asset
      assetElementGUID - element to link it to - its type must inherit from Referenceable. If null then the assetGUID is used.
      securityLabels - list of security labels defining the security characteristics of the element
      securityProperties - Descriptive labels describing origin of the asset
      accessGroups - map from operation to list of security groups
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - entity not known, null userId or guid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

    • removeSecurityTags

      public void removeSecurityTags(String userId, String assetGUID, String assetElementGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Remove the security tags classification to an asset or one of its elements.
      Specified by:
      removeSecurityTags in interface org.odpi.openmetadata.accessservices.assetowner.api.AssetClassificationInterface
      Parameters:
      userId - calling user
      assetGUID - unique identifier of asset
      assetElementGUID - element where the security tags need to be removed. If null then the assetGUID is used.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - entity not known, null userId or guid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

    • addTemplateClassification

      public void addTemplateClassification(String userId, String assetGUID, String name, String description, Map<String,String> additionalProperties) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Classify an asset as suitable to be used as a template for cataloguing assets of a similar types.
      Specified by:
      addTemplateClassification in interface org.odpi.openmetadata.accessservices.assetowner.api.AssetClassificationInterface
      Parameters:
      userId - calling user
      assetGUID - unique identifier of the asset to classify
      name - name of the template
      description - description of when, where and how to use the template
      additionalProperties - any additional properties
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - asset or element not known, null userId or guid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

    • removeTemplateClassification

      public void removeTemplateClassification(String userId, String assetGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Remove the classification that indicates that this asset can be used as a template.
      Specified by:
      removeTemplateClassification in interface org.odpi.openmetadata.accessservices.assetowner.api.AssetClassificationInterface
      Parameters:
      userId - calling user
      assetGUID - unique identifier of the asset to declassify
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - asset or element not known, null userId or guid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

    • createConnection

      public String createConnection(String userId, org.odpi.openmetadata.accessservices.assetowner.properties.ConnectionProperties connectionProperties) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Create a new metadata element to represent a connection. Classifications can be added later to define the type of connection.
      Specified by:
      createConnection in interface org.odpi.openmetadata.accessservices.assetowner.api.AssetConnectionManagementInterface
      Parameters:
      userId - calling user
      connectionProperties - properties to store
      Returns:
      unique identifier of the new metadata element
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • createConnectionFromTemplate

      public String createConnectionFromTemplate(String userId, String templateGUID, org.odpi.openmetadata.accessservices.assetowner.properties.TemplateProperties templateProperties) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Create a new metadata element to represent a connection using an existing metadata element as a template. The template defines additional classifications and relationships that should be added to the new connection.
      Specified by:
      createConnectionFromTemplate in interface org.odpi.openmetadata.accessservices.assetowner.api.AssetConnectionManagementInterface
      Parameters:
      userId - calling user
      templateGUID - unique identifier of the metadata element to copy
      templateProperties - properties that override the template
      Returns:
      unique identifier of the new metadata element
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • updateConnection

      public void updateConnection(String userId, String connectionGUID, boolean isMergeUpdate, org.odpi.openmetadata.accessservices.assetowner.properties.ConnectionProperties connectionProperties) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Update the metadata element representing a connection.
      Specified by:
      updateConnection in interface org.odpi.openmetadata.accessservices.assetowner.api.AssetConnectionManagementInterface
      Parameters:
      userId - calling user
      connectionGUID - unique identifier of the metadata element to update
      isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
      connectionProperties - new properties for this element
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • setupConnectorType

      public void setupConnectorType(String userId, String connectionGUID, String connectorTypeGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Create a relationship between a connection and a connector type.
      Specified by:
      setupConnectorType in interface org.odpi.openmetadata.accessservices.assetowner.api.AssetConnectionManagementInterface
      Parameters:
      userId - calling user
      connectionGUID - unique identifier of the connection in the external asset manager
      connectorTypeGUID - unique identifier of the connector type in the external asset manager
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • clearConnectorType

      public void clearConnectorType(String userId, String connectionGUID, String connectorTypeGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Remove a relationship between a connection and a connector type.
      Specified by:
      clearConnectorType in interface org.odpi.openmetadata.accessservices.assetowner.api.AssetConnectionManagementInterface
      Parameters:
      userId - calling user
      connectionGUID - unique identifier of the connection in the external asset manager
      connectorTypeGUID - unique identifier of the connector type in the external asset manager
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • setupEndpoint

      public void setupEndpoint(String userId, String connectionGUID, String endpointGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Create a relationship between a connection and an endpoint.
      Specified by:
      setupEndpoint in interface org.odpi.openmetadata.accessservices.assetowner.api.AssetConnectionManagementInterface
      Parameters:
      userId - calling user
      connectionGUID - unique identifier of the connection in the external asset manager
      endpointGUID - unique identifier of the endpoint in the external asset manager
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • clearEndpoint

      public void clearEndpoint(String userId, String connectionGUID, String endpointGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Remove a relationship between a connection and an endpoint.
      Specified by:
      clearEndpoint in interface org.odpi.openmetadata.accessservices.assetowner.api.AssetConnectionManagementInterface
      Parameters:
      userId - calling user
      connectionGUID - unique identifier of the connection in the external asset manager
      endpointGUID - unique identifier of the endpoint in the external asset manager
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • setupEmbeddedConnection

      public void setupEmbeddedConnection(String userId, String connectionGUID, int position, String displayName, Map<String,Object> arguments, String embeddedConnectionGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Create a relationship between a virtual connection and an embedded connection.
      Specified by:
      setupEmbeddedConnection in interface org.odpi.openmetadata.accessservices.assetowner.api.AssetConnectionManagementInterface
      Parameters:
      userId - calling user
      connectionGUID - unique identifier of the virtual connection in the external asset manager
      position - which order should this connection be processed
      arguments - What additional properties should be passed to the embedded connector via the configuration properties
      displayName - what does this connector signify?
      embeddedConnectionGUID - unique identifier of the embedded connection in the external asset manager
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • clearEmbeddedConnection

      public void clearEmbeddedConnection(String userId, String connectionGUID, String embeddedConnectionGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Remove a relationship between a virtual connection and an embedded connection.
      Specified by:
      clearEmbeddedConnection in interface org.odpi.openmetadata.accessservices.assetowner.api.AssetConnectionManagementInterface
      Parameters:
      userId - calling user
      connectionGUID - unique identifier of the virtual connection in the external asset manager
      embeddedConnectionGUID - unique identifier of the embedded connection in the external asset manager
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • setupAssetConnection

      public void setupAssetConnection(String userId, String assetGUID, String assetSummary, String connectionGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Create a relationship between an asset and its connection.
      Specified by:
      setupAssetConnection in interface org.odpi.openmetadata.accessservices.assetowner.api.AssetConnectionManagementInterface
      Parameters:
      userId - calling user
      assetGUID - unique identifier of the asset
      assetSummary - summary of the asset that is stored in the relationship between the asset and the connection.
      connectionGUID - unique identifier of the connection
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • clearAssetConnection

      public void clearAssetConnection(String userId, String assetGUID, String connectionGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Remove a relationship between an asset and its connection.
      Specified by:
      clearAssetConnection in interface org.odpi.openmetadata.accessservices.assetowner.api.AssetConnectionManagementInterface
      Parameters:
      userId - calling user
      assetGUID - unique identifier of the asset
      connectionGUID - unique identifier of the connection
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • removeConnection

      public void removeConnection(String userId, String connectionGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Remove the metadata element representing a connection.
      Specified by:
      removeConnection in interface org.odpi.openmetadata.accessservices.assetowner.api.AssetConnectionManagementInterface
      Parameters:
      userId - calling user
      connectionGUID - unique identifier of the metadata element to remove
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • findConnections

      public List<org.odpi.openmetadata.accessservices.assetowner.metadataelements.ConnectionElement> findConnections(String userId, String searchString, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the list of connection metadata elements that contain the search string. The search string is treated as a regular expression.
      Specified by:
      findConnections in interface org.odpi.openmetadata.accessservices.assetowner.api.AssetConnectionManagementInterface
      Parameters:
      userId - calling user
      searchString - string to find in the properties
      startFrom - paging start point
      pageSize - maximum results that can be returned
      Returns:
      list of matching metadata elements
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • scanConnections

      public List<org.odpi.openmetadata.accessservices.assetowner.metadataelements.ConnectionElement> scanConnections(String userId, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Step through the connections visible to this caller.
      Specified by:
      scanConnections in interface org.odpi.openmetadata.accessservices.assetowner.api.AssetConnectionManagementInterface
      Parameters:
      userId - calling user
      startFrom - paging start point
      pageSize - maximum results that can be returned
      Returns:
      list of metadata elements
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getConnectionsByName

      public List<org.odpi.openmetadata.accessservices.assetowner.metadataelements.ConnectionElement> getConnectionsByName(String userId, String name, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the list of connection metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
      Specified by:
      getConnectionsByName in interface org.odpi.openmetadata.accessservices.assetowner.api.AssetConnectionManagementInterface
      Parameters:
      userId - calling user
      name - name to search for
      startFrom - paging start point
      pageSize - maximum results that can be returned
      Returns:
      list of matching metadata elements
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getConnectionByGUID

      public org.odpi.openmetadata.accessservices.assetowner.metadataelements.ConnectionElement getConnectionByGUID(String userId, String connectionGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the connection metadata element with the supplied unique identifier.
      Specified by:
      getConnectionByGUID in interface org.odpi.openmetadata.accessservices.assetowner.api.AssetConnectionManagementInterface
      Parameters:
      userId - calling user
      connectionGUID - unique identifier of the requested metadata element
      Returns:
      matching metadata element
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • createEndpoint

      public String createEndpoint(String userId, org.odpi.openmetadata.accessservices.assetowner.properties.EndpointProperties endpointProperties) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Create a new metadata element to represent an endpoint. Classifications can be added later to define the type of endpoint.
      Specified by:
      createEndpoint in interface org.odpi.openmetadata.accessservices.assetowner.api.AssetConnectionManagementInterface
      Parameters:
      userId - calling user
      endpointProperties - properties to store
      Returns:
      unique identifier of the new metadata element
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • createEndpointFromTemplate

      public String createEndpointFromTemplate(String userId, String templateGUID, org.odpi.openmetadata.accessservices.assetowner.properties.TemplateProperties templateProperties) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Create a new metadata element to represent an endpoint using an existing metadata element as a template. The template defines additional classifications and relationships that should be added to the new endpoint.
      Specified by:
      createEndpointFromTemplate in interface org.odpi.openmetadata.accessservices.assetowner.api.AssetConnectionManagementInterface
      Parameters:
      userId - calling user
      templateGUID - unique identifier of the metadata element to copy
      templateProperties - properties that override the template
      Returns:
      unique identifier of the new metadata element
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • updateEndpoint

      public void updateEndpoint(String userId, boolean isMergeUpdate, String endpointGUID, org.odpi.openmetadata.accessservices.assetowner.properties.EndpointProperties endpointProperties) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Update the metadata element representing a endpoint.
      Specified by:
      updateEndpoint in interface org.odpi.openmetadata.accessservices.assetowner.api.AssetConnectionManagementInterface
      Parameters:
      userId - calling user
      isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
      endpointGUID - unique identifier of the metadata element to update
      endpointProperties - new properties for this element
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • removeEndpoint

      public void removeEndpoint(String userId, String endpointGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Remove the metadata element representing a endpoint.
      Specified by:
      removeEndpoint in interface org.odpi.openmetadata.accessservices.assetowner.api.AssetConnectionManagementInterface
      Parameters:
      userId - calling user
      endpointGUID - unique identifier of the metadata element to remove
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • findEndpoints

      public List<org.odpi.openmetadata.accessservices.assetowner.metadataelements.EndpointElement> findEndpoints(String userId, String searchString, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the list of endpoint metadata elements that contain the search string. The search string is treated as a regular expression.
      Specified by:
      findEndpoints in interface org.odpi.openmetadata.accessservices.assetowner.api.AssetConnectionManagementInterface
      Parameters:
      userId - calling user
      searchString - string to find in the properties
      startFrom - paging start point
      pageSize - maximum results that can be returned
      Returns:
      list of matching metadata elements
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getEndpointsByName

      public List<org.odpi.openmetadata.accessservices.assetowner.metadataelements.EndpointElement> getEndpointsByName(String userId, String name, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the list of endpoint metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
      Specified by:
      getEndpointsByName in interface org.odpi.openmetadata.accessservices.assetowner.api.AssetConnectionManagementInterface
      Parameters:
      userId - calling user
      name - name to search for
      startFrom - paging start point
      pageSize - maximum results that can be returned
      Returns:
      list of matching metadata elements
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getEndpointByGUID

      public org.odpi.openmetadata.accessservices.assetowner.metadataelements.EndpointElement getEndpointByGUID(String userId, String endpointGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the endpoint metadata element with the supplied unique identifier.
      Specified by:
      getEndpointByGUID in interface org.odpi.openmetadata.accessservices.assetowner.api.AssetConnectionManagementInterface
      Parameters:
      userId - calling user
      endpointGUID - unique identifier of the requested metadata element
      Returns:
      matching metadata element
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • findConnectorTypes

      public List<org.odpi.openmetadata.accessservices.assetowner.metadataelements.ConnectorTypeElement> findConnectorTypes(String userId, String searchString, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the list of connectorType metadata elements that contain the search string. The search string is treated as a regular expression.
      Specified by:
      findConnectorTypes in interface org.odpi.openmetadata.accessservices.assetowner.api.AssetConnectionManagementInterface
      Parameters:
      userId - calling user
      searchString - string to find in the properties
      startFrom - paging start point
      pageSize - maximum results that can be returned
      Returns:
      list of matching metadata elements
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getConnectorTypesByName

      public List<org.odpi.openmetadata.accessservices.assetowner.metadataelements.ConnectorTypeElement> getConnectorTypesByName(String userId, String name, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the list of connectorType metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
      Specified by:
      getConnectorTypesByName in interface org.odpi.openmetadata.accessservices.assetowner.api.AssetConnectionManagementInterface
      Parameters:
      userId - calling user
      name - name to search for
      startFrom - paging start point
      pageSize - maximum results that can be returned
      Returns:
      list of matching metadata elements
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getConnectorTypeByGUID

      public org.odpi.openmetadata.accessservices.assetowner.metadataelements.ConnectorTypeElement getConnectorTypeByGUID(String userId, String connectorTypeGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the connectorType metadata element with the supplied unique identifier.
      Specified by:
      getConnectorTypeByGUID in interface org.odpi.openmetadata.accessservices.assetowner.api.AssetConnectionManagementInterface
      Parameters:
      userId - calling user
      connectorTypeGUID - unique identifier of the requested metadata element
      Returns:
      matching metadata element
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getAssetsByName

      public List<org.odpi.openmetadata.accessservices.assetowner.metadataelements.AssetElement> 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.assetowner.api.AssetReviewInterface
      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

    • findAssets

      public List<org.odpi.openmetadata.accessservices.assetowner.metadataelements.AssetElement> 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.
      Specified by:
      findAssets in interface org.odpi.openmetadata.accessservices.assetowner.api.AssetReviewInterface
      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

    • getAssetSummary

      public org.odpi.openmetadata.accessservices.assetowner.metadataelements.AssetElement getAssetSummary(String userId, String assetGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Return the basic attributes of an asset.
      Specified by:
      getAssetSummary in interface org.odpi.openmetadata.accessservices.assetowner.api.AssetReviewInterface
      Parameters:
      userId - calling user
      assetGUID - unique identifier of the asset
      Returns:
      basic asset properties
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there was a problem that occurred within the property server.

    • getConnectorToAsset

      public org.odpi.openmetadata.frameworks.connectors.Connector getConnectorToAsset(String userId, String assetGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Return a connector for the asset to enable the calling user to access the content.
      Specified by:
      getConnectorToAsset in interface org.odpi.openmetadata.accessservices.assetowner.api.AssetReviewInterface
      Parameters:
      userId - calling user
      assetGUID - unique identifier of the asset
      Returns:
      connector object
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there was a problem that occurred within the property server.

    • getDiscoveryAnalysisReports

      public List<org.odpi.openmetadata.frameworks.discovery.properties.DiscoveryAnalysisReport> getDiscoveryAnalysisReports(String userId, String assetGUID, int startingFrom, int maximumResults) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Return the discovery analysis reports about the asset.
      Specified by:
      getDiscoveryAnalysisReports in interface org.odpi.openmetadata.accessservices.assetowner.api.AssetReviewInterface
      Parameters:
      userId - calling user
      assetGUID - unique identifier of the asset
      startingFrom - position in the list (used when there are so many reports that paging is needed
      maximumResults - maximum number of elements to return on this call
      Returns:
      list of discovery analysis reports
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there was a problem that occurred within the property server.

    • getTypesOfAnnotation

      public List<String> getTypesOfAnnotation(String userId) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Return the annotation subtype names.
      Specified by:
      getTypesOfAnnotation in interface org.odpi.openmetadata.accessservices.assetowner.api.AssetReviewInterface
      Parameters:
      userId - calling user
      Returns:
      list of type names that are subtypes of annotation
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - full path or userId is null
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

    • getTypesOfAnnotationWithDescriptions

      public Map<String,String> getTypesOfAnnotationWithDescriptions(String userId) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Return the annotation subtype names mapped to their descriptions.
      Specified by:
      getTypesOfAnnotationWithDescriptions in interface org.odpi.openmetadata.accessservices.assetowner.api.AssetReviewInterface
      Parameters:
      userId - calling user
      Returns:
      map of type names that are subtypes of annotation to their descriptions
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - full path or userId is null
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

    • getDiscoveryReportAnnotations

      public List<org.odpi.openmetadata.frameworks.discovery.properties.Annotation> getDiscoveryReportAnnotations(String userId, String discoveryReportGUID, org.odpi.openmetadata.frameworks.discovery.properties.AnnotationStatus annotationStatus, int startingFrom, int maximumResults) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Return the annotations linked directly to the report.
      Specified by:
      getDiscoveryReportAnnotations in interface org.odpi.openmetadata.accessservices.assetowner.api.AssetReviewInterface
      Parameters:
      userId - identifier of calling user
      discoveryReportGUID - identifier of the discovery request.
      annotationStatus - status of the desired annotations - null means all statuses.
      startingFrom - initial position in the stored list.
      maximumResults - maximum number of definitions to return on this call.
      Returns:
      list of annotations
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there was a problem that occurred within the property server.

    • getExtendedAnnotations

      public List<org.odpi.openmetadata.frameworks.discovery.properties.Annotation> getExtendedAnnotations(String userId, String annotationGUID, org.odpi.openmetadata.frameworks.discovery.properties.AnnotationStatus annotationStatus, int startingFrom, int maximumResults) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Return any annotations attached to this annotation.
      Specified by:
      getExtendedAnnotations in interface org.odpi.openmetadata.accessservices.assetowner.api.AssetReviewInterface
      Parameters:
      userId - identifier of calling user
      annotationGUID - anchor annotation
      annotationStatus - status of the desired annotations - null means all statuses.
      startingFrom - starting position in the list
      maximumResults - maximum number of annotations that can be returned.
      Returns:
      list of Annotation objects
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there was a problem that occurred within the property server.

    • deleteAsset

      public void deleteAsset(String userId, String assetGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Deletes an asset and all of its associated elements such as schema, connections (unless they are linked to another asset), discovery reports and associated feedback. Given the depth of the delete request performed by this call, it should be used with care.
      Specified by:
      deleteAsset in interface org.odpi.openmetadata.accessservices.assetowner.api.AssetDecommissioningInterface
      Parameters:
      userId - calling user
      assetGUID - unique identifier of the asset to remove
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - full path or userId is null
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem