AssetHandler (OCF Metadata Management Server-side Handlers 1.7 API)

java.lang.Object
- org.odpi.openmetadata.commonservices.ocf.metadatamanagement.handlers.AssetHandler

```
public class AssetHandler
extends Object
```
AssetHandler manages Asset 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
Modifier and Type Field and Description

protected List<String> defaultZones

protected List<String> supportedZones

Fields
Modifier and Type	Field and Description
`protected List<String>`	`defaultZones`
`protected List<String>`	`supportedZones`

Constructor Summary

Constructors
Constructor and Description
AssetHandler(String serviceName, String serverName, String localServerUserId, InvalidParameterHandler invalidParameterHandler, RepositoryHandler repositoryHandler, OMRSRepositoryHelper repositoryHelper, CertificationHandler certificationHandler, CommentHandler commentHandler, ConnectionHandler connectionHandler, EndpointHandler endpointHandler, ExternalIdentifierHandler externalIdentifierHandler, ExternalReferenceHandler externalReferenceHandler, InformalTagHandler informalTagHandler, LicenseHandler licenseHandler, LikeHandler likeHandler, LocationHandler locationHandler, NoteLogHandler noteLogHandler, RatingHandler ratingHandler, RelatedMediaHandler relatedMediaHandler, SchemaTypeHandler schemaTypeHandler, ValidValuesHandler validValuesHandler, List<String> supportedZones, List<String> defaultZones) Construct the asset handler with information needed to work with Asset objects.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`String`	`addAsset(String userId, Asset asset, Connection connection, String methodName)` Create a new Asset object and return its unique identifier (guid).
`String`	`addAsset(String userId, Asset asset, SchemaType schemaType, List<SchemaAttribute> schemaAttributes, Connection connection, String methodName)` Add a simple asset description to the metadata repository.
`String`	`addAsset(String userId, String requestedTypeName, String qualifiedName, String displayName, String description, Map<String,String> additionalProperties, Map<String,Object> extendedProperties, String methodName)` Add a simple asset description to the metadata repository.
`void`	`addAssetOrigin(String userId, String assetGUID, String organizationGUID, String businessCapabilityGUID, Map<String,String> otherOriginValues, String methodName)` Add the asset origin classification to an asset.
`String`	`addCommentReply(String userId, String assetGUID, String attachmentGUID, CommentType commentType, String commentText, boolean isPublic, String methodName)` Adds a comment to another comment.
`String`	`addCommentToAsset(String userId, String assetGUID, CommentType commentType, String commentText, boolean isPublic, String methodName)` Adds a comment to the asset.
`void`	`addLikeToAsset(String userId, String assetGUID, boolean isPublic, String methodName)` Adds a "Like" to the asset.
`void`	`addRatingToAsset(String userId, String assetGUID, StarRating starRating, String review, boolean isPublic, String methodName)` Adds a star rating and optional review text to the asset.
`void`	`addSecurityTags(String userId, String assetGUID, List<String> securityLabels, Map<String,Object> securityProperties, String methodName)` Add or replace the security tags for an asset or one of its elements.
`void`	`addSecurityTags(String userId, String assetGUID, String assetElementGUID, List<String> securityLabels, Map<String,Object> securityProperties, String methodName)` Add or replace the security tags for an asset or one of its elements.
`void`	`addTagToAsset(String userId, String assetGUID, String tagGUID, boolean isPublic, String methodName)` Adds a tag (either private of public) 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<Asset>`	`assetScan(String userId, String subTypeGUID, String subTypeName, int startFrom, int pageSize, String methodName)` Scan through the repository looking for assets by type.
`List<Asset>`	`assetZoneScan(String userId, String zoneName, String subTypeGUID, String subTypeName, int startFrom, int pageSize, String methodName)` Scan through the repository looking for assets by type and/or zone.
`void`	`classifyAssetAsReferenceData(String userId, String assetGUID, List<String> supportedZones, String methodName)` Add the ReferenceData classification to an asset.
`Asset`	`createEmptyAsset(String requestedTypeName, String methodName)` Create an empty asset bean with its header filled out with the correct type information.
`Asset`	`createEmptyExternalAsset(String assetTypeName, ElementOrigin elementOrigin, String externalSourceGUID, String externalSourceName, String methodName)` Create an empty asset bean with its header filled out with the correct type information and origin information.
`void`	`declassifyAssetAsReferenceData(String userId, String assetGUID, List<String> supportedZones, String methodName)` Remove the ReferenceData classification form an Asset.
`List<String>`	`findAssetGUIDs(String userId, String searchString, int startFrom, int pageSize, String methodName)` Return a list of assets with the requested search string in their name, qualified name or description.
`List<Asset>`	`findAssets(String userId, String searchString, int startFrom, int pageSize, String methodName)` Return a list of assets with the requested search string in their name, qualified name or description.
`Asset`	`getAssetBean(String userId, String assetGUID, String methodName)` Retrieve the requested asset object as long as it is visible to the user.
`List<Comment>`	`getAssetComments(String userId, List<String> supportedZones, String assetGUID, String anchorGUID, int startingFrom, int pageSize, String methodName)` Return the comments attached to an anchor entity.
`String`	`getAssetForConnection(String userId, String connectionGUID)` Returns the unique identifier for the asset connected to the requested connection.
`String`	`getAssetForConnectionName(String userId, String connectionName, String methodName)` Returns the asset corresponding to the supplied connection name.
`List<String>`	`getAssetGUIDsByEndpoint(String userId, String networkAddress, int startFrom, int pageSize, String methodName)` Return the list of assets that have the same endpoint address.
`List<String>`	`getAssetGUIDsByName(String userId, String name, int startFrom, int pageSize, String methodName)` Return a list of assets with the requested name.
`List<String>`	`getAssetGUIDsByQualifiedName(String userId, String name, int startFrom, int pageSize, String methodName)` Return a list of assets with the requested name.
`List<Asset>`	`getAssetsByEndpoint(String userId, String networkAddress, int startFrom, int pageSize, String methodName)` Return the list of assets that have the same endpoint address.
`List<String>`	`getAssetsByMeaning(String userId, String termGUID, int startFrom, int pageSize, String methodName)` Return the list of unique identifiers for assets that are linked to a specific (meaning) either directly or via fields in the schema.
`List<Asset>`	`getAssetsByName(String userId, String name, int startFrom, int pageSize, String methodName)` Return a list of assets with the requested name.
`List<Asset>`	`getAssetsByQualifiedName(String userId, String name, int startFrom, int pageSize, String methodName)` Return a list of assets with the requested name.
`List<String>`	`getAssetsByTag(String userId, String tagGUID, 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.
`int`	`getCertificationCount(String userId, String anchorGUID, String methodName)` Return the count of attached certifications.
`int`	`getCommentCount(String userId, String anchorGUID, String methodName)` Return the count of attached comments.
`int`	`getConnectionCount(String userId, String anchorGUID, String methodName)` Return the count of connections for the asset.
`Connection`	`getConnectionForAsset(String userId, String assetGUID)` Retrieve the connection object attached to the requested asset object.
`List<Connection>`	`getConnectionsForAsset(String userId, String assetGUID)` Retrieve the list of connection objects attached to the requested asset object.
`int`	`getExternalIdentifierCount(String userId, String anchorGUID, String methodName)` Return the count of external identifiers for this asset.
`int`	`getExternalReferencesCount(String userId, String anchorGUID, String methodName)` Return the count of attached external references.
`int`	`getInformalTagCount(String userId, String anchorGUID, String methodName)` Return the count of attached informal tags.
`int`	`getKnownLocationsCount(String userId, String anchorGUID, String methodName)` Return the count of known locations.
`int`	`getLicenseCount(String userId, String anchorGUID, String methodName)` Return the count of license for this asset.
`int`	`getLikeCount(String userId, String anchorGUID, String methodName)` Return the number of likes for the asset.
`int`	`getNoteLogsCount(String userId, String anchorGUID, String methodName)` Return the count of attached note logs.
`int`	`getRatingsCount(String userId, String anchorGUID, String methodName)` Return the count of attached ratings.
`int`	`getRelatedAssetCount(String userId, String anchorGUID, String methodName)` Return the count of related assets.
`List<RelatedAsset>`	`getRelatedAssets(String userId, List<String> supportedZones, String anchorGUID, int startFrom, int pageSize, String serviceName, String methodName)` Return all the assets attached to an anchor asset.
`List<RelatedAsset>`	`getRelatedAssets(String userId, List<String> supportedZones, String anchorGUID, String relationshipTypeGUID, String relationshipTypeName, int startFrom, int pageSize, String serviceName, String methodName)` Return the assets attached to an anchor asset by the specified relationship type.
`int`	`getRelatedMediaReferenceCount(String userId, String anchorGUID, String methodName)` Return the count of related media references.
`SchemaType`	`getSchemaType(String userId, String anchorGUID, String methodName)` Is there an attached schema for this asset?
`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.
`Asset`	`getValidatedVisibleAsset(String userId, List<String> supportedZones, Relationship assetConnectionRelationship, String serviceName, String methodName)` Retrieve the requested asset object.
`Asset`	`getValidatedVisibleAsset(String userId, List<String> supportedZones, String assetGUID, String serviceName, String methodName)` Retrieve the requested asset object as long as it is visible to the user - the UserNotAuthorizedException exception is thrown if it is not visible.
`Asset`	`getValidatedVisibleAsset(String userId, List<String> supportedZones, String assetGUID, String connectionGUID, String serviceName, String methodName)` Retrieve the requested asset object.
`List<ValidValueImplementationDefinition>`	`getValidValuesImplementationDefinitions(String userId, String assetGUID, List<String> supportedZones, int startFrom, int pageSize, String methodName)` Page through the list of valid values used to maintain the contents of a asset.
`void`	`reclassifyAsset(String userId, Asset originalAsset, Asset updatedAsset, InstanceProperties zoneMembershipProperties, InstanceProperties ownerProperties, InstanceProperties originProperties, String methodName)` Reclassifies an asset based on the new properties.
`void`	`reclassifyAsset(String userId, Asset originalAsset, Asset updatedAsset, InstanceProperties zoneMembershipProperties, InstanceProperties ownerProperties, String methodName)` Deprecated.
`void`	`removeAsset(String userId, String assetGUID, String methodName)` Remove the requested Asset.
`void`	`removeAssetComment(String userId, String assetGUID, String commentGUID, String methodName)` Removes a comment added to the asset by this user.
`void`	`removeAssetOrigin(String userId, String assetGUID, String methodName)` Remove the asset origin classification to an asset.
`void`	`removeLikeFromAsset(String userId, String assetGUID, String methodName)` Removes a "Like" added to the asset by this user.
`void`	`removeRatingFromAsset(String userId, String assetGUID, String methodName)` Removes of a review that was added to the asset by this user.
`void`	`removeSecurityTags(String userId, String assetGUID, String methodName)` Remove the security tags classification to an asset or one of its elements.
`void`	`removeSecurityTags(String userId, String assetGUID, String assetElementGUID, String methodName)` Remove the security tags classification to an asset or one of its elements.
`void`	`removeSemanticAssignment(String userId, String assetGUID, String glossaryTermGUID, String methodName)` Remove the relationship between a glossary term and an element in an Asset description (typically a field in the schema).
`void`	`removeSemanticAssignment(String userId, String assetGUID, String glossaryTermGUID, String assetElementGUID, String methodName)` Remove the relationship between a glossary term and an element in an Asset description (typically a field in the schema).
`void`	`removeTagFromAsset(String userId, String assetGUID, String tagGUID, String methodName)` Removes a tag from the asset that was added by this user.
`void`	`saveAssociatedConnection(String userId, String assetGUID, String assetSummary, Connection connection, String methodName)` Save any associated Connection.
`void`	`saveAssociatedSchemaType(String userId, String assetGUID, SchemaType schemaType, List<SchemaAttribute> schemaAttributes, String methodName)` Save any associated schema type.
`void`	`saveSemanticAssignment(String userId, String assetGUID, String glossaryTermGUID, String methodName)` Create a simple relationship between a glossary term and an element in an Asset description (typically an attribute in the schema).
`void`	`saveSemanticAssignment(String userId, String assetGUID, String glossaryTermGUID, String assetElementGUID, String methodName)` Create a simple relationship between a glossary term and an element in an Asset description (typically an attribute in the schema).
`void`	`setSecurityVerifier(OpenMetadataServerSecurityVerifier securityVerifier)` Set up a new security verifier (the handler runs with a default verifier until this method is called).
`String`	`updateAsset(String userId, Asset originalAsset, AssetAuditHeader originalAssetAuditHeader, Asset updatedAsset, SchemaType schemaType, List<SchemaAttribute> schemaAttributes, Connection connection, String methodName)` Update a stored asset.
`void`	`updateAssetComment(String userId, String assetGUID, String commentGUID, CommentType commentType, String commentText, boolean isPublic, String methodName)` Update an existing comment.
`void`	`updateAssetOwner(String userId, String assetGUID, String ownerId, OwnerType ownerType, String methodName)` Update the owner information for a specific asset.
`void`	`updateAssetZones(String userId, String assetGUID, List<String> assetZones, String methodName)` Update the zones for a specific asset.
`protected Asset`	`validatedVisibleAsset(String userId, List<String> supportedZones, String guidParameterName, Asset retrievedAsset, String serviceName, String methodName)` Determine if an asset is visible.
`protected Referenceable`	`validatedVisibleReferenceable(String userId, List<String> supportedZones, String guidParameterName, EntityDetail retrievedEntity, String serviceName, String methodName)` Determine if the retrieved entity is for an asset and if so, is it visible?.
`void`	`validateUserForAssetAttachmentUpdate(String userId, String assetGUID, String methodName)` Validate that the user is able to make changes to the a.

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

Field Detail

supportedZones
```
protected List<String> supportedZones
```

defaultZones
```
protected List<String> defaultZones
```

Constructor Detail

AssetHandler

public AssetHandler(String serviceName,
                    String serverName,
                    String localServerUserId,
                    InvalidParameterHandler invalidParameterHandler,
                    RepositoryHandler repositoryHandler,
                    OMRSRepositoryHelper repositoryHelper,
                    CertificationHandler certificationHandler,
                    CommentHandler commentHandler,
                    ConnectionHandler connectionHandler,
                    EndpointHandler endpointHandler,
                    ExternalIdentifierHandler externalIdentifierHandler,
                    ExternalReferenceHandler externalReferenceHandler,
                    InformalTagHandler informalTagHandler,
                    LicenseHandler licenseHandler,
                    LikeHandler likeHandler,
                    LocationHandler locationHandler,
                    NoteLogHandler noteLogHandler,
                    RatingHandler ratingHandler,
                    RelatedMediaHandler relatedMediaHandler,
                    SchemaTypeHandler schemaTypeHandler,
                    ValidValuesHandler validValuesHandler,
                    List<String> supportedZones,
                    List<String> defaultZones)

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

Parameters:: serviceName - name of this service; serverName - name of the local server; localServerUserId - name of the userId for system initiated updates to assets.; invalidParameterHandler - handler for managing parameter errors; repositoryHandler - handler for interfacing with the repository services; repositoryHelper - helper utilities for managing repository services objects; certificationHandler - handler for certification objects; commentHandler - handler for comment objects; connectionHandler - handler for connection objects; endpointHandler - handler for endpoint objects; externalIdentifierHandler - handler for external identifier objects; externalReferenceHandler - handler for external reference objects; informalTagHandler - handler for informal tag objects; licenseHandler - handler for license objects; likeHandler - handler for like objects; locationHandler - handler for location objects; noteLogHandler - handler for note log objects; ratingHandler - handler for rating objects; relatedMediaHandler - handler for related media objects; schemaTypeHandler - handler for schemaType objects; validValuesHandler - handler for valid values and reference data objects; supportedZones - list of zones that DiscoveryEngine is allowed to serve Assets from.; defaultZones - list of zones that DiscoveryEngine should set in all new Assets.

Method Detail

setSecurityVerifier
```
public void setSecurityVerifier(OpenMetadataServerSecurityVerifier securityVerifier)
```
Set up a new security verifier (the handler runs with a default verifier until this method is called). The security verifier provides authorization checks for access and maintenance changes to open metadata. Authorization checks are enabled through the OpenMetadataServerSecurityConnector.

Parameters:

securityVerifier - new security verifier

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

createEmptyAsset
```
public Asset createEmptyAsset(String requestedTypeName,
                              String methodName)
                       throws InvalidParameterException
```
Create an empty asset bean with its header filled out with the correct type information. This bean can then be used with saveAsset() once the qualified name is filled in.

Parameters:

requestedTypeName - name of the asset's type (see AssetMapper)

methodName - calling method

Returns:

empty asset bean

Throws:

InvalidParameterException - bad typeName

createEmptyExternalAsset
```
public Asset createEmptyExternalAsset(String assetTypeName,
                                      ElementOrigin elementOrigin,
                                      String externalSourceGUID,
                                      String externalSourceName,
                                      String methodName)
                               throws InvalidParameterException
```
Create an empty asset bean with its header filled out with the correct type information and origin information. This bean can then be used with saveAsset() once the qualified name is filled in.

Parameters:

assetTypeName - name of the asset's type (see AssetMapper)

elementOrigin - type of origin

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

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

methodName - calling method

Returns:

empty asset bean

Throws:

InvalidParameterException - bad typeName

saveAssociatedConnection

public void saveAssociatedConnection(String userId,
                                     String assetGUID,
                                     String assetSummary,
                                     Connection connection,
                                     String methodName)
                              throws InvalidParameterException,
                                     PropertyServerException,
                                     UserNotAuthorizedException

Save any associated Connection.

Parameters:: userId - calling user; assetGUID - unique identifier of the asset; assetSummary - short description of the asset; connection - connection object or null; methodName - calling method
Throws:: InvalidParameterException - the bean properties are invalid; UserNotAuthorizedException - user not authorized to issue this request; PropertyServerException - problem accessing the property server

saveAssociatedSchemaType

public void saveAssociatedSchemaType(String userId,
                                     String assetGUID,
                                     SchemaType schemaType,
                                     List<SchemaAttribute> schemaAttributes,
                                     String methodName)
                              throws InvalidParameterException,
                                     PropertyServerException,
                                     UserNotAuthorizedException

Save any associated schema type.

Parameters:: userId - calling user; assetGUID - unique identifier of the asset; schemaType - schema Type object or null; schemaAttributes - list of nested schema attribute objects or null; methodName - calling method
Throws:: InvalidParameterException - the bean properties are invalid; UserNotAuthorizedException - user not authorized to issue this request; PropertyServerException - problem accessing the property server

validateUserForAssetAttachmentUpdate

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

Validate that the user is able to make changes to the a.

Parameters:: userId - calling user; assetGUID - unique identifier of the asset; methodName - calling method
Throws:: InvalidParameterException - the bean properties are invalid; UserNotAuthorizedException - user not authorized to issue this request; PropertyServerException - problem accessing the property server

saveSemanticAssignment

public void saveSemanticAssignment(String userId,
                                   String assetGUID,
                                   String glossaryTermGUID,
                                   String methodName)
                            throws InvalidParameterException,
                                   PropertyServerException,
                                   UserNotAuthorizedException

Create a simple relationship between a glossary term and an element in an Asset description (typically an attribute in the schema).

Parameters:: userId - calling user; assetGUID - unique identifier of the asset that is being described; glossaryTermGUID - unique identifier of the glossary term; methodName - calling method
Throws:: InvalidParameterException - the guid properties are invalid; UserNotAuthorizedException - user not authorized to issue this request; PropertyServerException - problem accessing the property server

saveSemanticAssignment

public void saveSemanticAssignment(String userId,
                                   String assetGUID,
                                   String glossaryTermGUID,
                                   String assetElementGUID,
                                   String methodName)
                            throws InvalidParameterException,
                                   PropertyServerException,
                                   UserNotAuthorizedException

Create a simple relationship between a glossary term and an element in an Asset description (typically an attribute in the schema).

Parameters:: userId - calling user; assetGUID - unique identifier of the asset that is being described; glossaryTermGUID - unique identifier of the glossary term; assetElementGUID - element to link it to - its type must inherit from Referenceable.; methodName - calling method
Throws:: InvalidParameterException - the guid properties are invalid; UserNotAuthorizedException - user not authorized to issue this request; PropertyServerException - problem accessing the property server

removeSemanticAssignment

public void removeSemanticAssignment(String userId,
                                     String assetGUID,
                                     String glossaryTermGUID,
                                     String assetElementGUID,
                                     String methodName)
                              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 user; assetGUID - unique identifier of asset; glossaryTermGUID - unique identifier of the glossary term; assetElementGUID - element to link it to - its type must inherit from Referenceable.; methodName - calling method
Throws:: InvalidParameterException - one of the parameters is null or invalid; PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

removeSemanticAssignment

public void removeSemanticAssignment(String userId,
                                     String assetGUID,
                                     String glossaryTermGUID,
                                     String methodName)
                              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 user; assetGUID - unique identifier of asset; glossaryTermGUID - unique identifier of the glossary term; methodName - calling method
Throws:: InvalidParameterException - one of the parameters is null or invalid; PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

addAsset

public String addAsset(String userId,
                       String requestedTypeName,
                       String qualifiedName,
                       String displayName,
                       String description,
                       Map<String,String> additionalProperties,
                       Map<String,Object> extendedProperties,
                       String methodName)
                throws InvalidParameterException,
                       UserNotAuthorizedException,
                       PropertyServerException

Add a simple asset description to the metadata repository.

Parameters:: userId - calling user (assumed to be the owner); requestedTypeName - specific type of the asset - this must match a defined subtype; qualifiedName - unique name for the asset in the catalog; displayName - display name for the asset in the catalog; description - description of the asset in the catalog; additionalProperties - user chosen additional properties; extendedProperties - properties for a subtype of asset; methodName - calling method
Returns:: unique identifier (guid) of the asset
Throws:: InvalidParameterException - full path or userId is null; PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

addAsset
```
public String addAsset(String userId,
                       Asset asset,
                       Connection connection,
                       String methodName)
                throws InvalidParameterException,
                       PropertyServerException,
                       UserNotAuthorizedException
```
Create a new Asset object and return its unique identifier (guid). If the connection is supplied, it is connected to the asset.

Parameters:

userId - calling userId

asset - asset properties to add

connection - object to add

methodName - calling method

Returns:

unique identifier of the connection in the repository.

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

addAsset
```
public String addAsset(String userId,
                       Asset asset,
                       SchemaType schemaType,
                       List<SchemaAttribute> schemaAttributes,
                       Connection connection,
                       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

asset - object to add

schemaType - optional object to add

schemaAttributes - optional object to add

connection - optional object to add

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

updateAsset

public String updateAsset(String userId,
                          Asset originalAsset,
                          AssetAuditHeader originalAssetAuditHeader,
                          Asset updatedAsset,
                          SchemaType schemaType,
                          List<SchemaAttribute> schemaAttributes,
                          Connection connection,
                          String methodName)
                   throws InvalidParameterException,
                          PropertyServerException,
                          UserNotAuthorizedException

Update a stored asset.

Parameters:: userId - userId; originalAsset - current content of the asset; originalAssetAuditHeader - details of the asset's audit header; updatedAsset - new asset values; schemaType - optional object to add; schemaAttributes - optional object to add; connection - new connection values; methodName - calling method
Returns:: unique identifier of the connection in the repository.
Throws:: InvalidParameterException - the bean properties are invalid; UserNotAuthorizedException - user not authorized to issue this request; PropertyServerException - problem accessing the property server

classifyAssetAsReferenceData

public void classifyAssetAsReferenceData(String userId,
                                         String assetGUID,
                                         List<String> supportedZones,
                                         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.; supportedZones - list of visible zones.; 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,
                                           List<String> supportedZones,
                                           String methodName)
                                    throws InvalidParameterException,
                                           UserNotAuthorizedException,
                                           PropertyServerException

Remove the ReferenceData classification form 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.; supportedZones - list of visible zones.; 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.

reclassifyAsset

@Deprecated
public void reclassifyAsset(String userId,
                                        Asset originalAsset,
                                        Asset updatedAsset,
                                        InstanceProperties zoneMembershipProperties,
                                        InstanceProperties ownerProperties,
                                        String methodName)
                                 throws UserNotAuthorizedException,
                                        PropertyServerException

Deprecated.

Reclassifies an asset based on the new properties.

Parameters:: userId - userId; originalAsset - current content of the asset; updatedAsset - new asset values; zoneMembershipProperties - zone membership properties; ownerProperties - owner properties; methodName - calling method
Throws:: UserNotAuthorizedException - user not authorized to issue this request; PropertyServerException - problem accessing the property server

reclassifyAsset

public void reclassifyAsset(String userId,
                            Asset originalAsset,
                            Asset updatedAsset,
                            InstanceProperties zoneMembershipProperties,
                            InstanceProperties ownerProperties,
                            InstanceProperties originProperties,
                            String methodName)
                     throws UserNotAuthorizedException,
                            PropertyServerException

Reclassifies an asset based on the new properties.

Parameters:: userId - userId; originalAsset - current content of the asset; updatedAsset - new asset values; zoneMembershipProperties - zone membership properties; ownerProperties - owner properties; originProperties - origin properties; methodName - calling method
Throws:: UserNotAuthorizedException - user not authorized to issue this request; PropertyServerException - problem accessing the property server

addAssetOrigin
```
public void addAssetOrigin(String userId,
                           String assetGUID,
                           String organizationGUID,
                           String businessCapabilityGUID,
                           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

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

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

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 methodName)
                       throws InvalidParameterException,
                              UserNotAuthorizedException,
                              PropertyServerException

Remove the asset origin classification to an asset.

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

updateAssetZones
```
public void updateAssetZones(String userId,
                             String assetGUID,
                             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

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

methodName - calling method

Throws:

InvalidParameterException - guid or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

addSecurityTags

public void addSecurityTags(String userId,
                            String assetGUID,
                            List<String> securityLabels,
                            Map<String,Object> securityProperties,
                            String methodName)
                     throws InvalidParameterException,
                            UserNotAuthorizedException,
                            PropertyServerException

Add or replace the security tags for an asset or one of its elements.

Parameters:: userId - calling user; assetGUID - unique identifier of asset; securityLabels - list of security labels defining the security characteristics of the element; securityProperties - 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

removeSecurityTags

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

Remove the security tags classification to an asset or one of its elements.

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

addSecurityTags

public void addSecurityTags(String userId,
                            String assetGUID,
                            String assetElementGUID,
                            List<String> securityLabels,
                            Map<String,Object> securityProperties,
                            String methodName)
                     throws InvalidParameterException,
                            UserNotAuthorizedException,
                            PropertyServerException

Add or replace the security tags for an asset or one of its elements.

Parameters:: userId - calling user; assetGUID - unique identifier of asset; assetElementGUID - element to link it to - its type must inherit from Referenceable.; securityLabels - list of security labels defining the security characteristics of the element; securityProperties - 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

removeSecurityTags

public void removeSecurityTags(String userId,
                               String assetGUID,
                               String assetElementGUID,
                               String methodName)
                        throws InvalidParameterException,
                               UserNotAuthorizedException,
                               PropertyServerException

Remove the security tags classification to an asset or one of its elements.

Parameters:: userId - calling user; assetGUID - unique identifier of asset; assetElementGUID - element where the security tags need to be removed.; methodName - calling method
Throws:: InvalidParameterException - entity not known, null userId or guid; PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

updateAssetOwner

public void updateAssetOwner(String userId,
                             String assetGUID,
                             String ownerId,
                             OwnerType 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; 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

removeAsset
```
public void removeAsset(String userId,
                        String assetGUID,
                        String methodName)
                 throws InvalidParameterException,
                        PropertyServerException,
                        UserNotAuthorizedException
```
Remove the requested Asset. This also removes any connected Connection objects if they are not connected to any other asset definition. This in turn may ripple down to deleting the endpoints, connector types and any embedded connections that would be left isolated.

Parameters:

userId - calling user

assetGUID - object to delete

methodName - calling method

Throws:

InvalidParameterException - the entity guid is not known

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

validatedVisibleAsset

protected Asset validatedVisibleAsset(String userId,
                                      List<String> supportedZones,
                                      String guidParameterName,
                                      Asset retrievedAsset,
                                      String serviceName,
                                      String methodName)
                               throws InvalidParameterException,
                                      UserNotAuthorizedException,
                                      PropertyServerException

Determine if an asset is visible.

Parameters:: userId - calling user; supportedZones - supported zones; guidParameterName - parameter name for supplied guid; retrievedAsset - retrieved asset; serviceName - calling server; methodName - calling method
Returns:: asset
Throws:: InvalidParameterException - asset is not in the zone; UserNotAuthorizedException - user is not authorized to access the asset.; PropertyServerException - problem managing the supported zones.

validatedVisibleReferenceable

protected Referenceable validatedVisibleReferenceable(String userId,
                                                      List<String> supportedZones,
                                                      String guidParameterName,
                                                      EntityDetail retrievedEntity,
                                                      String serviceName,
                                                      String methodName)
                                               throws InvalidParameterException,
                                                      UserNotAuthorizedException,
                                                      PropertyServerException

Determine if the retrieved entity is for an asset and if so, is it visible?.

Parameters:: userId - calling user; supportedZones - supported zones; guidParameterName - parameter name for supplied guid; retrievedEntity - retrieved asset; serviceName - calling server; methodName - calling method
Returns:: asset
Throws:: InvalidParameterException - asset is not in the zone; UserNotAuthorizedException - user is not authorized to access the asset.; PropertyServerException - problem managing the supported zones.

getAssetBean

public Asset getAssetBean(String userId,
                          String assetGUID,
                          String methodName)
                   throws InvalidParameterException,
                          PropertyServerException,
                          UserNotAuthorizedException

Retrieve the requested asset object as long as it is visible to the user.

Parameters:: userId - calling user; assetGUID - unique identifier of the asset object; methodName - calling method
Returns:: Asset bean
Throws:: InvalidParameterException - the parameters are invalid; UserNotAuthorizedException - user not authorized to issue this request; PropertyServerException - problem accessing the property server

getValidatedVisibleAsset

public Asset getValidatedVisibleAsset(String userId,
                                      List<String> supportedZones,
                                      String assetGUID,
                                      String serviceName,
                                      String methodName)
                               throws InvalidParameterException,
                                      PropertyServerException,
                                      UserNotAuthorizedException

Retrieve the requested asset object as long as it is visible to the user - the UserNotAuthorizedException exception is thrown if it is not visible.

Parameters:: userId - calling user; supportedZones - supported zones; assetGUID - unique identifier of the asset object; serviceName - calling service; methodName - calling method
Returns:: Asset bean
Throws:: InvalidParameterException - the parameters are invalid; UserNotAuthorizedException - user not authorized to issue this request; PropertyServerException - problem accessing the property server

getValidatedVisibleAsset

public Asset getValidatedVisibleAsset(String userId,
                                      List<String> supportedZones,
                                      Relationship assetConnectionRelationship,
                                      String serviceName,
                                      String methodName)
                               throws InvalidParameterException,
                                      PropertyServerException,
                                      UserNotAuthorizedException

Retrieve the requested asset object.

Parameters:: userId - calling user; supportedZones - override the default supported zones.; assetConnectionRelationship - link between the asset and the connection.; serviceName - calling service; methodName - calling method
Returns:: Asset bean
Throws:: InvalidParameterException - the parameters are invalid; UserNotAuthorizedException - user not authorized to issue this request; PropertyServerException - problem accessing the property server

getValidatedVisibleAsset

public Asset getValidatedVisibleAsset(String userId,
                                      List<String> supportedZones,
                                      String assetGUID,
                                      String connectionGUID,
                                      String serviceName,
                                      String methodName)
                               throws InvalidParameterException,
                                      PropertyServerException,
                                      UserNotAuthorizedException

Retrieve the requested asset object.

Parameters:: userId - calling user; supportedZones - override the default supported zones.; assetGUID - unique identifier of the asset object.; connectionGUID - unique identifier of the attached connection object.; serviceName - calling service; methodName - calling method
Returns:: Asset bean
Throws:: InvalidParameterException - the parameters are invalid; UserNotAuthorizedException - user not authorized to issue this request; PropertyServerException - problem accessing the property server

getConnectionForAsset

public Connection getConnectionForAsset(String userId,
                                        String assetGUID)
                                 throws InvalidParameterException,
                                        PropertyServerException,
                                        UserNotAuthorizedException

Retrieve the connection object attached to the requested asset object. This call assumes there is only one connection

Parameters:: userId - calling user; assetGUID - unique identifier of the asset object.
Returns:: Connection bean
Throws:: InvalidParameterException - the parameters are invalid; UserNotAuthorizedException - user not authorized to issue this request; PropertyServerException - problem accessing the property server

getValidValuesImplementationDefinitions

public List<ValidValueImplementationDefinition> getValidValuesImplementationDefinitions(String userId,
                                                                                        String assetGUID,
                                                                                        List<String> supportedZones,
                                                                                        int startFrom,
                                                                                        int pageSize,
                                                                                        String methodName)
                                                                                 throws InvalidParameterException,
                                                                                        UserNotAuthorizedException,
                                                                                        PropertyServerException

Page through the list of valid values used to maintain the contents of a asset.

Parameters:: userId - calling user.; assetGUID - unique identifier of asset to query; supportedZones - list of zones that the asset must belong to one of; startFrom - paging starting point; pageSize - maximum number of return values.; methodName - calling method
Returns:: list of valid value beans
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.

getConnectionsForAsset

public List<Connection> getConnectionsForAsset(String userId,
                                               String assetGUID)
                                        throws InvalidParameterException,
                                               PropertyServerException,
                                               UserNotAuthorizedException

Retrieve the list of connection objects attached to the requested asset object.

Parameters:: userId - calling user; assetGUID - unique identifier of the asset object.
Returns:: Connection bean
Throws:: InvalidParameterException - the parameters are invalid; UserNotAuthorizedException - user not authorized to issue this request; PropertyServerException - problem accessing the property server

getAssetForConnection
```
public String getAssetForConnection(String userId,
                                    String connectionGUID)
                             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.

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

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.

assetScan
```
public List<Asset> 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.

assetZoneScan

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

Scan through the repository looking for assets by type and/or zone. The zone and/or type name may be null which means, all assets will be 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); 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.

getAssetGUIDsByQualifiedName

public List<String> getAssetGUIDsByQualifiedName(String userId,
                                                 String name,
                                                 int startFrom,
                                                 int pageSize,
                                                 String methodName)
                                          throws InvalidParameterException,
                                                 PropertyServerException,
                                                 UserNotAuthorizedException

Return a list of assets with the requested name.

Parameters:: userId - calling user; name - name to search for; 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 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.

getAssetsByQualifiedName

public List<Asset> getAssetsByQualifiedName(String userId,
                                            String name,
                                            int startFrom,
                                            int pageSize,
                                            String methodName)
                                     throws InvalidParameterException,
                                            PropertyServerException,
                                            UserNotAuthorizedException

Return a list of assets with the requested name.

Parameters:: userId - calling user; name - name to search for; startFrom - starting element (used in paging through large result sets); pageSize - maximum number of results to return; methodName - calling method
Returns:: list of Asset summaries
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 name,
                                        int startFrom,
                                        int pageSize,
                                        String methodName)
                                 throws InvalidParameterException,
                                        PropertyServerException,
                                        UserNotAuthorizedException

Return a list of assets with the requested name.

Parameters:: userId - calling user; name - name to search for; 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 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.

getAssetsByName

public List<Asset> getAssetsByName(String userId,
                                   String name,
                                   int startFrom,
                                   int pageSize,
                                   String methodName)
                            throws InvalidParameterException,
                                   PropertyServerException,
                                   UserNotAuthorizedException

Return a list of assets with the requested name.

Parameters:: userId - calling user; name - name to search for; startFrom - starting element (used in paging through large result sets); pageSize - maximum number of results to return; methodName - calling method
Returns:: list of Asset summaries
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,
                                            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; 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<Asset> getAssetsByEndpoint(String userId,
                                       String networkAddress,
                                       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; 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,
                                   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

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<Asset> findAssets(String userId,
                              String searchString,
                              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

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

getCertificationCount

public int getCertificationCount(String userId,
                                 String anchorGUID,
                                 String methodName)
                          throws InvalidParameterException,
                                 PropertyServerException,
                                 UserNotAuthorizedException

Return the count of attached certifications.

Parameters:: userId - calling user; anchorGUID - identifier for the entity that the object is attached to; methodName - calling method
Returns:: unique identifier of the object or null
Throws:: InvalidParameterException - the endpoint bean properties are invalid; UserNotAuthorizedException - user not authorized to issue this request; PropertyServerException - problem accessing the property server

getCommentCount
```
public int getCommentCount(String userId,
                           String anchorGUID,
                           String methodName)
                    throws InvalidParameterException,
                           PropertyServerException,
                           UserNotAuthorizedException
```
Return the count of attached comments.

Parameters:

userId - calling user

anchorGUID - identifier for the entity that the object is attached to

methodName - calling method

Returns:

unique identifier of the object or null

Throws:

InvalidParameterException - the endpoint bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

getAssetComments

public List<Comment> getAssetComments(String userId,
                                      List<String> supportedZones,
                                      String assetGUID,
                                      String anchorGUID,
                                      int startingFrom,
                                      int pageSize,
                                      String methodName)
                               throws InvalidParameterException,
                                      PropertyServerException,
                                      UserNotAuthorizedException

Return the comments attached to an anchor entity.

Parameters:: userId - calling user; supportedZones - list of zones if different from the default set in the handler; assetGUID - identifier for the asset that this comment is chained from; anchorGUID - identifier for the entity that the feedback is attached to - ie this asset or a comment chained off of this asset; startingFrom - where to start from in the list; pageSize - maximum number of results that can be returned; methodName - calling method
Returns:: list of retrieved objects
Throws:: InvalidParameterException - the input properties are invalid; UserNotAuthorizedException - user not authorized to issue this request; PropertyServerException - problem accessing the property server

addCommentToAsset

public String addCommentToAsset(String userId,
                                String assetGUID,
                                CommentType commentType,
                                String commentText,
                                boolean isPublic,
                                String methodName)
                         throws InvalidParameterException,
                                PropertyServerException,
                                UserNotAuthorizedException

Adds a comment to the asset.

Parameters:: userId - userId of user making request.; assetGUID - unique identifier for the asset.; commentType - type of comment enum.; commentText - the text of the comment.; isPublic - indicates whether the feedback should be shared or only be visible to the originating user; methodName - calling method
Returns:: guid of new comment.
Throws:: InvalidParameterException - one of the parameters is null or invalid.; PropertyServerException - there is a problem adding the asset properties to the property server.; UserNotAuthorizedException - the requesting user is not authorized to issue this request.

updateAssetComment

public void updateAssetComment(String userId,
                               String assetGUID,
                               String commentGUID,
                               CommentType commentType,
                               String commentText,
                               boolean isPublic,
                               String methodName)
                        throws InvalidParameterException,
                               PropertyServerException,
                               UserNotAuthorizedException

Update an existing comment.

Parameters:: userId - userId of user making request.; assetGUID - unique identifier for the anchor entity; commentGUID - unique identifier for the comment to change.; commentType - type of comment enum.; commentText - the text of the comment.; isPublic - indicates whether the feedback should be shared or only be visible to the originating user; methodName - calling method
Throws:: InvalidParameterException - one of the parameters is null or invalid.; PropertyServerException - there is a problem adding the asset properties to the property server.; UserNotAuthorizedException - the requesting user is not authorized to issue this request.

addCommentReply

public String addCommentReply(String userId,
                              String assetGUID,
                              String attachmentGUID,
                              CommentType commentType,
                              String commentText,
                              boolean isPublic,
                              String methodName)
                       throws InvalidParameterException,
                              PropertyServerException,
                              UserNotAuthorizedException

Adds a comment to another comment.

Parameters:: userId - userId of user making request.; assetGUID - unique identifier for the referenceable.; attachmentGUID - unique identifier for an existing comment. Used to add a reply to a comment.; commentType - type of comment enum.; commentText - the text of the comment.; isPublic - indicates whether the feedback should be shared or only be visible to the originating user; methodName - calling method
Returns:: guid of new comment.
Throws:: InvalidParameterException - one of the parameters is null or invalid.; PropertyServerException - there is a problem adding the asset properties to the property server.; UserNotAuthorizedException - the requesting user is not authorized to issue this request.

removeAssetComment

public void removeAssetComment(String userId,
                               String assetGUID,
                               String commentGUID,
                               String methodName)
                        throws InvalidParameterException,
                               PropertyServerException,
                               UserNotAuthorizedException

Removes a comment added to the asset by this user.

Parameters:: userId - userId of user making request.; assetGUID - unique identifier for the asset.; commentGUID - unique identifier for the comment object.; methodName - calling method
Throws:: InvalidParameterException - one of the parameters is null or invalid.; PropertyServerException - there is a problem updating the asset properties in the property server.; UserNotAuthorizedException - the user does not have permission to perform this request.

getConnectionCount

public int getConnectionCount(String userId,
                              String anchorGUID,
                              String methodName)
                       throws InvalidParameterException,
                              PropertyServerException,
                              UserNotAuthorizedException

Return the count of connections for the asset.

Parameters:: userId - calling user; anchorGUID - identifier for the entity that the object is attached to; methodName - calling method
Returns:: unique identifier of the object or null
Throws:: InvalidParameterException - the endpoint bean properties are invalid; UserNotAuthorizedException - user not authorized to issue this request; PropertyServerException - problem accessing the property server

getExternalIdentifierCount

public int getExternalIdentifierCount(String userId,
                                      String anchorGUID,
                                      String methodName)
                               throws InvalidParameterException,
                                      PropertyServerException,
                                      UserNotAuthorizedException

Return the count of external identifiers for this asset.

Parameters:: userId - calling user; anchorGUID - identifier for the entity that the object is attached to; methodName - calling method
Returns:: unique identifier of the object or null
Throws:: InvalidParameterException - the endpoint bean properties are invalid; UserNotAuthorizedException - user not authorized to issue this request; PropertyServerException - problem accessing the property server

getExternalReferencesCount

public int getExternalReferencesCount(String userId,
                                      String anchorGUID,
                                      String methodName)
                               throws InvalidParameterException,
                                      PropertyServerException,
                                      UserNotAuthorizedException

Return the count of attached external references.

Parameters:: userId - calling user; anchorGUID - identifier for the entity that the object is attached to; methodName - calling method
Returns:: unique identifier of the object or null
Throws:: InvalidParameterException - the endpoint bean properties are invalid; UserNotAuthorizedException - user not authorized to issue this request; PropertyServerException - problem accessing the property server

getInformalTagCount

public int getInformalTagCount(String userId,
                               String anchorGUID,
                               String methodName)
                        throws InvalidParameterException,
                               PropertyServerException,
                               UserNotAuthorizedException

Return the count of attached informal tags.

Parameters:: userId - calling user; anchorGUID - identifier for the entity that the object is attached to; methodName - calling method
Returns:: unique identifier of the object or null
Throws:: InvalidParameterException - the endpoint bean properties are invalid; UserNotAuthorizedException - user not authorized to issue this request; PropertyServerException - problem accessing the property server

addTagToAsset
```
public void addTagToAsset(String userId,
                          String assetGUID,
                          String tagGUID,
                          boolean isPublic,
                          String methodName)
                   throws InvalidParameterException,
                          PropertyServerException,
                          UserNotAuthorizedException
```
Adds a tag (either private of public) to an asset.

Parameters:

userId - userId of user making request.

assetGUID - unique id for the anchor.

tagGUID - unique id of the tag.

isPublic - flag indicating whether the attachment of the tag is public or not

methodName - calling method

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - there is a problem adding the asset properties to the property server.

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

removeTagFromAsset

public void removeTagFromAsset(String userId,
                               String assetGUID,
                               String tagGUID,
                               String methodName)
                        throws InvalidParameterException,
                               PropertyServerException,
                               UserNotAuthorizedException

Removes a tag from the asset that was added by this user.

Parameters:: userId - userId of user making request.; assetGUID - unique id for the asset.; tagGUID - unique id for the tag.; methodName - calling method
Throws:: InvalidParameterException - one of the parameters is null or invalid.; PropertyServerException - there is a problem updating the asset properties in the property server.; UserNotAuthorizedException - the requesting user is not authorized to issue this request.

getAssetsByTag
```
public List<String> getAssetsByTag(String userId,
                                   String tagGUID,
                                   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.

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.

getAssetsByMeaning

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

Return the list of unique identifiers for assets that are linked to a specific (meaning) either directly or via fields in the schema.

Parameters:: userId - the name of the calling user.; termGUID - unique identifier of term.; 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.

getLicenseCount
```
public int getLicenseCount(String userId,
                           String anchorGUID,
                           String methodName)
                    throws InvalidParameterException,
                           PropertyServerException,
                           UserNotAuthorizedException
```
Return the count of license for this asset.

Parameters:

userId - calling user

anchorGUID - identifier for the entity that the object is attached to

methodName - calling method

Returns:

unique identifier of the object or null

Throws:

InvalidParameterException - the endpoint bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

getLikeCount
```
public int getLikeCount(String userId,
                        String anchorGUID,
                        String methodName)
                 throws InvalidParameterException,
                        PropertyServerException,
                        UserNotAuthorizedException
```
Return the number of likes for the asset.

Parameters:

userId - calling user

anchorGUID - identifier for the entity that the object is attached to

methodName - calling method

Returns:

unique identifier of the object or null

Throws:

InvalidParameterException - the endpoint bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

addLikeToAsset
```
public void addLikeToAsset(String userId,
                           String assetGUID,
                           boolean isPublic,
                           String methodName)
                    throws InvalidParameterException,
                           PropertyServerException,
                           UserNotAuthorizedException
```
Adds a "Like" to the asset. If the user has already attached a like then the original one is over-ridden.

Parameters:

userId - userId of user making request.

assetGUID - unique identifier for the asset where the like is to be attached.

isPublic - indicates whether the feedback should be shared or only be visible to the originating user

methodName - calling method

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - there is a problem adding the asset properties to the property server.

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

removeLikeFromAsset
```
public void removeLikeFromAsset(String userId,
                                String assetGUID,
                                String methodName)
                         throws InvalidParameterException,
                                PropertyServerException,
                                UserNotAuthorizedException
```
Removes a "Like" added to the asset by this user.

Parameters:

userId - userId of user making request.

assetGUID - unique identifier for the asset where the like is attached.

methodName - calling method

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - there is a problem updating the asset properties in the property server.

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

getKnownLocationsCount

public int getKnownLocationsCount(String userId,
                                  String anchorGUID,
                                  String methodName)
                           throws InvalidParameterException,
                                  PropertyServerException,
                                  UserNotAuthorizedException

Return the count of known locations.

Parameters:: userId - calling user; anchorGUID - identifier for the entity that the object is attached to; methodName - calling method
Returns:: unique identifier of the object or null
Throws:: InvalidParameterException - the endpoint bean properties are invalid; UserNotAuthorizedException - user not authorized to issue this request; PropertyServerException - problem accessing the property server

getNoteLogsCount
```
public int getNoteLogsCount(String userId,
                            String anchorGUID,
                            String methodName)
                     throws InvalidParameterException,
                            PropertyServerException,
                            UserNotAuthorizedException
```
Return the count of attached note logs.

Parameters:

userId - calling user

anchorGUID - identifier for the entity that the object is attached to

methodName - calling method

Returns:

unique identifier of the object or null

Throws:

InvalidParameterException - the endpoint bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

getRatingsCount
```
public int getRatingsCount(String userId,
                           String anchorGUID,
                           String methodName)
                    throws InvalidParameterException,
                           PropertyServerException,
                           UserNotAuthorizedException
```
Return the count of attached ratings.

Parameters:

userId - calling user

anchorGUID - identifier for the entity that the object is attached to

methodName - calling method

Returns:

unique identifier of the object or null

Throws:

InvalidParameterException - the endpoint bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

addRatingToAsset
```
public void addRatingToAsset(String userId,
                             String assetGUID,
                             StarRating starRating,
                             String review,
                             boolean isPublic,
                             String methodName)
                      throws InvalidParameterException,
                             PropertyServerException,
                             UserNotAuthorizedException
```
Adds a star rating and optional review text to the asset. If the user has already attached a rating then the original one is over-ridden.

Parameters:

userId - userId of user making request.

assetGUID - unique identifier for the asset.

starRating - StarRating enumeration for not recommended, one to five stars.

review - user review of asset. This can be null.

isPublic - indicates whether the feedback should be shared or only be visible to the originating user

methodName - calling method

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - there is a problem adding the asset properties to the property server.

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

removeRatingFromAsset
```
public void removeRatingFromAsset(String userId,
                                  String assetGUID,
                                  String methodName)
                           throws InvalidParameterException,
                                  PropertyServerException,
                                  UserNotAuthorizedException
```
Removes of a review that was added to the asset by this user.

Parameters:

userId - userId of user making request.

assetGUID - unique identifier for the asset where the rating is attached.

methodName - calling method

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - there is a problem updating the asset properties in the property server.

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

getRelatedAssetCount

public int getRelatedAssetCount(String userId,
                                String anchorGUID,
                                String methodName)
                         throws InvalidParameterException,
                                PropertyServerException,
                                UserNotAuthorizedException

Return the count of related assets.

Parameters:: userId - calling user; anchorGUID - identifier for the entity that the object is attached to; methodName - calling method
Returns:: unique identifier of the object or null
Throws:: InvalidParameterException - the endpoint bean properties are invalid; UserNotAuthorizedException - user not authorized to issue this request; PropertyServerException - problem accessing the property server

getRelatedAssets

public List<RelatedAsset> getRelatedAssets(String userId,
                                           List<String> supportedZones,
                                           String anchorGUID,
                                           int startFrom,
                                           int pageSize,
                                           String serviceName,
                                           String methodName)
                                    throws InvalidParameterException,
                                           PropertyServerException,
                                           UserNotAuthorizedException

Return all the assets attached to an anchor asset.

Parameters:: userId - calling user; supportedZones - override the default supported zones.; anchorGUID - identifier for the asset that the related assets are attached to; startFrom - starting element (used in paging through large result sets); pageSize - maximum number of results to return; serviceName - calling service; methodName - calling method
Returns:: list of retrieved objects
Throws:: InvalidParameterException - the input properties are invalid; UserNotAuthorizedException - user not authorized to issue this request; PropertyServerException - problem accessing the property server

getRelatedAssets

public List<RelatedAsset> getRelatedAssets(String userId,
                                           List<String> supportedZones,
                                           String anchorGUID,
                                           String relationshipTypeGUID,
                                           String relationshipTypeName,
                                           int startFrom,
                                           int pageSize,
                                           String serviceName,
                                           String methodName)
                                    throws InvalidParameterException,
                                           PropertyServerException,
                                           UserNotAuthorizedException

Return the assets attached to an anchor asset by the specified relationship type. If all related assets are required then specify null for the relationship type GUID and name.

Parameters:: userId - calling user; supportedZones - override the default supported zones.; anchorGUID - identifier for the asset that the related assets are attached to; relationshipTypeGUID - unique identifier for relationship type; relationshipTypeName - unique name for relationship type; startFrom - starting element (used in paging through large result sets); pageSize - maximum number of results to return; serviceName - calling service; methodName - calling method
Returns:: list of retrieved objects
Throws:: InvalidParameterException - the input properties are invalid; UserNotAuthorizedException - user not authorized to issue this request; PropertyServerException - problem accessing the property server

getRelatedMediaReferenceCount

public int getRelatedMediaReferenceCount(String userId,
                                         String anchorGUID,
                                         String methodName)
                                  throws InvalidParameterException,
                                         PropertyServerException,
                                         UserNotAuthorizedException

Return the count of related media references.

Parameters:: userId - calling user; anchorGUID - identifier for the entity that the object is attached to; methodName - calling method
Returns:: unique identifier of the object or null
Throws:: InvalidParameterException - the endpoint bean properties are invalid; UserNotAuthorizedException - user not authorized to issue this request; PropertyServerException - problem accessing the property server

getSchemaType

public SchemaType getSchemaType(String userId,
                                String anchorGUID,
                                String methodName)
                         throws InvalidParameterException,
                                PropertyServerException,
                                UserNotAuthorizedException

Is there an attached schema for this asset?

Parameters:: userId - calling user; anchorGUID - identifier for the entity that the object is attached to; methodName - calling method
Returns:: unique identifier of the object or null
Throws:: InvalidParameterException - the endpoint bean properties are invalid; UserNotAuthorizedException - user not authorized to issue this request; PropertyServerException - problem accessing the property server

Class AssetHandler

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

supportedZones

defaultZones

Constructor Detail

AssetHandler

Method Detail

setSecurityVerifier

getTypesOfAssetList

getTypesOfAssetDescriptions

createEmptyAsset

createEmptyExternalAsset

saveAssociatedConnection

saveAssociatedSchemaType

validateUserForAssetAttachmentUpdate

saveSemanticAssignment

saveSemanticAssignment

removeSemanticAssignment

removeSemanticAssignment

addAsset

addAsset

addAsset

updateAsset

classifyAssetAsReferenceData

declassifyAssetAsReferenceData

reclassifyAsset

reclassifyAsset

addAssetOrigin

removeAssetOrigin

updateAssetZones

addSecurityTags

removeSecurityTags

addSecurityTags

removeSecurityTags

updateAssetOwner

removeAsset

validatedVisibleAsset

validatedVisibleReferenceable

getAssetBean

getValidatedVisibleAsset

getValidatedVisibleAsset

getValidatedVisibleAsset

getConnectionForAsset

getValidValuesImplementationDefinitions

getConnectionsForAsset

getAssetForConnection

getAssetForConnectionName

assetGUIDsScan

assetScan

assetZoneScan

getAssetGUIDsByQualifiedName

getAssetsByQualifiedName

getAssetGUIDsByName

getAssetsByName

getAssetGUIDsByEndpoint

getAssetsByEndpoint

findAssetGUIDs

findAssets

getCertificationCount

getCommentCount

getAssetComments

addCommentToAsset

updateAssetComment

addCommentReply

removeAssetComment

getConnectionCount

getExternalIdentifierCount

getExternalReferencesCount

getInformalTagCount

addTagToAsset

removeTagFromAsset

getAssetsByTag

getAssetsByMeaning

getLicenseCount

getLikeCount

addLikeToAsset