org.odpi.openmetadata.accessservices.assetowner.api

Interface AssetVisibilityInterface

public interface AssetVisibilityInterface

The AssetVisibilityInterface is used by the asset owner to define the zones where the asset is located and any additional policies/licences that need to be set up on the asset to control who can see the asset and what it can be used for.

Method Summary

Modifier and Type	Method and Description
void	createGovernanceZone(String userId, String qualifiedName, String displayName, String description, String criteria, Map<String,String> additionalProperties) Create a definition of a governance zone.
GovernanceZone	getGovernanceZone(String userId, String qualifiedName) Return information about a specific governance zone.
List<GovernanceZone>	getGovernanceZones(String userId, int startingFrom, int maximumResults) Return information about the defined governance zones.
void	updateAssetOwner(String userId, String assetGUID, String ownerId, OwnerType ownerType) Update the owner information for a specific asset.
void	updateAssetZones(String userId, String assetGUID, List<String> assetZones) Update the zones for a specific asset.

Method Detail

createGovernanceZone

void createGovernanceZone(String userId,
                          String qualifiedName,
                          String displayName,
                          String description,
                          String criteria,
                          Map<String,String> additionalProperties)
                   throws InvalidParameterException,
                          UserNotAuthorizedException,
                          PropertyServerException

Create a definition of a governance zone. The qualified name of these governance zones can be added to the supportedZones and defaultZones properties of an OMAS to control which assets are processed and how they are set up. In addition the qualified names of zones can be added to Asset definitions to indicate which zone(s) they belong to.

Parameters:

userId - calling user

qualifiedName - unique name for the zone - used in other configuration

displayName - short display name for the zone

description - description of the governance zone

criteria - the criteria for inclusion in a governance zone

additionalProperties - additional properties for a governance zone

Throws:

InvalidParameterException - qualifiedName or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getGovernanceZone

GovernanceZone getGovernanceZone(String userId,
                                 String qualifiedName)
                          throws InvalidParameterException,
                                 UserNotAuthorizedException,
                                 PropertyServerException

Return information about a specific governance zone.

Parameters:

userId - calling user

qualifiedName - unique name for the zone

Returns:

properties of the governance zone

Throws:

InvalidParameterException - qualifiedName or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getGovernanceZones

List<GovernanceZone> getGovernanceZones(String userId,
                                        int startingFrom,
                                        int maximumResults)
                                 throws InvalidParameterException,
                                        UserNotAuthorizedException,
                                        PropertyServerException

Return information about the defined governance zones.

Parameters:

userId - calling user

startingFrom - position in the list (used when there are so many reports that paging is needed

maximumResults - maximum number of elements to return an this call

Returns:

properties of the governance zone

Throws:

InvalidParameterException - qualifiedName or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - 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 user

assetGUID - unique identifier for the asset to update

assetZones - list of zones for the asset - these values override the current values - null means belongs to no zones.

Throws:

InvalidParameterException - guid or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

updateAssetOwner

void updateAssetOwner(String userId,
                      String assetGUID,
                      String ownerId,
                      OwnerType ownerType)
               throws InvalidParameterException,
                      UserNotAuthorizedException,
                      PropertyServerException

Update the owner information for a specific asset.

Parameters:

userId - calling user

assetGUID - unique identifier for the asset to update

ownerId - userId or profileGUID of the owner - or null to clear the field

ownerType - indicator of the type of Id provides above - or null to clear the field

Throws:

InvalidParameterException - userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem