Interface AssetOnboardingInterface
-
- All Known Implementing Classes:
AssetOwner
,AvroFileAssetOwner
,CSVFileAssetOwner
,FileSystemAssetOwner
,ValidValuesAssetOwner
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
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.void
updateAsset(java.lang.String userId, java.lang.String assetGUID, boolean isMergeUpdate, AssetProperties assetProperties)
Update the metadata element representing an asset.
-
-
-
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 subtypequalifiedName
- unique name for the asset in the catalogdisplayName
- display name for the asset in the catalogdescription
- description of the asset in the catalogadditionalProperties
- additional properties added by the callerextendedProperties
- properties from the subtypes- Returns:
- unique identifier (guid) of the asset
- Throws:
InvalidParameterException
- full path or userId is nullPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- security access problem
-
addAssetToCatalog
java.lang.String addAssetToCatalog(java.lang.String userId, AssetProperties assetProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
Add a comprehensive asset description to the catalog.- Parameters:
userId
- calling userassetProperties
- properties for the asset- Returns:
- unique identifier (guid) of the asset
- Throws:
InvalidParameterException
- full path or userId is nullPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- security access problem
-
addAssetToCatalogUsingTemplate
java.lang.String addAssetToCatalogUsingTemplate(java.lang.String userId, java.lang.String templateGUID, TemplateProperties templateProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
Create a new metadata element to represent an asset using an existing asset as a template.- Parameters:
userId
- calling usertemplateGUID
- unique identifier of the metadata element to copytemplateProperties
- properties that override the template- Returns:
- unique identifier of the new metadata element
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
updateAsset
void updateAsset(java.lang.String userId, java.lang.String assetGUID, boolean isMergeUpdate, AssetProperties assetProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
Update the metadata element representing an asset.- Parameters:
userId
- calling userassetGUID
- unique identifier of the metadata element to updateisMergeUpdate
- should the new properties be merged with existing properties (true) or completely replace them (false)?assetProperties
- new properties for this element- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
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 userassetGUID
- unique identifier of the asset that the schema is to be attached toschemaType
- 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 nullPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- security access problem
-
addSchemaTypeToAsset
java.lang.String addSchemaTypeToAsset(java.lang.String userId, java.lang.String assetGUID, SchemaTypeProperties schemaType) throws InvalidParameterException, UserNotAuthorizedException, 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 userassetGUID
- unique identifier of the asset that the schema is to be attached toschemaType
- schema type to create and attach directly to the asset.- Returns:
- guid of the new schema type or
- Throws:
InvalidParameterException
- full path or userId is nullPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- 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 userassetGUID
- unique identifier of the asset that the schema is to be attached toschemaTypeGUID
- unique identifier of the schema type to attach- Throws:
InvalidParameterException
- full path or userId is nullPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- security access problem
-
detachSchemaTypeFromAsset
java.lang.String detachSchemaTypeFromAsset(java.lang.String userId, java.lang.String assetGUID) throws InvalidParameterException, UserNotAuthorizedException, 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 userassetGUID
- unique identifier of the asset that the schema is to be attached to- Returns:
- guid of detached schema type
- Throws:
InvalidParameterException
- full path or userId is nullPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- security access problem
-
deleteAssetSchemaType
void deleteAssetSchemaType(java.lang.String userId, java.lang.String assetGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
Detaches and deletes an asset's schema.- Parameters:
userId
- calling userassetGUID
- unique identifier of the asset that the schema is to be attached to- Throws:
InvalidParameterException
- full path or userId is nullPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- 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 touserId
- calling userassetGUID
- unique identifier of the asset that the schema is to be attached toparentGUID
- unique identifier of the schema element to anchor these attributes to.schemaAttributes
- list of schema attribute objects.- Throws:
InvalidParameterException
- full path or userId is nullPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- 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 touserId
- calling userassetGUID
- unique identifier of the asset that the schema is to be attached toparentGUID
- 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 nullPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- 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 userassetGUID
- unique identifier of the attest to attach the connection toassetSummary
- 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 nullPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- security access problem
-
-