Package 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	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.
String	addAssetToCatalog(String userId, AssetProperties assetProperties)	Add a comprehensive asset description to the catalog.
String	addAssetToCatalogUsingTemplate(String userId, String templateGUID, TemplateProperties templateProperties)	Create a new metadata element to represent an asset using an existing asset as a template.
String	addCombinedSchemaToAsset(String userId, String assetGUID, SchemaTypeProperties schemaType, List<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, SchemaAttributeProperties schemaAttribute)	Adds an 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<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, SchemaTypeProperties schemaType)	Stores the supplied schema type in the catalog and attaches it to the asset.
void	attachSchemaTypeToAsset(String userId, String assetGUID, String schemaTypeGUID)	Links the supplied schema type directly to the asset.
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.
void	updateAsset(String userId, String assetGUID, boolean isMergeUpdate, AssetProperties assetProperties)	Update the metadata element representing an asset.

Method Details

addAssetToCatalog

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

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:

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

String addAssetToCatalog(String userId,
 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.

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

String addAssetToCatalogUsingTemplate(String userId,
 String templateGUID,
 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.

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

void updateAsset(String userId,
 String assetGUID,
 boolean isMergeUpdate,
 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.

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

String addCombinedSchemaToAsset(String userId,
 String assetGUID,
 SchemaTypeProperties schemaType,
 List<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().

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

String addSchemaTypeToAsset(String userId,
 String assetGUID,
 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.

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

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.

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

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 be reattached to a different asset.

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

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.

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

void addSchemaAttributes(String serverName,
 String userId,
 String assetGUID,
 String parentGUID,
 List<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.

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

String addSchemaAttribute(String serverName,
 String userId,
 String assetGUID,
 String parentGUID,
 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 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:

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
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.

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:

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