Interface AssetOnboardingInterface

    • Method Summary

      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and Type Method Description
      java.lang.String addAssetToCatalog​(java.lang.String userId, java.lang.String typeName, java.lang.String qualifiedName, java.lang.String displayName, java.lang.String description, java.util.Map<java.lang.String,​java.lang.String> additionalProperties, java.util.Map<java.lang.String,​java.lang.Object> extendedProperties)
      Add a simple asset description to the catalog.
      java.lang.String addAssetToCatalog​(java.lang.String userId, AssetProperties assetProperties)
      Add a comprehensive asset description to the catalog.
      java.lang.String addAssetToCatalogUsingTemplate​(java.lang.String userId, java.lang.String templateGUID, TemplateProperties templateProperties)
      Create a new metadata element to represent an asset using an existing asset as a template.
      java.lang.String addCombinedSchemaToAsset​(java.lang.String userId, java.lang.String assetGUID, SchemaTypeProperties schemaType, java.util.List<SchemaAttributeProperties> schemaAttributes)
      Stores the supplied schema details in the catalog and attaches it to the asset.
      void addConnectionToAsset​(java.lang.String userId, java.lang.String assetGUID, java.lang.String assetSummary, Connection connection)
      Deprecated.
      java.lang.String addSchemaAttribute​(java.lang.String serverName, java.lang.String userId, java.lang.String assetGUID, java.lang.String parentGUID, SchemaAttributeProperties schemaAttribute)
      Adds an attribute to a complex schema type like a relational table, avro schema or a structured document.
      void addSchemaAttributes​(java.lang.String serverName, java.lang.String userId, java.lang.String assetGUID, java.lang.String parentGUID, java.util.List<SchemaAttributeProperties> schemaAttributes)
      Adds attributes to a complex schema type like a relational table, avro schema or a structured document.
      java.lang.String addSchemaTypeToAsset​(java.lang.String userId, java.lang.String assetGUID, SchemaTypeProperties schemaType)
      Stores the supplied schema type in the catalog and attaches it to the asset.
      void attachSchemaTypeToAsset​(java.lang.String userId, java.lang.String assetGUID, java.lang.String schemaTypeGUID)
      Links the supplied schema type directly to the asset.
      void deleteAssetSchemaType​(java.lang.String userId, java.lang.String assetGUID)
      Detaches and deletes an asset's schema.
      java.lang.String detachSchemaTypeFromAsset​(java.lang.String userId, java.lang.String assetGUID)
      Unlinks the schema from the asset but does not delete it.
    • Method Detail

      • addAssetToCatalog

        java.lang.String addAssetToCatalog​(java.lang.String userId,
                                           java.lang.String typeName,
                                           java.lang.String qualifiedName,
                                           java.lang.String displayName,
                                           java.lang.String description,
                                           java.util.Map<java.lang.String,​java.lang.String> additionalProperties,
                                           java.util.Map<java.lang.String,​java.lang.Object> extendedProperties)
                                    throws InvalidParameterException,
                                           UserNotAuthorizedException,
                                           PropertyServerException
        Add a simple asset description to the catalog.
        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
        displayName - display name for the asset in the catalog
        description - description of the asset in the catalog
        additionalProperties - additional properties added by the caller
        extendedProperties - properties from the subtypes
        Returns:
        unique identifier (guid) of the asset
        Throws:
        InvalidParameterException - full path or userId is null
        PropertyServerException - problem accessing property server
        UserNotAuthorizedException - security access problem
      • addCombinedSchemaToAsset

        java.lang.String addCombinedSchemaToAsset​(java.lang.String userId,
                                                  java.lang.String assetGUID,
                                                  SchemaTypeProperties schemaType,
                                                  java.util.List<SchemaAttributeProperties> schemaAttributes)
                                           throws InvalidParameterException,
                                                  UserNotAuthorizedException,
                                                  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().
        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:
        InvalidParameterException - full path or userId is null
        PropertyServerException - problem accessing property server
        UserNotAuthorizedException - security access problem
      • attachSchemaTypeToAsset

        void attachSchemaTypeToAsset​(java.lang.String userId,
                                     java.lang.String assetGUID,
                                     java.lang.String schemaTypeGUID)
                              throws InvalidParameterException,
                                     UserNotAuthorizedException,
                                     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.
        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:
        InvalidParameterException - full path or userId is null
        PropertyServerException - problem accessing property server
        UserNotAuthorizedException - security access problem
      • addSchemaAttributes

        void addSchemaAttributes​(java.lang.String serverName,
                                 java.lang.String userId,
                                 java.lang.String assetGUID,
                                 java.lang.String parentGUID,
                                 java.util.List<SchemaAttributeProperties> schemaAttributes)
                          throws InvalidParameterException,
                                 UserNotAuthorizedException,
                                 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.
        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:
        InvalidParameterException - full path or userId is null
        PropertyServerException - problem accessing property server
        UserNotAuthorizedException - security access problem
      • addSchemaAttribute

        java.lang.String addSchemaAttribute​(java.lang.String serverName,
                                            java.lang.String userId,
                                            java.lang.String assetGUID,
                                            java.lang.String parentGUID,
                                            SchemaAttributeProperties schemaAttribute)
                                     throws InvalidParameterException,
                                            UserNotAuthorizedException,
                                            PropertyServerException
        Adds an 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. Since the GUID is returned, it is possible to add nested schema attributes to another schema attribute.
        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 to the schema.
        Returns:
        list of unique identifiers for the new schema attributes returned in the same order as the supplied attribute or
        Throws:
        InvalidParameterException - full path or userId is null
        PropertyServerException - problem accessing property server
        UserNotAuthorizedException - security access problem
      • addConnectionToAsset

        @Deprecated
        void addConnectionToAsset​(java.lang.String userId,
                                  java.lang.String assetGUID,
                                  java.lang.String assetSummary,
                                  Connection connection)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException
        Deprecated.
        Adds a connection to an asset. Assets can have multiple connections attached.
        Parameters:
        userId - calling user
        assetGUID - unique identifier of the attest 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:
        InvalidParameterException - full path or userId is null
        PropertyServerException - problem accessing property server
        UserNotAuthorizedException - security access problem