org.odpi.openmetadata.accessservices.assetowner.api

Interface AssetOnboardingInterface

public interface AssetOnboardingInterface

AssetOnboardingInterface provides the client-side interface for an asset owner to set up the metadata about their asset. This includes defining its name, source and license.

Method Summary

Modifier and Type	Method and Description
String	addAssetToCatalog(String userId, String typeName, String qualifiedName, String displayName, String description, Map<String,String> additionalProperties, Map<String,Object> extendedProperties) Add a simple asset description to the catalog.
void	addConnectionToAsset(String userId, String assetGUID, String assetSummary, Connection connection) Adds a connection to an asset.
void	addSchemaAttributesToSchema(String userId, String schemaTypeGUID, List<SchemaAttribute> schemaAttributes) Adds attributes to a complex schema type like a relational table or a structured document.
String	addSchemaToAsset(String userId, String assetGUID, SchemaType schemaType, List<SchemaAttribute> schemaAttributes) Links the supplied schema to the asset.

Method Detail

addAssetToCatalog

String addAssetToCatalog(String userId,
                         String typeName,
                         String qualifiedName,
                         String displayName,
                         String description,
                         Map<String,String> additionalProperties,
                         Map<String,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

addSchemaToAsset

String addSchemaToAsset(String userId,
                        String assetGUID,
                        SchemaType schemaType,
                        List<SchemaAttribute> schemaAttributes)
                 throws InvalidParameterException,
                        UserNotAuthorizedException,
                        PropertyServerException

Links the supplied schema to the asset. If the schema has the GUID set, it is assumed to refer to an existing schema defined in the metadata repository. If this schema is either not found, or already attached to an asset, then an error occurs. If the GUID is null then a new schemaType is added to the metadata repository and attached to the asset. 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

schemaType - schema to attach

schemaAttributes - list of schema attribute objects.

Returns:

unique identifier (guid) of the schema

Throws:

InvalidParameterException - full path or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

addSchemaAttributesToSchema

void addSchemaAttributesToSchema(String userId,
                                 String schemaTypeGUID,
                                 List<SchemaAttribute> schemaAttributes)
                          throws InvalidParameterException,
                                 UserNotAuthorizedException,
                                 PropertyServerException

Adds attributes to a complex schema type like a relational table or a structured document. This method can be called repeatedly to add many attributes to a schema.

Parameters:

userId - calling user

schemaTypeGUID - unique identifier if the schema to anchor these attributes to.

schemaAttributes - list of schema attribute objects.

Throws:

InvalidParameterException - userId or schemaTypeGUID is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

addConnectionToAsset

void addConnectionToAsset(String userId,
                          String assetGUID,
                          String assetSummary,
                          Connection connection)
                   throws InvalidParameterException,
                          UserNotAuthorizedException,
                          PropertyServerException

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