AssetHandler (Generic Handler Services 2.4 API)

java.lang.Object
- org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIGenericHandler
- - org.odpi.openmetadata.commonservices.generichandlers.ReferenceableHandler
 - - org.odpi.openmetadata.commonservices.generichandlers.AssetHandler

```
public class AssetHandler
extends ReferenceableHandler
```
AssetHandler manages B objects and optionally connections in the property server. It runs server-side in the OMAG Server Platform and retrieves Assets and Connections through the OMRSRepositoryConnector.

Field Summary
- Fields inherited from class org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIGenericHandler
  auditLog, beanClass, converter, defaultZones, errorHandler, invalidParameterHandler, localServerUserId, publishZones, repositoryHandler, repositoryHelper, securityVerifier, serverName, serviceName, supportedZones

Constructor Summary

Constructors
Constructor and Description
`AssetHandler(OpenMetadataAPIGenericConverter<B> converter, Class<B> beanClass, String serviceName, String serverName, InvalidParameterHandler invalidParameterHandler, RepositoryHandler repositoryHandler, OMRSRepositoryHelper repositoryHelper, String localServerUserId, OpenMetadataServerSecurityVerifier securityVerifier, List<String> supportedZones, List<String> defaultZones, List<String> publishZones, AuditLog auditLog)` Construct the asset handler with information needed to work with B objects.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`addAssetFromTemplate(String userId, String externalSourceGUID, String externalSourceName, String templateGUID, String templateGUIDParameterName, String expectedTypeGUID, String expectedTypeName, String qualifiedName, String qualifiedNameParameterName, String displayName, String description, String methodName)` Add a simple asset description to the metadata repository.
`void`	`addAssetOrigin(String userId, String assetGUID, String assetGUIDParameterName, String organizationGUID, String organizationGUIDParameterName, String businessCapabilityGUID, String businessCapabilityGUIDParameterName, Map<String,String> otherOriginValues, String methodName)` Add the asset origin classification to an asset.
`List<String>`	`assetGUIDsScan(String userId, String subTypeGUID, String subTypeName, int startFrom, int pageSize, String methodName)` Scan through the repository looking for assets by type.
`List<String>`	`assetGUIDsScan(String userId, String subTypeGUID, String subTypeName, List<String> suppliedSupportedZones, int startFrom, int pageSize, String methodName)` Scan through the repository looking for assets by type.
`List<String>`	`assetGUIDZoneScan(String userId, String zoneName, String subTypeGUID, String subTypeName, List<String> suppliedSupportedZones, int startFrom, int pageSize, String methodName)` Scan through the repository looking for assets by type and/or zone.
`List<B>`	`assetScan(String userId, String subTypeGUID, String subTypeName, int startFrom, int pageSize, String methodName)` Scan through the repository looking for assets by type.
`List<B>`	`assetScan(String userId, String subTypeGUID, String subTypeName, List<String> suppliedSupportedZones, int startFrom, int pageSize, String methodName)` Scan through the repository looking for assets by type.
`List<B>`	`assetZoneScan(String userId, String zoneName, String subTypeGUID, String subTypeName, List<String> suppliedSupportedZones, int startFrom, int pageSize, String methodName)` Scan through the repository looking for assets by type and/or zone.
`void`	`attachSchemaTypeToAsset(String userId, String externalSourceGUID, String externalSourceName, String assetGUID, String assetGUIDParameterName, String schemaTypeGUID, String schemaTypeGUIDParameterName, String methodName)` Link the schema type and asset.
`void`	`classifyAssetAsReferenceData(String userId, String assetGUID, String assetGUIDParameterName, String methodName)` Add the ReferenceData classification to an asset.
`String`	`createAssetInRepository(String userId, String externalSourceGUID, String externalSourceName, String qualifiedName, String displayName, String description, List<String> zoneMembership, String owner, int ownerType, String originOrganizationCapabilityGUID, String originBusinessCapabilityGUID, Map<String,String> otherOriginValues, Map<String,String> additionalProperties, String typeGUID, String typeName, Map<String,Object> extendedProperties, String methodName)` Add a simple asset description to the metadata repository.
`void`	`declassifyAssetAsReferenceData(String userId, String assetGUID, String assetGUIDParameterName, String methodName)` Remove the ReferenceData classification from an Asset.
`String`	`detachSchemaTypeFromAsset(String userId, String externalSourceGUID, String externalSourceName, String assetGUID, String assetGUIDParameterName, String methodName)` Remove any associated schema type.
`List<String>`	`findAssetGUIDs(String userId, String searchString, String searchStringParameter, int startFrom, int pageSize, String methodName)` Return a list of assets with the requested search string in their name, qualified name or description.
`List<String>`	`findAssetGUIDs(String userId, String typeGUID, String typeName, String searchString, String searchStringParameter, int startFrom, int pageSize, String methodName)` Return a list of assets with the requested search string in their name, qualified name or description.
`List<B>`	`findAssets(String userId, String searchString, String searchStringParameter, int startFrom, int pageSize, String methodName)` Return a list of assets with the requested search string in their name, qualified name or description.
`List<B>`	`findAssets(String userId, String typeGUID, String typeName, String searchString, String searchStringParameter, int startFrom, int pageSize, String methodName)` Return a list of assets with the requested search string in their name, qualified name or description.
`List<B>`	`findAssetsByName(String userId, String typeGUID, String typeName, String name, String nameParameterName, int startFrom, int pageSize, String methodName)` Return a list of assets with the requested name in either the display name or qualified name.
`List<B>`	`findAssetsByName(String userId, String typeGUID, String typeName, String name, String nameParameterName, List<String> serviceSupportedZones, int startFrom, int pageSize, String methodName)` Return a list of assets with the requested name in either the display name or qualified name.
`List<B>`	`getAllAssetsWithConnection(String userId, String assetTypeGUID, String assetTypeName, int startFrom, int pageSize, String methodName)` Return the list of discovery services definitions that are stored.
`B`	`getAssetByNameWithConnection(String userId, String name, String nameParameterName, String assetTypeGUID, String assetTypeName, String methodName)` Return an asset along with any associated connection.
`String`	`getAssetForConnection(String userId, String connectionGUID, String connectionGUIDParameterName, List<String> serviceSupportedZones, String methodName)` Returns the unique identifier for the asset connected to the requested connection.
`String`	`getAssetForConnectionName(String userId, String connectionName, String connectionNameParameter, String methodName)` Returns the asset corresponding to the supplied connection name.
`List<String>`	`getAssetGUIDsByEndpoint(String userId, String networkAddress, String networkAddressParameterName, int startFrom, int pageSize, String methodName)` Return the list of assets that have the same endpoint address.
`List<String>`	`getAssetGUIDsByKeyword(String userId, String keywordGUID, String keywordGUIDParameterName, int startFrom, int pageSize, String methodName)` Return the list of unique identifiers for assets that are linked to a specific keyword either directly, or via one of its schema elements.
`List<String>`	`getAssetGUIDsByName(String userId, String typeGUID, String typeName, String name, String nameParameterName, int startFrom, int pageSize, String methodName)` Return a list of assets with the requested name in either the display name or qualified name.
`List<String>`	`getAssetGUIDsByName(String userId, String typeGUID, String typeName, String name, String nameParameterName, List<String> serviceSupportedZones, int startFrom, int pageSize, String methodName)` Return a list of assets with the requested name in either the display name or qualified name.
`List<String>`	`getAssetGUIDsByTag(String userId, String tagGUID, String tagGUIDParameterName, int startFrom, int pageSize, String methodName)` Return the list of unique identifiers for assets that are linked to a specific tag either directly, or via one of its schema elements.
`List<B>`	`getAssetsByEndpoint(String userId, String networkAddress, String networkAddressParameterName, String suppliedTypeName, int startFrom, int pageSize, String methodName)` Return the list of assets that have the same endpoint address.
`List<B>`	`getAssetsByGlossaryTerm(String userId, String termGUID, String termGUIDParameterName, int startFrom, int pageSize, String methodName)` Return the list of assets that are linked to a specific glossary term.
`List<B>`	`getAssetsByKeyword(String userId, String keywordGUID, String keywordGUIDParameterName, int startFrom, int pageSize, String methodName)` Return the list of assets that are linked to a specific keyword.
`List<B>`	`getAssetsByName(String userId, String typeGUID, String typeName, String name, String nameParameterName, int startFrom, int pageSize, String methodName)` Return a list of assets with the requested name in either the display name or qualified name.
`List<B>`	`getAssetsByName(String userId, String typeGUID, String typeName, String name, String nameParameterName, List<String> serviceSupportedZones, int startFrom, int pageSize, String methodName)` Return a list of assets with the requested name in either the display name or qualified name.
`List<B>`	`getAssetsByTag(String userId, String tagGUID, String tagGUIDParameterName, int startFrom, int pageSize, String methodName)` Return the list of assets that are linked to a specific tag either directly, or via one of its schema elements.
`B`	`getAssetWithConnection(String userId, String assetGUID, String assetGUIDParameterName, String assetTypeName, String methodName)` Return an asset along with any associated connection.
`Map<String,String>`	`getTypesOfAssetDescriptions()` Return the list of asset subtype names mapped to their descriptions.
`List<String>`	`getTypesOfAssetList()` Return the list of asset subtype names.
`void`	`publishAsset(String userId, String assetGUID, String assetGUIDParameterName, String methodName)` Update the zones for a specific asset to the list set up in publish zones.
`void`	`removeAssetOrigin(String userId, String assetGUID, String assetGUIDParameterName, String methodName)` Remove the asset origin classification to an asset.
`void`	`removeAssociatedSchemaType(String userId, String externalSourceGUID, String externalSourceName, String assetGUID, String assetGUIDParameterName, String methodName)` Remove any associated schema type.
`void`	`saveSemanticAssignments(String userId, String externalSourceGUID, String externalSourceName, String beanGUID, String beanGUIDParameter, List<String> glossaryTermGUIDs, String glossaryTermGUIDsParameter, String methodName)` Create relationships between the identified glossary terms and an Asset.
`void`	`updateAsset(String userId, String externalSourceGUID, String externalSourceName, String assetGUID, String assetGUIDParameterName, String qualifiedName, String displayName, String description, Map<String,String> additionalProperties, String typeGUID, String typeName, Map<String,Object> extendedProperties, String methodName)` Update an asset's properties.
`void`	`updateAssetOwner(String userId, String assetGUID, String assetGUIDParameterName, String ownerId, int ownerType, String methodName)` Update the owner information for a specific asset.
`void`	`updateAssetWithConnection(String userId, String externalSourceGUID, String externalSourceName, String assetGUID, String assetGUIDParameterName, String qualifiedName, String displayName, String description, Map<String,String> additionalProperties, String typeGUID, String typeName, Map<String,Object> extendedProperties, String assetSummary, Connection connection, String methodName)` Update an asset's properties.
`void`	`updateAssetZones(String userId, String assetGUID, String assetGUIDParameterName, List<String> assetZones, String methodName)` Update the zones for a specific asset.
`void`	`withdrawAsset(String userId, String assetGUID, String assetGUIDParameterName, String methodName)` Update the zones for a specific asset to the list set up in publish zones.

Methods inherited from class org.odpi.openmetadata.commonservices.generichandlers.ReferenceableHandler
addSecurityTags, findBeanGUIDsByQualifiedName, findBeanGUIDsByQualifiedName, findBeansByQualifiedName, findBeansByQualifiedName, getBeanByQualifiedName, getBeanByQualifiedName, getBeanGUIDByQualifiedName, getBeanGUIDByQualifiedName, getBeanGUIDsByQualifiedName, getBeanGUIDsByQualifiedName, getBeansByQualifiedName, getBeansByQualifiedName, getMoreInformation, getMoreInformation, getVendorProperties, removeSecurityTags, removeSemanticAssignment, saveSemanticAssignment, saveSemanticAssignment

Methods inherited from class org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIGenericHandler
countAttachments, createBeanFromTemplate, createBeanInRepository, deleteBeanInRepository, deleteBeanInRepository, findBeanGUIDs, findBeans, findBeans, findBeans, findEntities, getAllAttachmentLinks, getAnchorsForAttachedElements, getAttachedElement, getAttachedElement, getAttachedElementGUID, getAttachedElementGUID, getAttachedElementGUIDs, getAttachedElementGUIDs, getAttachedElements, getAttachedElements, getAttachedElements, getAttachedElements, getAttachedEntities, getAttachedEntities, getAttachedEntity, getAttachedEntity, getAttachmentLinks, getAttachmentLinks, getBeanByUniqueName, getBeanByUniqueName, getBeanByValue, getBeanFromRepository, getBeanFromRepository, getBeanGUIDByUniqueName, getBeanGUIDsByClassification, getBeanGUIDsByType, getBeanGUIDsByType, getBeanGUIDsByValue, getBeansByClassification, getBeansByCreator, getBeansByType, getBeansByType, getBeansByValue, getBeansByValue, getBeansByValue, getBeansByValue, getEntitiesByType, getEntitiesByValue, getEntitiesByValue, getEntityByValue, getEntityFromRepository, getEntityFromRepository, getEntityFromRepository, getEntityGUIDByValue, getRepositoryHelper, getServiceName, getUniqueAttachmentLink, linkElementToElement, linkElementToElement, relinkElementToNewElement, relinkElementToNewElement, setSecurityVerifier, unlinkAllElements, unlinkConnectedElement, unlinkElementFromElement, unlinkElementFromElement, updateBeanInRepository, updateBeanInRepository, updateBeanPropertyInRepository, updateBeanStatusInRepository, validateAnchorEntity, validateAnchorEntity, verifyExternalSourceIdentity

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AssetHandler

public AssetHandler(OpenMetadataAPIGenericConverter<B> converter,
                    Class<B> beanClass,
                    String serviceName,
                    String serverName,
                    InvalidParameterHandler invalidParameterHandler,
                    RepositoryHandler repositoryHandler,
                    OMRSRepositoryHelper repositoryHelper,
                    String localServerUserId,
                    OpenMetadataServerSecurityVerifier securityVerifier,
                    List<String> supportedZones,
                    List<String> defaultZones,
                    List<String> publishZones,
                    AuditLog auditLog)

Construct the asset handler with information needed to work with B objects.

Parameters:: converter - specific converter for this bean class; beanClass - name of bean class that is represented by the generic class B; serviceName - name of this service; serverName - name of the local server; invalidParameterHandler - handler for managing parameter errors; repositoryHandler - manages calls to the repository services; repositoryHelper - provides utilities for manipulating the repository services objects; localServerUserId - userId for this server; securityVerifier - open metadata security services verifier; supportedZones - list of zones that the access service is allowed to serve B instances from.; defaultZones - list of zones that the access service should set in all new B instances.; publishZones - list of zones that the access service sets up in published B instances.; auditLog - destination for audit log events.

Method Detail

getTypesOfAssetList
```
public List<String> getTypesOfAssetList()
```
Return the list of asset subtype names.

Returns:

list of type names that are subtypes of asset

getTypesOfAssetDescriptions
```
public Map<String,String> getTypesOfAssetDescriptions()
```
Return the list of asset subtype names mapped to their descriptions.

Returns:

list of type names that are subtypes of asset

attachSchemaTypeToAsset

public void attachSchemaTypeToAsset(String userId,
                                    String externalSourceGUID,
                                    String externalSourceName,
                                    String assetGUID,
                                    String assetGUIDParameterName,
                                    String schemaTypeGUID,
                                    String schemaTypeGUIDParameterName,
                                    String methodName)
                             throws InvalidParameterException,
                                    PropertyServerException,
                                    UserNotAuthorizedException

Link the schema type and asset. This is called from outside of AssetHandler. The assetGUID is checked to ensure the asset exists and updates are allowed. If there is already a schema attached, it is deleted.

Parameters:: userId - calling user; externalSourceGUID - guid of the software server capability entity that represented the external source - null for local; externalSourceName - name of the software server capability entity that represented the external source - null for local; assetGUID - unique identifier of the asset to connect the schema to; assetGUIDParameterName - parameter providing the assetGUID; schemaTypeGUID - identifier for schema Type object; schemaTypeGUIDParameterName - parameter providing the schemaTypeGUID; methodName - calling method
Throws:: InvalidParameterException - the bean properties are invalid; UserNotAuthorizedException - user not authorized to issue this request; PropertyServerException - problem accessing the property server

removeAssociatedSchemaType

public void removeAssociatedSchemaType(String userId,
                                       String externalSourceGUID,
                                       String externalSourceName,
                                       String assetGUID,
                                       String assetGUIDParameterName,
                                       String methodName)
                                throws InvalidParameterException,
                                       PropertyServerException,
                                       UserNotAuthorizedException

Remove any associated schema type. This may be called from outside of AssetHandler. The assetGUID is checked to ensure the asset exists and updates are allowed. If there is a schema attached, it is deleted.

Parameters:: userId - calling user; externalSourceGUID - guid of the software server capability entity that represented the external source - null for local; externalSourceName - name of the software server capability entity that represented the external source - null for local; assetGUID - unique identifier of the asset to connect the schema to; assetGUIDParameterName - parameter providing the assetGUID; methodName - calling method
Throws:: InvalidParameterException - the bean properties are invalid; UserNotAuthorizedException - user not authorized to issue this request; PropertyServerException - problem accessing the property server

detachSchemaTypeFromAsset
```
public String detachSchemaTypeFromAsset(String userId,
                                        String externalSourceGUID,
                                        String externalSourceName,
                                        String assetGUID,
                                        String assetGUIDParameterName,
                                        String methodName)
                                 throws InvalidParameterException,
                                        PropertyServerException,
                                        UserNotAuthorizedException
```
Remove any associated schema type. This may be called from outside of AssetHandler. The assetGUID is checked to ensure the asset exists and updates are allowed. If there is a schema attached, it is deleted.

Parameters:

userId - calling user

externalSourceGUID - guid of the software server capability entity that represented the external source - null for local

externalSourceName - name of the software server capability entity that represented the external source - null for local

assetGUID - unique identifier of the asset to connect the schema to

assetGUIDParameterName - parameter providing the assetGUID

methodName - calling method

Returns:

guid of previously attached schema type or null if there is no schema

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

saveSemanticAssignments

public void saveSemanticAssignments(String userId,
                                    String externalSourceGUID,
                                    String externalSourceName,
                                    String beanGUID,
                                    String beanGUIDParameter,
                                    List<String> glossaryTermGUIDs,
                                    String glossaryTermGUIDsParameter,
                                    String methodName)
                             throws InvalidParameterException,
                                    PropertyServerException,
                                    UserNotAuthorizedException

Create relationships between the identified glossary terms and an Asset.

Parameters:: userId - calling user; externalSourceGUID - guid of the software server capability entity that represented the external source - null for local; externalSourceName - name of the software server capability entity that represented the external source - null for local; beanGUID - unique identifier of the referenceable that is being described; beanGUIDParameter - parameter supply the beanGUID; glossaryTermGUIDs - list of unique identifiers of the glossary terms; glossaryTermGUIDsParameter - parameter supplying the list of GlossaryTermGUIDs; methodName - calling method
Throws:: InvalidParameterException - the guid properties are invalid; UserNotAuthorizedException - user not authorized to issue this request; PropertyServerException - problem accessing the property server

addAssetFromTemplate
```
public String addAssetFromTemplate(String userId,
                                   String externalSourceGUID,
                                   String externalSourceName,
                                   String templateGUID,
                                   String templateGUIDParameterName,
                                   String expectedTypeGUID,
                                   String expectedTypeName,
                                   String qualifiedName,
                                   String qualifiedNameParameterName,
                                   String displayName,
                                   String description,
                                   String methodName)
                            throws InvalidParameterException,
                                   PropertyServerException,
                                   UserNotAuthorizedException
```
Add a simple asset description to the metadata repository. Null values for requested typename, ownership, zone membership and latest change are filled in with default values.

Parameters:

userId - calling userId

externalSourceGUID - guid of the software server capability entity that represented the external source - null for local

externalSourceName - name of the software server capability entity that represented the external source

templateGUID - unique identifier of the metadata element to copy

templateGUIDParameterName - name of parameter providing the templateGUID

expectedTypeGUID - unique identifier of type (or super type of asset identified by templateGUID)

expectedTypeName - unique name of type (or super type of asset identified by templateGUID)

qualifiedName - unique name for this asset - must not be null

qualifiedNameParameterName - parameter name providing qualifiedName

displayName - the stored display name property for the database - if null, the value from the template is used

description - the stored description property associated with the database - if null, the value from the template is used.

methodName - calling method

Returns:

unique identifier of the asset in the repository. If a connection or schema object is provided, it is stored linked to the asset.

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

createAssetInRepository

public String createAssetInRepository(String userId,
                                      String externalSourceGUID,
                                      String externalSourceName,
                                      String qualifiedName,
                                      String displayName,
                                      String description,
                                      List<String> zoneMembership,
                                      String owner,
                                      int ownerType,
                                      String originOrganizationCapabilityGUID,
                                      String originBusinessCapabilityGUID,
                                      Map<String,String> otherOriginValues,
                                      Map<String,String> additionalProperties,
                                      String typeGUID,
                                      String typeName,
                                      Map<String,Object> extendedProperties,
                                      String methodName)
                               throws InvalidParameterException,
                                      PropertyServerException,
                                      UserNotAuthorizedException

Add a simple asset description to the metadata repository. Null values for requested typename, ownership, zone membership and latest change are filled in with default values.

Parameters:: userId - calling user; externalSourceGUID - unique identifier of software server capability representing the caller; externalSourceName - unique name of software server capability representing the caller; qualifiedName - unique name for this asset; displayName - the stored display name property for the asset; description - the stored description property associated with the asset; zoneMembership - initial zones for the asset - or null to allow the security module to set it up; owner - identifier of the owner; ownerType - is the owner identifier a user id, personal profile or team profile; originOrganizationCapabilityGUID - unique identifier of originating organization; originBusinessCapabilityGUID - unique identifier of originating business capability; otherOriginValues - the properties that characterize where this asset is from; additionalProperties - any arbitrary properties not part of the type system; typeGUID - identifier of the type that is a subtype of asset - or null to create standard type; typeName - name of the type that is a subtype of asset - or null to create standard type; extendedProperties - properties from any subtype; methodName - calling method
Returns:: unique identifier of the new asset
Throws:: InvalidParameterException - the bean properties are invalid; UserNotAuthorizedException - user not authorized to issue this request; PropertyServerException - problem accessing the property server

updateAsset

public void updateAsset(String userId,
                        String externalSourceGUID,
                        String externalSourceName,
                        String assetGUID,
                        String assetGUIDParameterName,
                        String qualifiedName,
                        String displayName,
                        String description,
                        Map<String,String> additionalProperties,
                        String typeGUID,
                        String typeName,
                        Map<String,Object> extendedProperties,
                        String methodName)
                 throws InvalidParameterException,
                        UserNotAuthorizedException,
                        PropertyServerException

Update an asset's properties.

Parameters:: userId - calling user; externalSourceGUID - unique identifier of software server capability representing the caller; externalSourceName - unique name of software server capability representing the caller; assetGUID - unique identifier of the metadata element to update; assetGUIDParameterName - parameter name that supplied the assetGUID; qualifiedName - unique name for this database; displayName - the stored display name property for the database; description - the stored description property associated with the database; additionalProperties - any arbitrary properties not part of the type system; typeGUID - identifier of the type that is a subtype of Database - or null to create standard type; typeName - name of the type that is a subtype of Database - or null to create standard type; extendedProperties - properties from any subtype; methodName - calling method
Throws:: InvalidParameterException - one of the parameters is invalid; UserNotAuthorizedException - the user is not authorized to issue this request; PropertyServerException - there is a problem reported in the open metadata server(s)

updateAssetWithConnection

public void updateAssetWithConnection(String userId,
                                      String externalSourceGUID,
                                      String externalSourceName,
                                      String assetGUID,
                                      String assetGUIDParameterName,
                                      String qualifiedName,
                                      String displayName,
                                      String description,
                                      Map<String,String> additionalProperties,
                                      String typeGUID,
                                      String typeName,
                                      Map<String,Object> extendedProperties,
                                      String assetSummary,
                                      Connection connection,
                                      String methodName)
                               throws InvalidParameterException,
                                      UserNotAuthorizedException,
                                      PropertyServerException

Update an asset's properties.

Parameters:: userId - calling user; externalSourceGUID - unique identifier of software server capability representing the caller; externalSourceName - unique name of software server capability representing the caller; assetGUID - unique identifier of the metadata element to update; assetGUIDParameterName - parameter name that supplied the assetGUID; qualifiedName - unique name for this database; displayName - the stored display name property for the database; description - the stored description property associated with the database; additionalProperties - any arbitrary properties not part of the type system; typeGUID - identifier of the type that is a subtype of Database - or null to create standard type; typeName - name of the type that is a subtype of Database - or null to create standard type; extendedProperties - properties from any subtype; connection - connection associated with the asset; assetSummary - description of the asset from the perspective of the connection; methodName - calling method
Throws:: InvalidParameterException - one of the parameters is invalid; UserNotAuthorizedException - the user is not authorized to issue this request; PropertyServerException - there is a problem reported in the open metadata server(s)

classifyAssetAsReferenceData

public void classifyAssetAsReferenceData(String userId,
                                         String assetGUID,
                                         String assetGUIDParameterName,
                                         String methodName)
                                  throws InvalidParameterException,
                                         UserNotAuthorizedException,
                                         PropertyServerException

Add the ReferenceData classification to an asset. If the asset is already classified in this way, the method is a no-op.

Parameters:: userId - calling user.; assetGUID - unique identifier of the asset that contains reference data.; assetGUIDParameterName - name of parameter providing assetGUID; methodName - calling method
Throws:: InvalidParameterException - one of the parameters is invalid.; UserNotAuthorizedException - the user is not authorized to make this request.; PropertyServerException - the repository is not available or not working properly.

declassifyAssetAsReferenceData

public void declassifyAssetAsReferenceData(String userId,
                                           String assetGUID,
                                           String assetGUIDParameterName,
                                           String methodName)
                                    throws InvalidParameterException,
                                           UserNotAuthorizedException,
                                           PropertyServerException

Remove the ReferenceData classification from an Asset. If the asset was not classified in this way, this call is a no-op.

Parameters:: userId - calling user.; assetGUID - unique identifier of asset.; assetGUIDParameterName - name of parameter providing assetGUID; methodName - calling method
Throws:: InvalidParameterException - one of the parameters is invalid.; UserNotAuthorizedException - the user is not authorized to make this request.; PropertyServerException - the repository is not available or not working properly.

addAssetOrigin
```
public void addAssetOrigin(String userId,
 String assetGUID,
 String assetGUIDParameterName,
 String organizationGUID,
 String organizationGUIDParameterName,
 String businessCapabilityGUID,
 String businessCapabilityGUIDParameterName,
 Map<String,String> otherOriginValues,
 String methodName)
 throws InvalidParameterException,
 UserNotAuthorizedException,
 PropertyServerException
```
Add the asset origin classification to an asset. The method needs to build a before an after image of the asset to perform a security check before the update is pushed to the repository.

Parameters:

userId - calling user

assetGUID - unique identifier of asset

assetGUIDParameterName - parameter name supplying assetGUID

organizationGUID - Unique identifier (GUID) of the organization where this asset originated from - or null

organizationGUIDParameterName - parameter name supplying organizationGUID

businessCapabilityGUID - Unique identifier (GUID) of the business capability where this asset originated from.

businessCapabilityGUIDParameterName - parameter name supplying businessCapabilityGUID

otherOriginValues - Descriptive labels describing origin of the asset

methodName - calling method

Throws:

InvalidParameterException - entity not known, null userId or guid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

removeAssetOrigin

public void removeAssetOrigin(String userId,
                              String assetGUID,
                              String assetGUIDParameterName,
                              String methodName)
                       throws InvalidParameterException,
                              UserNotAuthorizedException,
                              PropertyServerException

Remove the asset origin classification to an asset.

Parameters:: userId - calling user; assetGUID - unique identifier of asset; assetGUIDParameterName - parameter name supplying assetGUID; methodName - calling method
Throws:: InvalidParameterException - entity not known, null userId or guid; PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

publishAsset

public void publishAsset(String userId,
                         String assetGUID,
                         String assetGUIDParameterName,
                         String methodName)
                  throws InvalidParameterException,
                         UserNotAuthorizedException,
                         PropertyServerException

Update the zones for a specific asset to the list set up in publish zones.

Parameters:: userId - calling user; assetGUID - unique identifier for the asset to update; assetGUIDParameterName - parameter name supplying assetGUID; methodName - calling method
Throws:: InvalidParameterException - guid or userId is null; PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

withdrawAsset

public void withdrawAsset(String userId,
                          String assetGUID,
                          String assetGUIDParameterName,
                          String methodName)
                   throws InvalidParameterException,
                          UserNotAuthorizedException,
                          PropertyServerException

Update the zones for a specific asset to the list set up in publish zones.

Parameters:: userId - calling user; assetGUID - unique identifier for the asset to update; assetGUIDParameterName - parameter name supplying assetGUID; methodName - calling method
Throws:: InvalidParameterException - guid or userId is null; PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

updateAssetZones
```
public void updateAssetZones(String userId,
 String assetGUID,
 String assetGUIDParameterName,
 List<String> assetZones,
 String methodName)
 throws InvalidParameterException,
 UserNotAuthorizedException,
 PropertyServerException
```
Update the zones for a specific asset. The method needs to build a before an after image of the asset to perform a security check before the update is pushed to the repository.

Parameters:

userId - calling user

assetGUID - unique identifier for the asset to update

assetGUIDParameterName - parameter name supplying assetGUID

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

methodName - calling method

Throws:

InvalidParameterException - guid or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

updateAssetOwner

public void updateAssetOwner(String userId,
                             String assetGUID,
                             String assetGUIDParameterName,
                             String ownerId,
                             int ownerType,
                             String methodName)
                      throws InvalidParameterException,
                             UserNotAuthorizedException,
                             PropertyServerException

Update the owner information for a specific asset.

Parameters:: userId - calling user; assetGUID - unique identifier for the asset to update; assetGUIDParameterName - parameter name supplying assetGUID; 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; methodName - calling method
Throws:: InvalidParameterException - userId is null; PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

getAssetForConnection

public String getAssetForConnection(String userId,
                                    String connectionGUID,
                                    String connectionGUIDParameterName,
                                    List<String> serviceSupportedZones,
                                    String methodName)
                             throws InvalidParameterException,
                                    PropertyServerException,
                                    UserNotAuthorizedException

Returns the unique identifier for the asset connected to the requested connection.

Parameters:: userId - the userId of the requesting user; connectionGUID - unique identifier for the connection; connectionGUIDParameterName - name of parameter supplying connectionGUID; serviceSupportedZones - list of supported zones for any connected asset; methodName - calling method
Returns:: unique identifier of asset.
Throws:: InvalidParameterException - one of the parameters is null or invalid.; PropertyServerException - there is a problem retrieving information from the property server.; UserNotAuthorizedException - the requesting user is not authorized to issue this request.

getAssetForConnectionName

public String getAssetForConnectionName(String userId,
                                        String connectionName,
                                        String connectionNameParameter,
                                        String methodName)
                                 throws InvalidParameterException,
                                        PropertyServerException,
                                        UserNotAuthorizedException

Returns the asset corresponding to the supplied connection name.

Parameters:: userId - userId of user making request.; connectionName - this may be the qualifiedName or displayName of the connection.; connectionNameParameter - name of parameter supplying; methodName - calling method
Returns:: unique identifier of asset.
Throws:: InvalidParameterException - one of the parameters is null or invalid.; PropertyServerException - there is a problem retrieving information from the property server(s).; UserNotAuthorizedException - the requesting user is not authorized to issue this request.

getAssetWithConnection

public B getAssetWithConnection(String userId,
                                String assetGUID,
                                String assetGUIDParameterName,
                                String assetTypeName,
                                String methodName)
                         throws InvalidParameterException,
                                UserNotAuthorizedException,
                                PropertyServerException

Return an asset along with any associated connection.

Parameters:: userId - calling user; assetGUID - unique identifier of the asset; assetGUIDParameterName - name of parameter supplying assetGUID; assetTypeName - type name of asset; methodName - calling method
Returns:: an asset bean (with embedded connection details if available)
Throws:: InvalidParameterException - one of the parameters is null or invalid.; PropertyServerException - there is a problem retrieving information from the property server(s).; UserNotAuthorizedException - the requesting user is not authorized to issue this request.

getAssetByNameWithConnection

public B getAssetByNameWithConnection(String userId,
                                      String name,
                                      String nameParameterName,
                                      String assetTypeGUID,
                                      String assetTypeName,
                                      String methodName)
                               throws InvalidParameterException,
                                      UserNotAuthorizedException,
                                      PropertyServerException

Return an asset along with any associated connection.

Parameters:: userId - calling user; name - unique identifier of the asset; nameParameterName - name of parameter supplying name; assetTypeGUID - type identifier of asset; assetTypeName - type name of asset; methodName - calling method
Returns:: an asset bean (with embedded connection details if available)
Throws:: InvalidParameterException - one of the parameters is null or invalid.; PropertyServerException - there is a problem retrieving information from the property server(s).; UserNotAuthorizedException - the requesting user is not authorized to issue this request.

getAllAssetsWithConnection

public List<B> getAllAssetsWithConnection(String userId,
                                          String assetTypeGUID,
                                          String assetTypeName,
                                          int startFrom,
                                          int pageSize,
                                          String methodName)
                                   throws InvalidParameterException,
                                          UserNotAuthorizedException,
                                          PropertyServerException

Return the list of discovery services definitions that are stored.

Parameters:: userId - identifier of calling user; assetTypeGUID - subtype of asset required; assetTypeName - subtype of asset required; startFrom - initial position in the stored list; pageSize - maximum number of definitions to return on this call; methodName - calling method
Returns:: list of beans.
Throws:: InvalidParameterException - one of the parameters is null or invalid.; UserNotAuthorizedException - user not authorized to issue this request.; PropertyServerException - problem retrieving the discovery service definitions.

assetGUIDsScan

public List<String> assetGUIDsScan(String userId,
                                   String subTypeGUID,
                                   String subTypeName,
                                   int startFrom,
                                   int pageSize,
                                   String methodName)
                            throws InvalidParameterException,
                                   PropertyServerException,
                                   UserNotAuthorizedException

Scan through the repository looking for assets by type. The type name may be null which means, all assets will be returned.

Parameters:: userId - calling user; subTypeGUID - type of asset to scan for (null for all asset types); subTypeName - type of asset to scan for (null for all asset types); startFrom - scan pointer; pageSize - maximum number of results; methodName - calling method
Returns:: list of matching assets
Throws:: InvalidParameterException - one of the parameters is null or invalid.; PropertyServerException - there is a problem retrieving information from the property server(s).; UserNotAuthorizedException - the requesting user is not authorized to issue this request.

assetGUIDsScan

public List<String> assetGUIDsScan(String userId,
                                   String subTypeGUID,
                                   String subTypeName,
                                   List<String> suppliedSupportedZones,
                                   int startFrom,
                                   int pageSize,
                                   String methodName)
                            throws InvalidParameterException,
                                   PropertyServerException,
                                   UserNotAuthorizedException

Scan through the repository looking for assets by type. The type name may be null which means, all assets will be returned.

Parameters:: userId - calling user; subTypeGUID - type of asset to scan for (null for all asset types); subTypeName - type of asset to scan for (null for all asset types); suppliedSupportedZones - list of supported zones from calling service; startFrom - scan pointer; pageSize - maximum number of results; methodName - calling method
Returns:: list of matching assets
Throws:: InvalidParameterException - one of the parameters is null or invalid.; PropertyServerException - there is a problem retrieving information from the property server(s).; UserNotAuthorizedException - the requesting user is not authorized to issue this request.

assetScan
```
public List assetScan(String userId,
 String subTypeGUID,
 String subTypeName,
 int startFrom,
 int pageSize,
 String methodName)
 throws InvalidParameterException,
 PropertyServerException,
 UserNotAuthorizedException
```
Scan through the repository looking for assets by type. The type name may be null which means, all assets will be returned.

Parameters:

userId - calling user

subTypeGUID - type of asset to scan for (null for all asset types)

subTypeName - type of asset to scan for (null for all asset types)

startFrom - scan pointer

pageSize - maximum number of results

methodName - calling method

Returns:

list of matching assets

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - there is a problem retrieving information from the property server(s).

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

assetScan
```
public List assetScan(String userId,
 String subTypeGUID,
 String subTypeName,
 List<String> suppliedSupportedZones,
 int startFrom,
 int pageSize,
 String methodName)
 throws InvalidParameterException,
 PropertyServerException,
 UserNotAuthorizedException
```
Scan through the repository looking for assets by type. The type name may be null which means, all assets will be returned.

Parameters:

userId - calling user

subTypeGUID - type of asset to scan for (null for all asset types)

subTypeName - type of asset to scan for (null for all asset types)

startFrom - scan pointer

pageSize - maximum number of results

suppliedSupportedZones - list of supported zones from calling service

methodName - calling method

Returns:

list of matching assets

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - there is a problem retrieving information from the property server(s).

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

assetZoneScan
```
public List assetZoneScan(String userId,
 String zoneName,
 String subTypeGUID,
 String subTypeName,
 List<String> suppliedSupportedZones,
 int startFrom,
 int pageSize,
 String methodName)
 throws InvalidParameterException,
 PropertyServerException,
 UserNotAuthorizedException
```
Scan through the repository looking for assets by type and/or zone. The type name may be null which means, all types of assets will be returned. The zone name may be null which means all supportedZones for the service are returned.

Parameters:

userId - calling user

zoneName - name of zone to scan

subTypeGUID - type of asset to scan for (null for all asset types)

subTypeName - type of asset to scan for (null for all asset types)

suppliedSupportedZones - list of supported zones from calling service

startFrom - scan pointer

pageSize - maximum number of results

methodName - calling method

Returns:

list of matching assets

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - there is a problem retrieving information from the property server(s).

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

assetGUIDZoneScan

public List<String> assetGUIDZoneScan(String userId,
                                      String zoneName,
                                      String subTypeGUID,
                                      String subTypeName,
                                      List<String> suppliedSupportedZones,
                                      int startFrom,
                                      int pageSize,
                                      String methodName)
                               throws InvalidParameterException,
                                      PropertyServerException,
                                      UserNotAuthorizedException

Scan through the repository looking for assets by type and/or zone. The type name may be null which means, all types of assets will be returned. The zone name may be null which means all supportedZones for the service are returned.

Parameters:: userId - calling user; zoneName - name of zone to scan; subTypeGUID - type of asset to scan for (null for all asset types); subTypeName - type of asset to scan for (null for all asset types); suppliedSupportedZones - list of supported zones from calling service; startFrom - scan pointer; pageSize - maximum number of results; methodName - calling method
Returns:: list of GUIDs for matching assets
Throws:: InvalidParameterException - one of the parameters is null or invalid.; PropertyServerException - there is a problem retrieving information from the property server(s).; UserNotAuthorizedException - the requesting user is not authorized to issue this request.

findAssetsByName
```
public List findAssetsByName(String userId,
 String typeGUID,
 String typeName,
 String name,
 String nameParameterName,
 int startFrom,
 int pageSize,
 String methodName)
 throws InvalidParameterException,
 PropertyServerException,
 UserNotAuthorizedException
```
Return a list of assets with the requested name in either the display name or qualified name. The match must be exact. SupportedZones set up for this service is used.

Parameters:

userId - calling user

typeGUID - unique identifier of the asset type to search for (null for the generic Asset type)

typeName - unique identifier of the asset type to search for (null for the generic Asset type)

name - name to search for - this is a regular expression (RegEx)

nameParameterName - property that provided the name

startFrom - starting element (used in paging through large result sets)

pageSize - maximum number of results to return

methodName - calling method

Returns:

list of B beans

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - there is a problem retrieving information from the property server(s).

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

findAssetsByName

public List<B> findAssetsByName(String userId,
                                String typeGUID,
                                String typeName,
                                String name,
                                String nameParameterName,
                                List<String> serviceSupportedZones,
                                int startFrom,
                                int pageSize,
                                String methodName)
                         throws InvalidParameterException,
                                PropertyServerException,
                                UserNotAuthorizedException

Return a list of assets with the requested name in either the display name or qualified name.

Parameters:: userId - calling user; typeGUID - unique identifier of the asset type to search for (null for the generic Asset type); typeName - unique identifier of the asset type to search for (null for the generic Asset type); name - name to search for - this is a regular expression (RegEx); nameParameterName - property that provided the name; serviceSupportedZones - list of supported zones for this service; startFrom - starting element (used in paging through large result sets); pageSize - maximum number of results to return; methodName - calling method
Returns:: list of B beans
Throws:: InvalidParameterException - one of the parameters is null or invalid.; PropertyServerException - there is a problem retrieving information from the property server(s).; UserNotAuthorizedException - the requesting user is not authorized to issue this request.

getAssetGUIDsByName
```
public List<String> getAssetGUIDsByName(String userId,
 String typeGUID,
 String typeName,
 String name,
 String nameParameterName,
 int startFrom,
 int pageSize,
 String methodName)
 throws InvalidParameterException,
 PropertyServerException,
 UserNotAuthorizedException
```
Return a list of assets with the requested name in either the display name or qualified name. The match must be exact. SupportedZones set up for this service is used.

Parameters:

userId - calling user

typeGUID - unique identifier of the asset type to search for (null for the generic Asset type)

typeName - unique identifier of the asset type to search for (null for the generic Asset type)

name - name to search for - this must be an exact match either on the display name or the qualified name

nameParameterName - property that provided the name

startFrom - starting element (used in paging through large result sets)

pageSize - maximum number of results to return

methodName - calling method

Returns:

list of B beans

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - there is a problem retrieving information from the property server(s).

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

getAssetGUIDsByName

public List<String> getAssetGUIDsByName(String userId,
                                        String typeGUID,
                                        String typeName,
                                        String name,
                                        String nameParameterName,
                                        List<String> serviceSupportedZones,
                                        int startFrom,
                                        int pageSize,
                                        String methodName)
                                 throws InvalidParameterException,
                                        PropertyServerException,
                                        UserNotAuthorizedException

Return a list of assets with the requested name in either the display name or qualified name. The match must be exact.

Parameters:: userId - calling user; typeGUID - unique identifier of the asset type to search for (null for the generic Asset type); typeName - unique identifier of the asset type to search for (null for the generic Asset type); name - name to search for; nameParameterName - property that provided the name; serviceSupportedZones - list of supported zones for this service; startFrom - starting element (used in paging through large result sets); pageSize - maximum number of results to return; methodName - calling method
Returns:: list of B beans
Throws:: InvalidParameterException - one of the parameters is null or invalid.; PropertyServerException - there is a problem retrieving information from the property server(s).; UserNotAuthorizedException - the requesting user is not authorized to issue this request.

getAssetsByName
```
public List getAssetsByName(String userId,
 String typeGUID,
 String typeName,
 String name,
 String nameParameterName,
 int startFrom,
 int pageSize,
 String methodName)
 throws InvalidParameterException,
 PropertyServerException,
 UserNotAuthorizedException
```
Return a list of assets with the requested name in either the display name or qualified name. The match must be exact. SupportedZones set up for this service is used.

Parameters:

userId - calling user

typeGUID - unique identifier of the asset type to search for (null for the generic Asset type)

typeName - unique identifier of the asset type to search for (null for the generic Asset type)

name - name to search for

nameParameterName - property that provided the name

startFrom - starting element (used in paging through large result sets)

pageSize - maximum number of results to return

methodName - calling method

Returns:

list of B beans

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - there is a problem retrieving information from the property server(s).

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

getAssetsByName
```
public List getAssetsByName(String userId,
 String typeGUID,
 String typeName,
 String name,
 String nameParameterName,
 List<String> serviceSupportedZones,
 int startFrom,
 int pageSize,
 String methodName)
 throws InvalidParameterException,
 PropertyServerException,
 UserNotAuthorizedException
```
Return a list of assets with the requested name in either the display name or qualified name. The match must be exact.

Parameters:

userId - calling user

typeGUID - unique identifier of the asset type to search for (null for the generic Asset type)

typeName - unique identifier of the asset type to search for (null for the generic Asset type)

name - name to search for - this must be an exact match on the display name or qualified name

nameParameterName - property that provided the name

serviceSupportedZones - list of supported zones for this service

startFrom - starting element (used in paging through large result sets)

pageSize - maximum number of results to return

methodName - calling method

Returns:

list of B beans

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - there is a problem retrieving information from the property server(s).

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

getAssetGUIDsByEndpoint

public List<String> getAssetGUIDsByEndpoint(String userId,
                                            String networkAddress,
                                            String networkAddressParameterName,
                                            int startFrom,
                                            int pageSize,
                                            String methodName)
                                     throws InvalidParameterException,
                                            PropertyServerException,
                                            UserNotAuthorizedException

Return the list of assets that have the same endpoint address.

Parameters:: userId - calling user; networkAddress - address to query on; networkAddressParameterName - parameter name supplying networkAddress; startFrom - place to start in query; pageSize - number of results to return; methodName - calling method
Returns:: list of unique identifiers for matching assets
Throws:: InvalidParameterException - the networkAddress is invalid; PropertyServerException - there is a problem access in the property server; UserNotAuthorizedException - the user does not have access to the properties

getAssetsByEndpoint

public List<B> getAssetsByEndpoint(String userId,
                                   String networkAddress,
                                   String networkAddressParameterName,
                                   String suppliedTypeName,
                                   int startFrom,
                                   int pageSize,
                                   String methodName)
                            throws InvalidParameterException,
                                   PropertyServerException,
                                   UserNotAuthorizedException

Return the list of assets that have the same endpoint address.

Parameters:: userId - calling user; networkAddress - address to query on; networkAddressParameterName - name of parameter passing the network address; suppliedTypeName - name of asset subtype to validate; startFrom - place to start in query; pageSize - number of results to return; methodName - calling method
Returns:: list of matching assets
Throws:: InvalidParameterException - the networkAddress is invalid; PropertyServerException - there is a problem access in the property server; UserNotAuthorizedException - the user does not have access to the properties

findAssetGUIDs

public List<String> findAssetGUIDs(String userId,
                                   String searchString,
                                   String searchStringParameter,
                                   int startFrom,
                                   int pageSize,
                                   String methodName)
                            throws InvalidParameterException,
                                   PropertyServerException,
                                   UserNotAuthorizedException

Return a list of assets with the requested search string in their name, qualified name or description.

Parameters:: userId - calling user; searchString - string to search for in text; searchStringParameter - name of parameter supplying the search string; startFrom - starting element (used in paging through large result sets); pageSize - maximum number of results to return; methodName - calling method
Returns:: list of unique identifiers for assets that match the search string.
Throws:: InvalidParameterException - the searchString is invalid; PropertyServerException - there is a problem access in the property server; UserNotAuthorizedException - the user does not have access to the properties

findAssetGUIDs

public List<String> findAssetGUIDs(String userId,
                                   String typeGUID,
                                   String typeName,
                                   String searchString,
                                   String searchStringParameter,
                                   int startFrom,
                                   int pageSize,
                                   String methodName)
                            throws InvalidParameterException,
                                   PropertyServerException,
                                   UserNotAuthorizedException

Return a list of assets with the requested search string in their name, qualified name or description.

Parameters:: userId - calling user; typeGUID - unique identifier of the asset type to search for - null for generic Asset; typeName - unique name of the asset type to search for - null for generic Asset; searchString - string to search for in text; searchStringParameter - parameter providing search string; startFrom - starting element (used in paging through large result sets); pageSize - maximum number of results to return; methodName - calling method
Returns:: list of unique identifiers for assets that match the search string.
Throws:: InvalidParameterException - the searchString is invalid; PropertyServerException - there is a problem access in the property server; UserNotAuthorizedException - the user does not have access to the properties

findAssets
```
public List findAssets(String userId,
 String searchString,
 String searchStringParameter,
 int startFrom,
 int pageSize,
 String methodName)
 throws InvalidParameterException,
 PropertyServerException,
 UserNotAuthorizedException
```
Return a list of assets with the requested search string in their name, qualified name or description.

Parameters:

userId - calling user

searchString - string to search for in text

searchStringParameter - parameter providing search string

startFrom - starting element (used in paging through large result sets)

pageSize - maximum number of results to return

methodName - calling method

Returns:

list of assets that match the search string.

Throws:

InvalidParameterException - the searchString is invalid

PropertyServerException - there is a problem access in the property server

UserNotAuthorizedException - the user does not have access to the properties

findAssets
```
public List findAssets(String userId,
 String typeGUID,
 String typeName,
 String searchString,
 String searchStringParameter,
 int startFrom,
 int pageSize,
 String methodName)
 throws InvalidParameterException,
 PropertyServerException,
 UserNotAuthorizedException
```
Return a list of assets with the requested search string in their name, qualified name or description.

Parameters:

userId - calling user

typeGUID - unique identifier of the asset type to search for

typeName - unique name of the asset type to search for

searchString - string to search for in text

searchStringParameter - parameter providing search string

startFrom - starting element (used in paging through large result sets)

pageSize - maximum number of results to return

methodName - calling method

Returns:

list of assets that match the search string.

Throws:

InvalidParameterException - the searchString is invalid

PropertyServerException - there is a problem access in the property server

UserNotAuthorizedException - the user does not have access to the properties

getAssetGUIDsByTag

public List<String> getAssetGUIDsByTag(String userId,
                                       String tagGUID,
                                       String tagGUIDParameterName,
                                       int startFrom,
                                       int pageSize,
                                       String methodName)
                                throws InvalidParameterException,
                                       PropertyServerException,
                                       UserNotAuthorizedException

Return the list of unique identifiers for assets that are linked to a specific tag either directly, or via one of its schema elements.

Parameters:: userId - the name of the calling user.; tagGUID - unique identifier of tag.; tagGUIDParameterName - name of parameter supplying the GUID; startFrom - index of the list to start from (0 for start); pageSize - maximum number of elements to return.; methodName - calling method
Returns:: asset guid list
Throws:: InvalidParameterException - the userId is null or invalid.; PropertyServerException - there is a problem retrieving information from the property server(s).; UserNotAuthorizedException - the requesting user is not authorized to issue this request.

getAssetsByTag
```
public List getAssetsByTag(String userId,
 String tagGUID,
 String tagGUIDParameterName,
 int startFrom,
 int pageSize,
 String methodName)
 throws InvalidParameterException,
 PropertyServerException,
 UserNotAuthorizedException
```
Return the list of assets that are linked to a specific tag either directly, or via one of its schema elements.

Parameters:

userId - the name of the calling user.

tagGUID - unique identifier of tag.

tagGUIDParameterName - name of parameter supplying the GUID

startFrom - index of the list to start from (0 for start)

pageSize - maximum number of elements to return.

methodName - calling method

Returns:

asset guid list

Throws:

InvalidParameterException - the userId is null or invalid.

PropertyServerException - there is a problem retrieving information from the property server(s).

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

getAssetGUIDsByKeyword

public List<String> getAssetGUIDsByKeyword(String userId,
                                           String keywordGUID,
                                           String keywordGUIDParameterName,
                                           int startFrom,
                                           int pageSize,
                                           String methodName)
                                    throws InvalidParameterException,
                                           PropertyServerException,
                                           UserNotAuthorizedException

Return the list of unique identifiers for assets that are linked to a specific keyword either directly, or via one of its schema elements.

Parameters:: userId - the name of the calling user.; keywordGUID - unique identifier of keyword.; keywordGUIDParameterName - name of parameter supplying the guid; startFrom - index of the list to start from (0 for start); pageSize - maximum number of elements to return.; methodName - calling method
Returns:: asset guid list
Throws:: InvalidParameterException - the userId is null or invalid.; PropertyServerException - there is a problem retrieving information from the property server(s).; UserNotAuthorizedException - the requesting user is not authorized to issue this request.

getAssetsByKeyword

public List<B> getAssetsByKeyword(String userId,
                                  String keywordGUID,
                                  String keywordGUIDParameterName,
                                  int startFrom,
                                  int pageSize,
                                  String methodName)
                           throws InvalidParameterException,
                                  PropertyServerException,
                                  UserNotAuthorizedException

Return the list of assets that are linked to a specific keyword.

Parameters:: userId - the name of the calling user.; keywordGUID - unique identifier of keyword.; keywordGUIDParameterName - name of parameter supplying the guid; startFrom - index of the list to start from (0 for start); pageSize - maximum number of elements to return.; methodName - calling method
Returns:: asset guid list
Throws:: InvalidParameterException - the userId is null or invalid.; PropertyServerException - there is a problem retrieving information from the property server(s).; UserNotAuthorizedException - the requesting user is not authorized to issue this request.

getAssetsByGlossaryTerm

public List<B> getAssetsByGlossaryTerm(String userId,
                                       String termGUID,
                                       String termGUIDParameterName,
                                       int startFrom,
                                       int pageSize,
                                       String methodName)
                                throws InvalidParameterException,
                                       PropertyServerException,
                                       UserNotAuthorizedException

Return the list of assets that are linked to a specific glossary term.

Parameters:: userId - the name of the calling user.; termGUID - unique identifier of term.; termGUIDParameterName - name of parameter supplying the guid; startFrom - index of the list to start from (0 for start); pageSize - maximum number of elements to return.; methodName - calling method
Returns:: asset guid list
Throws:: InvalidParameterException - the userId is null or invalid.; PropertyServerException - there is a problem retrieving information from the property server(s).; UserNotAuthorizedException - the requesting user is not authorized to issue this request.

Class AssetHandler<B>

Field Summary

Fields inherited from class org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIGenericHandler

Constructor Summary

Method Summary

Methods inherited from class org.odpi.openmetadata.commonservices.generichandlers.ReferenceableHandler

Methods inherited from class org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIGenericHandler

Methods inherited from class java.lang.Object

Constructor Detail

AssetHandler

Method Detail

getTypesOfAssetList

getTypesOfAssetDescriptions

attachSchemaTypeToAsset

removeAssociatedSchemaType

detachSchemaTypeFromAsset

saveSemanticAssignments

addAssetFromTemplate

createAssetInRepository

updateAsset

updateAssetWithConnection

classifyAssetAsReferenceData

declassifyAssetAsReferenceData

addAssetOrigin

removeAssetOrigin

publishAsset

withdrawAsset

updateAssetZones

updateAssetOwner

getAssetForConnection

getAssetForConnectionName

getAssetWithConnection

getAssetByNameWithConnection

getAllAssetsWithConnection

assetGUIDsScan

assetGUIDsScan

assetScan

assetScan

assetZoneScan

assetGUIDZoneScan

findAssetsByName

findAssetsByName

getAssetGUIDsByName

getAssetGUIDsByName

getAssetsByName

getAssetsByName

getAssetGUIDsByEndpoint

getAssetsByEndpoint

findAssetGUIDs

findAssetGUIDs

findAssets

findAssets

getAssetGUIDsByTag

getAssetsByTag

getAssetGUIDsByKeyword

getAssetsByKeyword

getAssetsByGlossaryTerm