Interface AssetClassificationInterface
- All Known Implementing Classes:
AssetOwner
,AvroFileAssetOwner
,CSVFileAssetOwner
,FileSystemAssetOwner
,ValidValuesAssetOwner
public interface AssetClassificationInterface
The AssetClassificationInterface is used by the asset owner to add classifications and detailed definitions
to the asset. Typically, this interface is used after the discovery services have explored the asset's content
and created helpful annotations to guide the asset owner.
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addAssetOrigin
(String userId, String assetGUID, String organizationGUID, String businessCapabilityGUID, Map<String, String> otherOriginValues) Add or replace the asset origin classification to an 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 an attribute 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
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
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.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, OwnerType ownerType) Deprecated.void
updateAssetZones
(String userId, String assetGUID, List<String> assetZones) Update the zones for a specific asset.void
withdrawAsset
(String userId, String assetGUID) Update the zones for a specific asset to the zone list specified in the defaultZones.
-
Method Details
-
addSemanticAssignment
void addSemanticAssignment(String userId, String assetGUID, String glossaryTermGUID, String assetElementGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Create a simple relationship between a glossary term and an element in an Asset description (typically an attribute in the schema).- Parameters:
userId
- calling userassetGUID
- unique identifier of assetglossaryTermGUID
- unique identifier of the glossary termassetElementGUID
- element to link it to - its type must inherit from Referenceable. If null then the assetGUID is used.- Throws:
InvalidParameterException
- one of the parameters is null or invalidPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- security access problem
-
removeSemanticAssignment
void removeSemanticAssignment(String userId, String assetGUID, String glossaryTermGUID, String assetElementGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Remove the relationship between a glossary term and an element in an Asset description (typically a field in the schema).- Parameters:
userId
- calling userassetGUID
- unique identifier of assetglossaryTermGUID
- unique identifier of the glossary termassetElementGUID
- element to link it to - its type must inherit from Referenceable. If null then the assetGUID is used.- Throws:
InvalidParameterException
- one of the parameters is null or invalidPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- security access problem
-
addAssetOrigin
void addAssetOrigin(String userId, String assetGUID, String organizationGUID, String businessCapabilityGUID, Map<String, String> otherOriginValues) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerExceptionAdd or replace the asset origin classification to an asset.- Parameters:
userId
- calling userassetGUID
- unique identifier of assetorganizationGUID
- Unique identifier (GUID) of the organization where this asset originated from - or nullbusinessCapabilityGUID
- Unique identifier (GUID) of the business capability where this asset originated from.otherOriginValues
- Descriptive labels describing origin of the asset- Throws:
InvalidParameterException
- entity not known, null userId or guidPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- security access problem
-
removeAssetOrigin
void removeAssetOrigin(String userId, String assetGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Remove the asset origin classification to an asset.- Parameters:
userId
- calling userassetGUID
- unique identifier of asset- Throws:
InvalidParameterException
- entity not known, null userId or guidPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- security access problem
-
publishAsset
void publishAsset(String userId, String assetGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Update the zones for a specific asset to the zone list specified in the publishZones.- Parameters:
userId
- calling userassetGUID
- unique identifier for the asset to update- Throws:
InvalidParameterException
- entity not known, null userId or guidPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- security access problem
-
withdrawAsset
void withdrawAsset(String userId, String assetGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Update the zones for a specific asset to the zone list specified in the defaultZones.- Parameters:
userId
- calling userassetGUID
- unique identifier for the asset to update- Throws:
InvalidParameterException
- entity not known, null userId or guidPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- security access problem
-
updateAssetZones
void updateAssetZones(String userId, String assetGUID, List<String> assetZones) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Update the zones for a specific asset.- Parameters:
userId
- calling userassetGUID
- unique identifier for the asset to updateassetZones
- list of zones for the asset - these values override the current values - null means belongs to no zones.- Throws:
InvalidParameterException
- guid or userId is nullPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- security access problem
-
updateAssetOwner
@Deprecated void updateAssetOwner(String userId, String assetGUID, String ownerId, OwnerType ownerType) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Deprecated.Update the owner information for a specific asset.- Parameters:
userId
- calling userassetGUID
- unique identifier for the asset to updateownerId
- userId or profileGUID of the owner - or null to clear the fieldownerType
- indicator of the type of Id provided above - or null to clear the field- Throws:
InvalidParameterException
- userId is nullPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- security access problem
-
updateAssetOwner
void updateAssetOwner(String userId, String assetGUID, String ownerId, String ownerTypeName, String ownerPropertyName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Update the owner information for a specific asset.- Parameters:
userId
- calling userassetGUID
- unique identifier for the asset to updateownerId
- unique identifier/property of the owner - or null to clear the fieldownerTypeName
- name of the type of Id provided above - or null to clear the fieldownerPropertyName
- name of the property that describes the ownerId- Throws:
InvalidParameterException
- userId is nullPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- security access problem
-
addSecurityTags
void addSecurityTags(String userId, String assetGUID, String assetElementGUID, List<String> securityLabels, Map<String, Object> securityProperties, Map<String, throws InvalidParameterException, UserNotAuthorizedException, PropertyServerExceptionList<String>> accessGroups) Add or replace the security tags for an asset or one of its elements.- Parameters:
userId
- calling userassetGUID
- unique identifier of assetassetElementGUID
- 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 elementsecurityProperties
- Descriptive labels describing the security properties of the elementaccessGroups
- map from operation to list of security groups- Throws:
InvalidParameterException
- asset or element not known, null userId or guidPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- security access problem
-
removeSecurityTags
void removeSecurityTags(String userId, String assetGUID, String assetElementGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Remove the security tags classification to an asset or one of its elements.- Parameters:
userId
- calling userassetGUID
- unique identifier of assetassetElementGUID
- element where the security tags need to be removed. If null then the assetGUID is used- Throws:
InvalidParameterException
- asset or element not known, null userId or guidPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- security access problem
-
addTemplateClassification
void addTemplateClassification(String userId, String assetGUID, String name, String description, Map<String, String> additionalProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerExceptionClassify an asset as suitable to be used as a template for cataloguing assets of a similar types.- Parameters:
userId
- calling userassetGUID
- unique identifier of the asset to classifyname
- name of the templatedescription
- description of when, where and how to use the templateadditionalProperties
- any additional properties- Throws:
InvalidParameterException
- asset or element not known, null userId or guidPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- security access problem
-
removeTemplateClassification
void removeTemplateClassification(String userId, String assetGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Remove the classification that indicates that this asset can be used as a template.- Parameters:
userId
- calling userassetGUID
- unique identifier of the asset to declassify- Throws:
InvalidParameterException
- asset or element not known, null userId or guidPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- security access problem
-