org.odpi.openmetadata.accessservices.assetowner.client.AssetOwner

All Implemented Interfaces:: AssetClassificationInterface, AssetCollectionInterface, AssetConnectionManagementInterface, AssetDecommissioningInterface, AssetKnowledgeInterface, AssetOnboardingInterface, AssetReviewInterface, RelatedElementsManagementInterface, ConnectorFactoryInterface

Direct Known Subclasses:: AvroFileAssetOwner, CSVFileAssetOwner, FileSystemAssetOwner, ValidValuesAssetOwner

public class AssetOwner extends AssetOwnerBaseClient implements AssetKnowledgeInterface, AssetOnboardingInterface, AssetClassificationInterface, AssetConnectionManagementInterface, AssetCollectionInterface, AssetReviewInterface, AssetDecommissioningInterface

AssetOwner provides the generic client-side interface for the Asset Owner Open Metadata Access Service (OMAS). There are other clients that provide specialized methods for specific types of Asset.

This client is initialized with the URL and name of the server that is running the Asset Owner OMAS. This server is responsible for locating and managing the asset owner's definitions exchanged with this client.

Field Summary

Fields inherited from class org.odpi.openmetadata.accessservices.assetowner.client.AssetOwnerBaseClient
nullRequestBody, restClient, urlTemplatePrefix

Fields inherited from class org.odpi.openmetadata.frameworkservices.ocf.metadatamanagement.client.ConnectedAssetClientBase
auditLog, invalidParameterHandler, serverName, serverPlatformURLRoot
Constructor Summary

Constructors

Constructor

Description

AssetOwner(String serverName, String serverPlatformURLRoot)

Create a new client with no authentication embedded in the HTTP request.

AssetOwner(String serverName, String serverPlatformURLRoot, String userId, String password)

Create a new client that passes userId and password in each HTTP request.

AssetOwner(String serverName, String serverPlatformURLRoot, String userId, String password, AuditLog auditLog)

Create a new client that passes userId and password in each HTTP request.

AssetOwner(String serverName, String serverPlatformURLRoot, AssetOwnerRESTClient restClient, int maxPageSize, AuditLog auditLog)

Create a new client that is going to be used in an OMAG Server (view service or integration service typically).

AssetOwner(String serverName, String serverPlatformURLRoot, AuditLog auditLog)

Create a new client with no authentication embedded in the HTTP request.
Method Summary

Modifier and Type

Method

Description

void

addAssetOrigin(String userId, String assetGUID, String organizationGUID, String businessCapabilityGUID, Map<String,String> otherOriginValues)

Add the asset origin classification to an asset.

String

addAssetToCatalog(String userId, String typeName, String qualifiedName, String name, String description, Map<String,String> additionalProperties, Map<String,Object> extendedProperties)

Add a simple asset description to the catalog.

String

addAssetToCatalog(String userId, AssetProperties assetProperties)

Add a comprehensive asset description to the catalog.

String

addAssetToCatalogUsingTemplate(String userId, String templateGUID, TemplateProperties templateProperties)

Create a new metadata element to represent an asset using an existing asset as a template.

String

addCombinedSchemaToAsset(String userId, String assetGUID, SchemaTypeProperties schemaType, List<SchemaAttributeProperties> schemaAttributes)

Stores the supplied schema details in the catalog and attaches it to the asset.

void

addConnectionToAsset(String userId, String assetGUID, String assetSummary, Connection connection)

Deprecated.

void

addGovernanceDefinitionToElement(String userId, String definitionGUID, String elementGUID)

Link a governance definition to an element using the GovernedBy relationship.

String

addSchemaAttribute(String userId, String assetGUID, String parentGUID, SchemaAttributeProperties schemaAttribute)

Adds a schema attribute to a complex schema type like a relational table, avro schema or a structured document.

void

addSchemaAttributes(String userId, String assetGUID, String parentGUID, List<SchemaAttributeProperties> schemaAttributes)

Adds attributes to a complex schema type like a relational table, avro schema or a structured document.

String

addSchemaTypeToAsset(String userId, String assetGUID, SchemaTypeProperties schemaType)

Stores the supplied schema type in the catalog and attaches it to the asset.

void

addSecurityTags(String userId, String assetGUID, String assetElementGUID, List<String> securityLabels, Map<String,Object> securityProperties, Map<String,List<String>> accessGroups)

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

void

addSemanticAssignment(String userId, String assetGUID, String glossaryTermGUID, String assetElementGUID)

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

void

addSemanticAssignment(String userId, String assetGUID, String assetElementGUID, String glossaryTermGUID, SemanticAssignmentProperties properties)

Create a semantic assignment relationship between a glossary term and an element (normally a schema attribute, data field or asset).

void

addTemplateClassification(String userId, String assetGUID, String name, String versionIdentifier, String description, Map<String,String> additionalProperties)

Classify an asset as suitable to be used as a template for cataloguing assets of a similar types.

void

attachSchemaTypeToAsset(String userId, String assetGUID, String schemaTypeGUID)

Links the supplied schema type directly to the asset.

void

clearAssetConnection(String userId, String assetGUID, String connectionGUID)

Remove a relationship between an asset and its connection.

void

clearAssetRelationship(String userId, String relationshipTypeName, String relationshipGUID)

Remove the relationship between two elements.

void

clearConfidenceClassification(String userId, String elementGUID)

Remove the confidence classification from the element.

void

clearConfidentialityClassification(String userId, String elementGUID)

Remove the confidence classification from the element.

void

clearConnectorType(String userId, String connectionGUID, String connectorTypeGUID)

Remove a relationship between a connection and a connector type.

void

clearCriticalityClassification(String userId, String elementGUID)

Remove the criticality classification from the element.

void

clearElementAsDataField(String userId, String elementGUID)

Remove the data field designation from the element.

void

clearEmbeddedConnection(String userId, String connectionGUID, String embeddedConnectionGUID)

Remove a relationship between a virtual connection and an embedded connection.

void

clearEndpoint(String userId, String connectionGUID, String endpointGUID)

Remove a relationship between a connection and an endpoint.

void

clearRetentionClassification(String userId, String elementGUID)

Remove the retention classification from the element.

void

clearSchemaElementAsCalculatedValue(String userId, String schemaElementGUID)

Remove the calculated value designation from the schema element.

void

clearSchemaElementRelationship(String userId, String endOneGUID, String endTwoGUID, String relationshipTypeName)

Remove a relationship between two schema elements.

void

clearSchemaTypeParent(String userId, String schemaTypeGUID, String parentElementGUID, String parentElementTypeName)

Remove the relationship between a schema type and its parent data asset, process or port.

String

createAnchoredSchemaType(String userId, String anchorGUID, SchemaTypeProperties schemaTypeProperties)

Create a new metadata element to represent a schema type.

String

createCollection(String userId, CollectionProperties properties)

Create a new generic collection.

String

createConnection(String userId, ConnectionProperties connectionProperties)

Create a new metadata element to represent a connection.

String

createConnectionFromTemplate(String userId, String templateGUID, TemplateProperties templateProperties)

Create a new metadata element to represent a connection using an existing metadata element as a template.

String

createEndpoint(String userId, EndpointProperties endpointProperties)

Create a new metadata element to represent an endpoint.

String

createEndpointFromTemplate(String userId, String templateGUID, TemplateProperties templateProperties)

Create a new metadata element to represent an endpoint using an existing metadata element as a template.

String

createFolderCollection(String userId, CollectionFolderProperties properties)

Create a collection that acts like a folder with an order.

String

createSchemaAttributeFromTemplate(String userId, String schemaElementGUID, String templateGUID, TemplateProperties templateProperties)

Create a new metadata element to represent a schema attribute using an existing metadata element as a template.

String

createSchemaType(String userId, SchemaTypeProperties schemaTypeProperties)

Create a new metadata element to represent a schema type.

String

createSchemaTypeFromTemplate(String userId, String templateGUID, TemplateProperties templateProperties)

Create a new metadata element to represent a schema type using an existing metadata element as a template.

void

deleteAsset(String userId, String assetGUID)

Deletes an asset and all of its associated elements such as schema, connections (unless they are linked to another asset), discovery reports and associated feedback.

void

deleteAssetSchemaType(String userId, String assetGUID)

Detaches and deletes an asset's schema.

String

detachSchemaTypeFromAsset(String userId, String assetGUID)

Unlinks the schema from the asset but does not delete it.

List<AssetElement>

findAssets(String userId, String searchString, int startFrom, int pageSize)

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

List<CollectionElement>

findCollections(String userId, String searchString, int startFrom, int pageSize)

Retrieve the list of collection metadata elements that contain the search string.

List<ConnectionElement>

findConnections(String userId, String searchString, int startFrom, int pageSize)

Retrieve the list of connection metadata elements that contain the search string.

List<ConnectorTypeElement>

findConnectorTypes(String userId, String searchString, int startFrom, int pageSize)

Retrieve the list of connectorType metadata elements that contain the search string.

List<EndpointElement>

findEndpoints(String userId, String searchString, int startFrom, int pageSize)

Retrieve the list of endpoint metadata elements that contain the search string.

List<SchemaAttributeElement>

findSchemaAttributes(String userId, String searchString, int startFrom, int pageSize)

Retrieve the list of schema attribute metadata elements that contain the search string.

List<SchemaTypeElement>

findSchemaType(String userId, String searchString, int startFrom, int pageSize)

Retrieve the list of schema type metadata elements that contain the search string.

RelationshipElement

getAssetRelationship(String userId, String relationshipTypeName, String fromAssetGUID, String toAssetGUID)

Retrieve the relationship between two elements.

List<AssetElement>

getAssetsByName(String userId, String name, int startFrom, int pageSize)

Return a list of assets with the requested name.

List<AssetElement>

getAssetsByOrigin(String userId, FindAssetOriginProperties properties, int startFrom, int pageSize)

Return information about the assets from a specific origin.

AssetElement

getAssetSummary(String userId, String assetGUID)

Return the basic attributes of an asset.

CollectionElement

getCollection(String userId, String collectionGUID)

Return the properties of a specific collection.

CollectionMember

getCollectionMember(String userId, String collectionGUID, String memberGUID)

Return details of the membership between a collection and a specific member of the collection.

List<CollectionMember>

getCollectionMembers(String userId, String collectionGUID, int startFrom, int pageSize)

Return a list of elements that are a member of a collection.

List<CollectionElement>

getCollections(String userId, String parentGUID, int startFrom, int pageSize)

Returns the list of collections that are linked off of the supplied element.

List<CollectionElement>

getCollectionsByName(String userId, String name, int startFrom, int pageSize)

Retrieve the list of collection metadata elements with a matching qualified or display name.

List<ElementStub>

getConfidenceClassifiedElements(String userId, boolean returnSpecificLevel, int levelIdentifier, int startFrom, int pageSize)

Return information about the elements classified with the confidence classification.

List<ElementStub>

getConfidentialityClassifiedElements(String userId, boolean returnSpecificLevel, int levelIdentifier, int startFrom, int pageSize)

Return information about the elements classified with the confidentiality classification.

ConnectionElement

getConnectionByGUID(String userId, String connectionGUID)

Retrieve the connection metadata element with the supplied unique identifier.

List<ConnectionElement>

getConnectionsByName(String userId, String name, int startFrom, int pageSize)

Retrieve the list of connection metadata elements with a matching qualified or display name.

Connector

getConnectorToAsset(String userId, String assetGUID)

Return a connector for the asset to enable the calling user to access the content.

ConnectorTypeElement

getConnectorTypeByGUID(String userId, String connectorTypeGUID)

Retrieve the connectorType metadata element with the supplied unique identifier.

List<ConnectorTypeElement>

getConnectorTypesByName(String userId, String name, int startFrom, int pageSize)

Retrieve the list of connectorType metadata elements with a matching qualified or display name.

List<ElementStub>

getCriticalityClassifiedElements(String userId, boolean returnSpecificLevel, int levelIdentifier, int startFrom, int pageSize)

Return information about the elements classified with the criticality classification.

List<ElementStub>

getDataFieldClassifiedElements(String userId, DataFieldQueryProperties properties, int startFrom, int pageSize)

Return information about the elements classified with the DataField classification.

List<CollectionElement>

getElementsCollections(String userId, String elementGUID, int startFrom, int pageSize)

Return a list of collections that the supplied element is a member of.

List<RelatedElement>

getElementsSourceFrom(String userId, String elementGUID, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)

Retrieve the elements linked via a "SourceFrom" relationship to the requested element.

EndpointElement

getEndpointByGUID(String userId, String endpointGUID)

Retrieve the endpoint metadata element with the supplied unique identifier.

List<EndpointElement>

getEndpointsByName(String userId, String name, int startFrom, int pageSize)

Retrieve the list of endpoint metadata elements with a matching qualified or display name.

List<Annotation>

getExtendedAnnotations(String userId, String annotationGUID, AnnotationStatus annotationStatus, int startingFrom, int maximumResults)

Return any annotations attached to this annotation.

List<GovernanceDefinitionElement>

getGovernedByDefinitions(String userId, String elementGUID, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)

Retrieve the governance definitions linked via a "GovernedBy" relationship to the requested element.

List<RelatedElement>

getGovernedElements(String userId, String governanceDefinitionGUID, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)

Retrieve the elements linked via a "GovernedBy" relationship to the requested governance definition.

List<GlossaryTermElement>

getMeanings(String userId, String elementGUID, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)

Retrieve the glossary terms linked via a "SemanticAssignment" relationship to the requested element.

List<ElementStub>

getMembersOfSubjectArea(String userId, String subjectAreaName, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)

Return information about the contents of a subject area such as the glossaries, reference data sets and quality definitions.

List<SchemaAttributeElement>

getNestedSchemaAttributes(String userId, String parentSchemaElementGUID, int startFrom, int pageSize)

Retrieve the list of schema attributes associated with a schema element.

List<ElementStub>

getOwnersElements(String userId, String owner, int startFrom, int pageSize)

Return information about the contents of a subject area such as the glossaries, reference data sets and quality definitions.

List<RelationshipElement>

getRelatedAssetsAtEnd1(String userId, String relationshipTypeName, String toAssetGUID, int startFrom, int pageSize)

Retrieve the relationships linked from a specific element at end 2 of the relationship.

List<RelationshipElement>

getRelatedAssetsAtEnd2(String userId, String relationshipTypeName, String fromAssetGUID, int startFrom, int pageSize)

Retrieve the requested relationships linked from a specific element at end 2.

List<ElementStub>

getRetentionClassifiedElements(String userId, boolean returnSpecificBasisIdentifier, int basisIdentifier, int startFrom, int pageSize)

Return information about the elements classified with the retention classification.

SchemaAttributeElement

getSchemaAttributeByGUID(String userId, String schemaAttributeGUID)

Retrieve the schema attribute metadata element with the supplied unique identifier.

List<SchemaAttributeElement>

getSchemaAttributesByName(String userId, String name, int startFrom, int pageSize)

Retrieve the list of schema attribute metadata elements with a matching qualified or display name.

SchemaTypeElement

getSchemaTypeByGUID(String userId, String schemaTypeGUID)

Retrieve the schema type metadata element with the supplied unique identifier.

List<SchemaTypeElement>

getSchemaTypeByName(String userId, String name, int startFrom, int pageSize)

Retrieve the list of schema type metadata elements with a matching qualified or display name.

SchemaTypeElement

getSchemaTypeForElement(String userId, String parentElementGUID, String parentElementTypeName)

Return the schema type associated with a specific open metadata element (data asset, process or port).

ElementHeader

getSchemaTypeParent(String userId, String schemaTypeGUID)

Retrieve the header of the metadata element connected to a schema type.

List<ElementStub>

getSecurityTaggedElements(String userId, int startFrom, int pageSize)

Return information about the contents of a subject area such as the glossaries, reference data sets and quality definitions.

List<RelatedElement>

getSemanticAssignees(String userId, String glossaryTermGUID, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)

Retrieve the elements linked via a "SemanticAssignment" relationship to the requested glossary term.

List<RelatedElement>

getSourceElements(String userId, String elementGUID, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)

Retrieve the elements linked via a "SourceFrom" relationship to the requested element.

List<Annotation>

getSurveyReportAnnotations(String userId, String surveyReportGUID, AnnotationStatus annotationStatus, int startingFrom, int maximumResults)

Return the annotations linked directly to the report.

List<SurveyReport>

getSurveyReports(String userId, String assetGUID, int startingFrom, int maximumResults)

Return the survey reports about the asset.

List<String>

getTypesOfAnnotation(String userId)

Return the annotation subtype names.

Map<String,String>

getTypesOfAnnotationWithDescriptions(String userId)

Return the annotation subtype names mapped to their descriptions.

List<String>

getTypesOfAsset(String userId)

Return the asset subtype names.

Map<String,String>

getTypesOfAssetWithDescriptions(String userId)

Return the asset subtype names.

void

publishAsset(String userId, String assetGUID)

Update the zones for a specific asset to the zone list specified in the publishZones.

void

removeAssetOrigin(String userId, String assetGUID)

Remove the asset origin classification to an asset.

void

removeAssetOwner(String userId, String assetGUID)

Remove the ownership classification from an asset.

void

removeCollection(String userId, String collectionGUID)

Delete a collection.

void

removeConnection(String userId, String connectionGUID)

Remove the metadata element representing a connection.

void

removeEndpoint(String userId, String endpointGUID)

Remove the metadata element representing a endpoint.

void

removeFromCollection(String userId, String collectionGUID, String elementGUID)

Remove an element from a collection.

void

removeGovernanceDefinitionFromElement(String userId, String definitionGUID, String elementGUID)

Remove the GovernedBy relationship between a governance definition and an element.

void

removeSchemaAttribute(String userId, String schemaAttributeGUID)

Remove the metadata element representing a schema attribute.

void

removeSchemaType(String userId, String schemaTypeGUID)

Remove the metadata element representing a schema type.

void

removeSecurityTags(String userId, String assetGUID, String assetElementGUID)

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

void

removeSemanticAssignment(String userId, String assetGUID, String glossaryTermGUID, String assetElementGUID)

Remove the relationship between a glossary term and an element in an Asset description (typically a field in the schema).

void

removeTemplateClassification(String userId, String assetGUID)

Remove the classification that indicates that this asset can be used as a template.

List<ConnectionElement>

scanConnections(String userId, int startFrom, int pageSize)

Step through the connections visible to this caller.

void

setConfidenceClassification(String userId, String elementGUID, GovernanceClassificationProperties properties)

Classify/reclassify the element (typically an asset) to indicate the level of confidence that the organization has that the data is complete, accurate and up-to-date.

void

setConfidentialityClassification(String userId, String elementGUID, GovernanceClassificationProperties properties)

Classify/reclassify the element (typically a data field, schema attribute or glossary term) to indicate the level of confidentiality that any data associated with the element should be given.

void

setCriticalityClassification(String userId, String elementGUID, GovernanceClassificationProperties properties)

Classify/reclassify the element (typically an asset) to indicate how critical the element (or associated resource) is to the organization.

void

setElementAsDataField(String userId, String elementGUID, DataFieldValuesProperties properties)

Classify the element to indicate that it describes a data field and supply properties that describe the characteristics of the data values found within.

void

setRetentionClassification(String userId, String elementGUID, RetentionClassificationProperties properties)

Classify/reclassify the element (typically an asset) to indicate how long the element (or associated resource) is to be retained by the organization.

void

setSchemaElementAsCalculatedValue(String userId, String schemaElementGUID, String formula)

Classify the schema type (or attribute if type is embedded) to indicate that it is a calculated value.

void

setupAssetConnection(String userId, String assetGUID, String assetSummary, String connectionGUID)

Create a relationship between an asset and its connection.

void

setupConnectorType(String userId, String connectionGUID, String connectorTypeGUID)

Create a relationship between a connection and a connector type.

void

setupEmbeddedConnection(String userId, String connectionGUID, int position, String displayName, Map<String,Object> arguments, String embeddedConnectionGUID)

Create a relationship between a virtual connection and an embedded connection.

void

setupEndpoint(String userId, String connectionGUID, String endpointGUID)

Create a relationship between a connection and an endpoint.

String

setupRelatedAsset(String userId, String relationshipTypeName, String fromAssetGUID, String toAssetGUID, RelationshipProperties relationshipProperties)

Link two asset together.

void

setupSchemaElementRelationship(String userId, String endOneGUID, String endTwoGUID, String relationshipTypeName, RelationshipProperties properties)

Create a relationship between two schema elements.

void

setupSchemaTypeParent(String userId, String schemaTypeGUID, String parentElementGUID, String parentElementTypeName, RelationshipProperties properties)

Connect a schema type to a data asset, process or port.

void

updateAsset(String userId, String assetGUID, boolean isMergeUpdate, AssetProperties assetProperties)

Update the metadata element representing an asset.

void

updateAssetOwner(String userId, String assetGUID, String ownerId, String ownerTypeName, String ownerPropertyName)

Update the owner information for a specific asset.

void

updateAssetRelationship(String userId, String relationshipTypeName, String relationshipGUID, boolean isMergeUpdate, RelationshipProperties relationshipProperties)

Update relationship between two elements.

void

updateAssetZones(String userId, String assetGUID, List<String> assetZones)

Update the zones for a specific asset.

void

updateCollection(String userId, String collectionGUID, boolean isMergeUpdate, CollectionProperties properties)

Update the metadata element representing a collection.

void

updateCollectionMembership(String userId, String collectionGUID, CollectionMembershipProperties properties, boolean isMergeUpdate, String elementGUID)

Add an element to a collection (or update its membership properties).

void

updateConnection(String userId, String connectionGUID, boolean isMergeUpdate, ConnectionProperties connectionProperties)

Update the metadata element representing a connection.

void

updateEndpoint(String userId, boolean isMergeUpdate, String endpointGUID, EndpointProperties endpointProperties)

Update the metadata element representing a endpoint.

void

updateSchemaAttribute(String userId, String schemaAttributeGUID, boolean isMergeUpdate, SchemaAttributeProperties schemaAttributeProperties)

Update the properties of the metadata element representing a schema attribute.

void

updateSchemaType(String userId, String schemaTypeGUID, boolean isMergeUpdate, SchemaTypeProperties schemaTypeProperties)

Update the metadata element representing a schema type.

void

withdrawAsset(String userId, String assetGUID)

Update the zones for a specific asset to the zone list specified in the defaultZones.

Methods inherited from class org.odpi.openmetadata.accessservices.assetowner.client.AssetOwnerBaseClient
clearCatalogTemplate, clearMoreInformation, clearResource, clearStakeholder, getCatalogTemplateList, getDescriptiveElements, getMoreInformation, getResourceList, getStakeholderCommissionedElements, getStakeholders, getSupportedByResource, getSupportedByTemplate, removeReferenceable, setupCatalogTemplate, setupMoreInformation, setupResource, setupStakeholder, updateRelationship

Methods inherited from class org.odpi.openmetadata.frameworkservices.ocf.metadatamanagement.client.ConnectedAssetClientBase
getAnchorAssetFromGUID, getAssetForConnection, getAssetProperties, getAssetSummary, getConnectionByGUID, getConnectionByName, getConnectionForAsset, getConnectorByConnection, getConnectorByGUID, getConnectorByName, getConnectorForAsset, getConnectorForAsset, getConnectorForConnection, logAssetAuditMessage, saveConnection, saveConnection

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

Methods inherited from interface org.odpi.openmetadata.accessservices.assetowner.api.AssetReviewInterface
getAssetProperties

Constructor Details
- AssetOwner
  
  public AssetOwner(String serverName, String serverPlatformURLRoot, AuditLog auditLog) throws InvalidParameterException
  
  Create a new client with no authentication embedded in the HTTP request.
  
  Parameters:
  
  serverName - name of the server to connect to
  
  serverPlatformURLRoot - the network address of the server running the OMAS REST services
  
  auditLog - logging destination
  
  Throws:
  
  InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
- AssetOwner
  
  public AssetOwner(String serverName, String serverPlatformURLRoot) throws InvalidParameterException
  
  Create a new client with no authentication embedded in the HTTP request.
  
  Parameters:
  
  serverName - name of the server to connect to
  
  serverPlatformURLRoot - the network address of the server running the OMAS REST services
  
  Throws:
  
  InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
- AssetOwner
  
  public AssetOwner(String serverName, String serverPlatformURLRoot, String userId, String password, AuditLog auditLog) throws InvalidParameterException
  
  Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.
  
  Parameters:
  
  serverName - name of the server to connect to
  
  serverPlatformURLRoot - the network address of the server running the OMAS REST services
  
  userId - caller's userId embedded in all HTTP requests
  
  password - caller's userId embedded in all HTTP requests
  
  auditLog - logging destination
  
  Throws:
  
  InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
- AssetOwner
  
  public AssetOwner(String serverName, String serverPlatformURLRoot, String userId, String password) throws InvalidParameterException
  
  Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.
  
  Parameters:
  
  serverName - name of the server to connect to
  
  serverPlatformURLRoot - the network address of the server running the OMAS REST services
  
  userId - caller's userId embedded in all HTTP requests
  
  password - caller's userId embedded in all HTTP requests
  
  Throws:
  
  InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
- AssetOwner
  
  public AssetOwner(String serverName, String serverPlatformURLRoot, AssetOwnerRESTClient restClient, int maxPageSize, AuditLog auditLog) throws InvalidParameterException
  
  Create a new client that is going to be used in an OMAG Server (view service or integration service typically).
  
  Parameters:
  
  serverName - name of the server to connect to
  
  serverPlatformURLRoot - the network address of the server running the OMAS REST services
  
  restClient - client that issues the REST API calls
  
  maxPageSize - maximum number of results supported by this server
  
  auditLog - logging destination
  
  Throws:
  
  InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
Method Details
- getTypesOfAsset
  
  public List<String> getTypesOfAsset(String userId) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Return the asset subtype names.
  
  Specified by:
  
  getTypesOfAsset in interface AssetKnowledgeInterface
  
  Parameters:
  
  userId - calling user
  
  Returns:
  
  list of type names that are subtypes of asset
  
  Throws:
  
  InvalidParameterException - userId is null
  
  PropertyServerException - problem accessing property server
  
  UserNotAuthorizedException - security access problem
- getTypesOfAssetWithDescriptions
  
  public Map<String,String> getTypesOfAssetWithDescriptions(String userId) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Return the asset subtype names.
  
  Specified by:
  
  getTypesOfAssetWithDescriptions in interface AssetKnowledgeInterface
  
  Parameters:
  
  userId - calling user
  
  Returns:
  
  map of type names that are subtypes of asset
  
  Throws:
  
  InvalidParameterException - full path or userId is null
  
  PropertyServerException - problem accessing property server
  
  UserNotAuthorizedException - security access problem
- addAssetToCatalog
  
  public String addAssetToCatalog(String userId, String typeName, String qualifiedName, String name, String description, Map<String,String> additionalProperties, Map<String,Object> extendedProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Add a simple asset description to the catalog.
  
  Specified by:
  
  addAssetToCatalog in interface AssetOnboardingInterface
  
  Parameters:
  
  userId - calling user (assumed to be the owner)
  
  typeName - specific type of the asset - this must match a defined subtype
  
  qualifiedName - unique name for the asset in the catalog
  
  name - resource name for the asset in the catalog
  
  description - resource description for the asset in the catalog
  
  additionalProperties - optional properties
  
  extendedProperties - properties defined for an asset subtype
  
  Returns:
  
  unique identifier (guid) of the asset
  
  Throws:
  
  InvalidParameterException - full path or userId is null
  
  PropertyServerException - problem accessing property server
  
  UserNotAuthorizedException - security access problem
- addAssetToCatalog
  
  public String addAssetToCatalog(String userId, AssetProperties assetProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Add a comprehensive asset description to the catalog.
  
  Specified by:
  
  addAssetToCatalog in interface AssetOnboardingInterface
  
  Parameters:
  
  userId - calling user
  
  assetProperties - properties for the asset
  
  Returns:
  
  unique identifier (guid) of the asset
  
  Throws:
  
  InvalidParameterException - full path or userId is null
  
  PropertyServerException - problem accessing property server
  
  UserNotAuthorizedException - security access problem
- addAssetToCatalogUsingTemplate
  
  public String addAssetToCatalogUsingTemplate(String userId, String templateGUID, TemplateProperties templateProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a new metadata element to represent an asset using an existing asset as a template.
  
  Specified by:
  
  addAssetToCatalogUsingTemplate in interface AssetOnboardingInterface
  
  Parameters:
  
  userId - calling user
  
  templateGUID - unique identifier of the metadata element to copy
  
  templateProperties - properties that override the template
  
  Returns:
  
  unique identifier of the new metadata element
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- updateAsset
  
  public void updateAsset(String userId, String assetGUID, boolean isMergeUpdate, AssetProperties assetProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Update the metadata element representing an asset.
  
  Specified by:
  
  updateAsset in interface AssetOnboardingInterface
  
  Parameters:
  
  userId - calling user
  
  assetGUID - unique identifier of the metadata element to update
  
  isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
  
  assetProperties - new properties for this element
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- setupRelatedAsset
  
  public String setupRelatedAsset(String userId, String relationshipTypeName, String fromAssetGUID, String toAssetGUID, RelationshipProperties relationshipProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Link two asset together. Use information from the relationship type definition to ensure the fromAssetGUID and toAssetGUID are the right way around.
  
  Specified by:
  
  setupRelatedAsset in interface AssetOnboardingInterface
  
  Parameters:
  
  userId - calling user
  
  relationshipTypeName - type name of relationship to create
  
  fromAssetGUID - unique identifier of the asset at end 1 of the relationship
  
  toAssetGUID - unique identifier of the asset at end 2 of the relationship
  
  relationshipProperties - unique identifier for this relationship
  
  Returns:
  
  unique identifier of the relationship
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- getAssetRelationship
  
  public RelationshipElement getAssetRelationship(String userId, String relationshipTypeName, String fromAssetGUID, String toAssetGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the relationship between two elements.
  
  Specified by:
  
  getAssetRelationship in interface AssetReviewInterface
  
  Parameters:
  
  userId - calling user
  
  relationshipTypeName - type name of relationship to create
  
  fromAssetGUID - unique identifier of the asset at end 1 of the relationship
  
  toAssetGUID - unique identifier of the asset at end 2 of the relationship
  
  Returns:
  
  unique identifier and properties of the relationship
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- updateAssetRelationship
  
  public void updateAssetRelationship(String userId, String relationshipTypeName, String relationshipGUID, boolean isMergeUpdate, RelationshipProperties relationshipProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Update relationship between two elements.
  
  Specified by:
  
  updateAssetRelationship in interface AssetOnboardingInterface
  
  Parameters:
  
  userId - calling user
  
  relationshipTypeName - type name of relationship to update
  
  relationshipGUID - unique identifier of the relationship
  
  relationshipProperties - description and/or purpose of the relationship
  
  isMergeUpdate - should the new properties be merged with the existing properties, or replace them entirely
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- clearAssetRelationship
  
  public void clearAssetRelationship(String userId, String relationshipTypeName, String relationshipGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove the relationship between two elements.
  
  Specified by:
  
  clearAssetRelationship in interface AssetOnboardingInterface
  
  Parameters:
  
  userId - calling user
  
  relationshipTypeName - type name of relationship to delete
  
  relationshipGUID - unique identifier of the relationship
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- getRelatedAssetsAtEnd2
  
  public List<RelationshipElement> getRelatedAssetsAtEnd2(String userId, String relationshipTypeName, String fromAssetGUID, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the requested relationships linked from a specific element at end 2.
  
  Specified by:
  
  getRelatedAssetsAtEnd2 in interface AssetReviewInterface
  
  Parameters:
  
  userId - calling user
  
  relationshipTypeName - type name of relationship to delete
  
  fromAssetGUID - unique identifier of the asset at end 1 of the relationship
  
  startFrom - start position for results
  
  pageSize - maximum number of results
  
  Returns:
  
  unique identifier and properties of the relationship
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- getRelatedAssetsAtEnd1
  
  public List<RelationshipElement> getRelatedAssetsAtEnd1(String userId, String relationshipTypeName, String toAssetGUID, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the relationships linked from a specific element at end 2 of the relationship.
  
  Specified by:
  
  getRelatedAssetsAtEnd1 in interface AssetReviewInterface
  
  Parameters:
  
  userId - calling user
  
  relationshipTypeName - type name of relationship to delete
  
  toAssetGUID - unique identifier of the asset at end 2 of the relationship
  
  startFrom - start position for results
  
  pageSize - maximum number of results
  
  Returns:
  
  unique identifier and properties of the relationship
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- addCombinedSchemaToAsset
  
  public String addCombinedSchemaToAsset(String userId, String assetGUID, SchemaTypeProperties schemaType, List<SchemaAttributeProperties> schemaAttributes) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Stores the supplied schema details in the catalog and attaches it to the asset. If another schema is currently attached to the asset, it is unlinked and deleted. If more attributes need to be added in addition to the ones supplied then this can be done with addSchemaAttributesToSchemaType().
  
  Specified by:
  
  addCombinedSchemaToAsset in interface AssetOnboardingInterface
  
  Parameters:
  
  userId - calling user
  
  assetGUID - unique identifier of the asset that the schema is to be attached to
  
  schemaType - schema type to create and attach directly to the asset.
  
  schemaAttributes - optional schema attributes.
  
  Returns:
  
  guid of the schema type or
  
  Throws:
  
  InvalidParameterException - full path or userId is null
  
  PropertyServerException - problem accessing property server
  
  UserNotAuthorizedException - security access problem
- addSchemaTypeToAsset
  
  public String addSchemaTypeToAsset(String userId, String assetGUID, SchemaTypeProperties schemaType) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Stores the supplied schema type in the catalog and attaches it to the asset. If another schema is currently attached to the asset, it is unlinked and deleted.
  
  Specified by:
  
  addSchemaTypeToAsset in interface AssetOnboardingInterface
  
  Parameters:
  
  userId - calling user
  
  assetGUID - unique identifier of the asset that the schema is to be attached to
  
  schemaType - schema type to create and attach directly to the asset.
  
  Returns:
  
  guid of the new schema type or
  
  Throws:
  
  InvalidParameterException - full path or userId is null
  
  PropertyServerException - problem accessing property server
  
  UserNotAuthorizedException - security access problem
- attachSchemaTypeToAsset
  
  public void attachSchemaTypeToAsset(String userId, String assetGUID, String schemaTypeGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Links the supplied schema type directly to the asset. If this schema is either not found, or already attached to an asset, then an error occurs. If another schema is currently attached to the asset, it is unlinked and deleted.
  
  Specified by:
  
  attachSchemaTypeToAsset in interface AssetOnboardingInterface
  
  Parameters:
  
  userId - calling user
  
  assetGUID - unique identifier of the asset that the schema is to be attached to
  
  schemaTypeGUID - unique identifier of the schema type to attach
  
  Throws:
  
  InvalidParameterException - full path or userId is null
  
  PropertyServerException - problem accessing property server
  
  UserNotAuthorizedException - security access problem
- detachSchemaTypeFromAsset
  
  public String detachSchemaTypeFromAsset(String userId, String assetGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Unlinks the schema from the asset but does not delete it. This means it can be reattached to a different asset.
  
  Specified by:
  
  detachSchemaTypeFromAsset in interface AssetOnboardingInterface
  
  Parameters:
  
  userId - calling user
  
  assetGUID - unique identifier of the asset that the schema is to be attached to
  
  Returns:
  
  guid of detached schema type
  
  Throws:
  
  InvalidParameterException - full path or userId is null
  
  PropertyServerException - problem accessing property server
  
  UserNotAuthorizedException - security access problem
- deleteAssetSchemaType
  
  public void deleteAssetSchemaType(String userId, String assetGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Detaches and deletes an asset's schema.
  
  Specified by:
  
  deleteAssetSchemaType in interface AssetOnboardingInterface
  
  Parameters:
  
  userId - calling user
  
  assetGUID - unique identifier of the asset that the schema is to be attached to
  
  Throws:
  
  InvalidParameterException - full path or userId is null
  
  PropertyServerException - problem accessing property server
  
  UserNotAuthorizedException - security access problem
- createSchemaType
  
  public String createSchemaType(String userId, SchemaTypeProperties schemaTypeProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a new metadata element to represent a schema type.
  
  Specified by:
  
  createSchemaType in interface AssetOnboardingInterface
  
  Parameters:
  
  userId - calling user
  
  schemaTypeProperties - properties about the schema type to store
  
  Returns:
  
  unique identifier of the new schema type
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- createAnchoredSchemaType
  
  public String createAnchoredSchemaType(String userId, String anchorGUID, SchemaTypeProperties schemaTypeProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a new metadata element to represent a schema type.
  
  Specified by:
  
  createAnchoredSchemaType in interface AssetOnboardingInterface
  
  Parameters:
  
  userId - calling user
  
  anchorGUID - unique identifier of the intended anchor of the schema type
  
  schemaTypeProperties - properties about the schema type to store
  
  Returns:
  
  unique identifier of the new schema type
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- createSchemaTypeFromTemplate
  
  public String createSchemaTypeFromTemplate(String userId, String templateGUID, TemplateProperties templateProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a new metadata element to represent a schema type using an existing metadata element as a template.
  
  Specified by:
  
  createSchemaTypeFromTemplate in interface AssetOnboardingInterface
  
  Parameters:
  
  userId - calling user
  
  templateGUID - unique identifier of the metadata element to copy
  
  templateProperties - properties that override the template
  
  Returns:
  
  unique identifier of the new schema type
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- updateSchemaType
  
  public void updateSchemaType(String userId, String schemaTypeGUID, boolean isMergeUpdate, SchemaTypeProperties schemaTypeProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Update the metadata element representing a schema type.
  
  Specified by:
  
  updateSchemaType in interface AssetOnboardingInterface
  
  Parameters:
  
  userId - calling user
  
  schemaTypeGUID - unique identifier of the metadata element to update
  
  isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
  
  schemaTypeProperties - new properties for the metadata element
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- setupSchemaTypeParent
  
  public void setupSchemaTypeParent(String userId, String schemaTypeGUID, String parentElementGUID, String parentElementTypeName, RelationshipProperties properties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Connect a schema type to a data asset, process or port.
  
  Specified by:
  
  setupSchemaTypeParent in interface AssetOnboardingInterface
  
  Parameters:
  
  userId - calling user
  
  schemaTypeGUID - unique identifier of the schema type to connect
  
  parentElementGUID - unique identifier of the open metadata element that this schema type is to be connected to
  
  parentElementTypeName - unique type name of the open metadata element that this schema type is to be connected to
  
  properties - properties for the relationship
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- clearSchemaTypeParent
  
  public void clearSchemaTypeParent(String userId, String schemaTypeGUID, String parentElementGUID, String parentElementTypeName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove the relationship between a schema type and its parent data asset, process or port.
  
  Specified by:
  
  clearSchemaTypeParent in interface AssetOnboardingInterface
  
  Parameters:
  
  userId - calling user
  
  schemaTypeGUID - unique identifier of the schema type to connect
  
  parentElementGUID - unique identifier of the open metadata element that this schema type is to be connected to
  
  parentElementTypeName - unique type name of the open metadata element that this schema type is to be connected to
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- setupSchemaElementRelationship
  
  public void setupSchemaElementRelationship(String userId, String endOneGUID, String endTwoGUID, String relationshipTypeName, RelationshipProperties properties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a relationship between two schema elements. The name of the desired relationship, and any properties are passed on the API.
  
  Specified by:
  
  setupSchemaElementRelationship in interface AssetOnboardingInterface
  
  Parameters:
  
  userId - calling user
  
  endOneGUID - unique identifier of the schema element at end one of the relationship
  
  endTwoGUID - unique identifier of the schema element at end two of the relationship
  
  relationshipTypeName - type of the relationship to create
  
  properties - relationship properties
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- clearSchemaElementRelationship
  
  public void clearSchemaElementRelationship(String userId, String endOneGUID, String endTwoGUID, String relationshipTypeName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove a relationship between two schema elements. The name of the desired relationship is passed on the API.
  
  Specified by:
  
  clearSchemaElementRelationship in interface AssetOnboardingInterface
  
  Parameters:
  
  userId - calling user
  
  endOneGUID - unique identifier of the schema element at end one of the relationship
  
  endTwoGUID - unique identifier of the schema element at end two of the relationship
  
  relationshipTypeName - type of the relationship to delete
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- removeSchemaType
  
  public void removeSchemaType(String userId, String schemaTypeGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove the metadata element representing a schema type.
  
  Specified by:
  
  removeSchemaType in interface AssetOnboardingInterface
  
  Parameters:
  
  userId - calling user
  
  schemaTypeGUID - unique identifier of the metadata element to remove
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- findSchemaType
  
  public List<SchemaTypeElement> findSchemaType(String userId, String searchString, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of schema type metadata elements that contain the search string. The search string is treated as a regular expression.
  
  Specified by:
  
  findSchemaType in interface AssetOnboardingInterface
  
  Parameters:
  
  userId - calling user
  
  searchString - string to find in the properties
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of matching metadata elements
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- getSchemaTypeForElement
  
  public SchemaTypeElement getSchemaTypeForElement(String userId, String parentElementGUID, String parentElementTypeName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Return the schema type associated with a specific open metadata element (data asset, process or port).
  
  Specified by:
  
  getSchemaTypeForElement in interface AssetOnboardingInterface
  
  Parameters:
  
  userId - calling user
  
  parentElementGUID - unique identifier of the open metadata element that this schema type is to be connected to
  
  parentElementTypeName - unique type name of the open metadata element that this schema type is to be connected to
  
  Returns:
  
  metadata element describing the schema type associated with the requested parent element
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- getSchemaTypeByName
  
  public List<SchemaTypeElement> getSchemaTypeByName(String userId, String name, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of schema type metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
  
  Specified by:
  
  getSchemaTypeByName in interface AssetOnboardingInterface
  
  Parameters:
  
  userId - calling user
  
  name - name to search for
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of matching metadata elements
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- getSchemaTypeByGUID
  
  public SchemaTypeElement getSchemaTypeByGUID(String userId, String schemaTypeGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the schema type metadata element with the supplied unique identifier.
  
  Specified by:
  
  getSchemaTypeByGUID in interface AssetOnboardingInterface
  
  Parameters:
  
  userId - calling user
  
  schemaTypeGUID - unique identifier of the requested metadata element
  
  Returns:
  
  requested metadata element
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- getSchemaTypeParent
  
  public ElementHeader getSchemaTypeParent(String userId, String schemaTypeGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the header of the metadata element connected to a schema type.
  
  Specified by:
  
  getSchemaTypeParent in interface AssetOnboardingInterface
  
  Parameters:
  
  userId - calling user
  
  schemaTypeGUID - unique identifier of the requested metadata element
  
  Returns:
  
  header for parent element (data asset, process, port)
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- addSchemaAttributes
  
  public void addSchemaAttributes(String userId, String assetGUID, String parentGUID, List<SchemaAttributeProperties> schemaAttributes) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Adds attributes to a complex schema type like a relational table, avro schema or a structured document. This method can be called repeatedly to add many attributes to a schema.
  
  Specified by:
  
  addSchemaAttributes in interface AssetOnboardingInterface
  
  Parameters:
  
  userId - calling user
  
  assetGUID - unique identifier of the asset that the schema is to be attached to
  
  parentGUID - unique identifier of the schema element to anchor these attributes to.
  
  schemaAttributes - list of schema attribute objects.
  
  Throws:
  
  InvalidParameterException - full path or userId is null
  
  PropertyServerException - problem accessing property server
  
  UserNotAuthorizedException - security access problem
- addSchemaAttribute
  
  public String addSchemaAttribute(String userId, String assetGUID, String parentGUID, SchemaAttributeProperties schemaAttribute) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Adds a schema attribute to a complex schema type like a relational table, avro schema or a structured document. This method can be called repeatedly to add many attributes to a schema. The GUID returned can be used to add nested attributes.
  
  Specified by:
  
  addSchemaAttribute in interface AssetOnboardingInterface
  
  Parameters:
  
  userId - calling user
  
  assetGUID - unique identifier of the asset that the schema is to be attached to
  
  parentGUID - unique identifier of the schema element to anchor these attributes to.
  
  schemaAttribute - schema attribute object to add.
  
  Returns:
  
  unique identifier for the new schema attribute or
  
  Throws:
  
  InvalidParameterException - full path or userId is null
  
  PropertyServerException - problem accessing property server
  
  UserNotAuthorizedException - security access problem
- createSchemaAttributeFromTemplate
  
  public String createSchemaAttributeFromTemplate(String userId, String schemaElementGUID, String templateGUID, TemplateProperties templateProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a new metadata element to represent a schema attribute using an existing metadata element as a template.
  
  Specified by:
  
  createSchemaAttributeFromTemplate in interface AssetOnboardingInterface
  
  Parameters:
  
  userId - calling user
  
  schemaElementGUID - unique identifier of the schemaType or Schema Attribute where the schema attribute is connected to
  
  templateGUID - unique identifier of the metadata element to copy
  
  templateProperties - properties that override the template
  
  Returns:
  
  unique identifier of the new metadata element for the schema attribute
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- updateSchemaAttribute
  
  public void updateSchemaAttribute(String userId, String schemaAttributeGUID, boolean isMergeUpdate, SchemaAttributeProperties schemaAttributeProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Update the properties of the metadata element representing a schema attribute.
  
  Specified by:
  
  updateSchemaAttribute in interface AssetOnboardingInterface
  
  Parameters:
  
  userId - calling user
  
  schemaAttributeGUID - unique identifier of the schema attribute to update
  
  isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
  
  schemaAttributeProperties - new properties for the schema attribute
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- setSchemaElementAsCalculatedValue
  
  public void setSchemaElementAsCalculatedValue(String userId, String schemaElementGUID, String formula) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Classify the schema type (or attribute if type is embedded) to indicate that it is a calculated value.
  
  Specified by:
  
  setSchemaElementAsCalculatedValue in interface AssetOnboardingInterface
  
  Parameters:
  
  userId - calling user
  
  schemaElementGUID - unique identifier of the metadata element to update
  
  formula - description of the logic that maps data values to
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- clearSchemaElementAsCalculatedValue
  
  public void clearSchemaElementAsCalculatedValue(String userId, String schemaElementGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove the calculated value designation from the schema element.
  
  Specified by:
  
  clearSchemaElementAsCalculatedValue in interface AssetOnboardingInterface
  
  Parameters:
  
  userId - calling user
  
  schemaElementGUID - unique identifier of the metadata element to update
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- removeSchemaAttribute
  
  public void removeSchemaAttribute(String userId, String schemaAttributeGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove the metadata element representing a schema attribute.
  
  Specified by:
  
  removeSchemaAttribute in interface AssetOnboardingInterface
  
  Parameters:
  
  userId - calling user
  
  schemaAttributeGUID - unique identifier of the metadata element to remove
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- findSchemaAttributes
  
  public List<SchemaAttributeElement> findSchemaAttributes(String userId, String searchString, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of schema attribute metadata elements that contain the search string. The search string is treated as a regular expression.
  
  Specified by:
  
  findSchemaAttributes in interface AssetOnboardingInterface
  
  Parameters:
  
  userId - calling user
  
  searchString - string to find in the properties
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of matching metadata elements
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- getNestedSchemaAttributes
  
  public List<SchemaAttributeElement> getNestedSchemaAttributes(String userId, String parentSchemaElementGUID, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of schema attributes associated with a schema element.
  
  Specified by:
  
  getNestedSchemaAttributes in interface AssetOnboardingInterface
  
  Parameters:
  
  userId - calling user
  
  parentSchemaElementGUID - unique identifier of the schema element of interest
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of associated metadata elements
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- getSchemaAttributesByName
  
  public List<SchemaAttributeElement> getSchemaAttributesByName(String userId, String name, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of schema attribute metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
  
  Specified by:
  
  getSchemaAttributesByName in interface AssetOnboardingInterface
  
  Parameters:
  
  userId - calling user
  
  name - name to search for
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of matching metadata elements
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- getSchemaAttributeByGUID
  
  public SchemaAttributeElement getSchemaAttributeByGUID(String userId, String schemaAttributeGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the schema attribute metadata element with the supplied unique identifier.
  
  Specified by:
  
  getSchemaAttributeByGUID in interface AssetOnboardingInterface
  
  Parameters:
  
  userId - calling user
  
  schemaAttributeGUID - unique identifier of the requested metadata element
  
  Returns:
  
  matching metadata element
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- addConnectionToAsset
  
  @Deprecated public void addConnectionToAsset(String userId, String assetGUID, String assetSummary, Connection connection) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Deprecated.
  
  Adds a connection to an asset. Assets can have multiple connections attached.
  
  Specified by:
  
  addConnectionToAsset in interface AssetOnboardingInterface
  
  Parameters:
  
  userId - calling user
  
  assetGUID - unique identifier of the asset to attach the connection to
  
  assetSummary - summary of the asset that is stored in the relationship between the asset and the connection.
  
  connection - connection object. If the connection is already stored (matching guid) then the existing connection is used.
  
  Throws:
  
  InvalidParameterException - full path or userId is null
  
  PropertyServerException - problem accessing property server
  
  UserNotAuthorizedException - security access problem
- addSemanticAssignment
  
  public void addSemanticAssignment(String userId, String assetGUID, String glossaryTermGUID, String assetElementGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a simple relationship between a glossary term and an element in an Asset description (typically a field in the schema).
  
  Specified by:
  
  addSemanticAssignment in interface AssetClassificationInterface
  
  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. If null then the assetGUID is used.
  
  Throws:
  
  InvalidParameterException - one of the parameters is null or invalid
  
  PropertyServerException - problem accessing property server
  
  UserNotAuthorizedException - security access problem
- addSemanticAssignment
  
  public void addSemanticAssignment(String userId, String assetGUID, String assetElementGUID, String glossaryTermGUID, SemanticAssignmentProperties properties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a semantic assignment relationship between a glossary term and an element (normally a schema attribute, data field or asset). This relationship indicates that the data associated with the element meaning matches the description in the glossary term.
  
  Specified by:
  
  addSemanticAssignment in interface AssetClassificationInterface
  
  Parameters:
  
  userId - calling user
  
  assetGUID - unique identifier of asset
  
  assetElementGUID - unique identifier of the element that is being assigned to the glossary term
  
  glossaryTermGUID - unique identifier of the glossary term that provides the meaning
  
  properties - properties for relationship
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- removeSemanticAssignment
  
  public void removeSemanticAssignment(String userId, String assetGUID, String glossaryTermGUID, String assetElementGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove the relationship between a glossary term and an element in an Asset description (typically a field in the schema).
  
  Specified by:
  
  removeSemanticAssignment in interface AssetClassificationInterface
  
  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. If null then the assetGUID is used.
  
  Throws:
  
  InvalidParameterException - one of the parameters is null or invalid
  
  PropertyServerException - problem accessing property server
  
  UserNotAuthorizedException - security access problem
- addAssetOrigin
  
  public void addAssetOrigin(String userId, String assetGUID, String organizationGUID, String businessCapabilityGUID, Map<String,String> otherOriginValues) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Add the asset origin classification to an asset.
  
  Specified by:
  
  addAssetOrigin in interface AssetClassificationInterface
  
  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
  
  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) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove the asset origin classification to an asset.
  
  Specified by:
  
  removeAssetOrigin in interface AssetClassificationInterface
  
  Parameters:
  
  userId - calling user
  
  assetGUID - unique identifier of asset
  
  Throws:
  
  InvalidParameterException - entity not known, null userId or guid
  
  PropertyServerException - problem accessing property server
  
  UserNotAuthorizedException - security access problem
- publishAsset
  
  public void publishAsset(String userId, String assetGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Update the zones for a specific asset to the zone list specified in the publishZones.
  
  Specified by:
  
  publishAsset in interface AssetClassificationInterface
  
  Parameters:
  
  userId - calling user
  
  assetGUID - unique identifier for the asset to update
  
  Throws:
  
  InvalidParameterException - entity not known, null userId or guid
  
  PropertyServerException - problem accessing property server
  
  UserNotAuthorizedException - security access problem
- withdrawAsset
  
  public void withdrawAsset(String userId, String assetGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Update the zones for a specific asset to the zone list specified in the defaultZones.
  
  Specified by:
  
  withdrawAsset in interface AssetClassificationInterface
  
  Parameters:
  
  userId - calling user
  
  assetGUID - unique identifier for the asset to update
  
  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) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Update the zones for a specific asset.
  
  Specified by:
  
  updateAssetZones in interface AssetClassificationInterface
  
  Parameters:
  
  userId - calling user
  
  assetGUID - unique identifier for the asset to update
  
  assetZones - list of zones for the asset - these values override the current values - null means belongs to no zones.
  
  Throws:
  
  InvalidParameterException - guid or userId is null
  
  PropertyServerException - problem accessing property server
  
  UserNotAuthorizedException - security access problem
- updateAssetOwner
  
  public void updateAssetOwner(String userId, String assetGUID, String ownerId, String ownerTypeName, String ownerPropertyName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Update the owner information for a specific asset.
  
  Specified by:
  
  updateAssetOwner in interface AssetClassificationInterface
  
  Parameters:
  
  userId - calling user
  
  assetGUID - unique identifier for the asset to update
  
  ownerId - unique identifier/property of the owner - or null to clear the field
  
  ownerTypeName - name of the type of identifier provided above - or null to clear the field
  
  ownerPropertyName - name of the property that describes the ownerId
  
  Throws:
  
  InvalidParameterException - userId is null
  
  PropertyServerException - problem accessing property server
  
  UserNotAuthorizedException - security access problem
- removeAssetOwner
  
  public void removeAssetOwner(String userId, String assetGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove the ownership classification from an asset.
  
  Specified by:
  
  removeAssetOwner in interface AssetClassificationInterface
  
  Parameters:
  
  userId - calling user
  
  assetGUID - element where the classification needs to be removed.
  
  Throws:
  
  InvalidParameterException - asset 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, Map<String,List<String>> accessGroups) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Add or replace the security tags for an asset or one of its elements.
  
  Specified by:
  
  addSecurityTags in interface AssetClassificationInterface
  
  Parameters:
  
  userId - calling user
  
  assetGUID - unique identifier of asset
  
  assetElementGUID - element to link it to - its type must inherit from Referenceable. If null then the assetGUID is used.
  
  securityLabels - list of security labels defining the security characteristics of the element
  
  securityProperties - Descriptive labels describing origin of the asset
  
  accessGroups - map from operation to list of security groups
  
  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) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove the security tags classification to an asset or one of its elements.
  
  Specified by:
  
  removeSecurityTags in interface AssetClassificationInterface
  
  Parameters:
  
  userId - calling user
  
  assetGUID - unique identifier of asset
  
  assetElementGUID - element where the security tags need to be removed. If null then the assetGUID is used.
  
  Throws:
  
  InvalidParameterException - entity not known, null userId or guid
  
  PropertyServerException - problem accessing property server
  
  UserNotAuthorizedException - security access problem
- addTemplateClassification
  
  public void addTemplateClassification(String userId, String assetGUID, String name, String versionIdentifier, String description, Map<String,String> additionalProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Classify an asset as suitable to be used as a template for cataloguing assets of a similar types.
  
  Specified by:
  
  addTemplateClassification in interface AssetClassificationInterface
  
  Parameters:
  
  userId - calling user
  
  assetGUID - unique identifier of the asset to classify
  
  name - name of the template
  
  versionIdentifier - version identifier for the template eg 1.0
  
  description - description of when, where and how to use the template
  
  additionalProperties - any additional properties
  
  Throws:
  
  InvalidParameterException - asset or element not known, null userId or guid
  
  PropertyServerException - problem accessing property server
  
  UserNotAuthorizedException - security access problem
- removeTemplateClassification
  
  public void removeTemplateClassification(String userId, String assetGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove the classification that indicates that this asset can be used as a template.
  
  Specified by:
  
  removeTemplateClassification in interface AssetClassificationInterface
  
  Parameters:
  
  userId - calling user
  
  assetGUID - unique identifier of the asset to declassify
  
  Throws:
  
  InvalidParameterException - asset or element not known, null userId or guid
  
  PropertyServerException - problem accessing property server
  
  UserNotAuthorizedException - security access problem
- setElementAsDataField
  
  public void setElementAsDataField(String userId, String elementGUID, DataFieldValuesProperties properties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Classify the element to indicate that it describes a data field and supply properties that describe the characteristics of the data values found within.
  
  Specified by:
  
  setElementAsDataField in interface AssetClassificationInterface
  
  Parameters:
  
  userId - calling user
  
  elementGUID - unique identifier of the metadata element to update
  
  properties - descriptive properties for the data field
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- clearElementAsDataField
  
  public void clearElementAsDataField(String userId, String elementGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove the data field designation from the element.
  
  Specified by:
  
  clearElementAsDataField in interface AssetClassificationInterface
  
  Parameters:
  
  userId - calling user
  
  elementGUID - unique identifier of the metadata element to update
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- setConfidenceClassification
  
  public void setConfidenceClassification(String userId, String elementGUID, GovernanceClassificationProperties properties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Classify/reclassify the element (typically an asset) to indicate the level of confidence that the organization has that the data is complete, accurate and up-to-date. The level of confidence is expressed by the levelIdentifier property.
  
  Specified by:
  
  setConfidenceClassification in interface AssetClassificationInterface
  
  Parameters:
  
  userId - calling user
  
  elementGUID - unique identifier of the metadata element to classify
  
  properties - details of the classification
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- clearConfidenceClassification
  
  public void clearConfidenceClassification(String userId, String elementGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove the confidence classification from the element. This normally occurs when the organization has lost track of the level of confidence to assign to the element.
  
  Specified by:
  
  clearConfidenceClassification in interface AssetClassificationInterface
  
  Parameters:
  
  userId - calling user
  
  elementGUID - unique identifier of the metadata element to unclassify
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- setCriticalityClassification
  
  public void setCriticalityClassification(String userId, String elementGUID, GovernanceClassificationProperties properties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Classify/reclassify the element (typically an asset) to indicate how critical the element (or associated resource) is to the organization. The level of criticality is expressed by the levelIdentifier property.
  
  Specified by:
  
  setCriticalityClassification in interface AssetClassificationInterface
  
  Parameters:
  
  userId - calling user
  
  elementGUID - unique identifier of the metadata element to classify
  
  properties - details of the classification
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- clearCriticalityClassification
  
  public void clearCriticalityClassification(String userId, String elementGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove the criticality classification from the element. This normally occurs when the organization has lost track of the level of criticality to assign to the element.
  
  Specified by:
  
  clearCriticalityClassification in interface AssetClassificationInterface
  
  Parameters:
  
  userId - calling user
  
  elementGUID - unique identifier of the metadata element to unclassify
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- setConfidentialityClassification
  
  public void setConfidentialityClassification(String userId, String elementGUID, GovernanceClassificationProperties properties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Classify/reclassify the element (typically a data field, schema attribute or glossary term) to indicate the level of confidentiality that any data associated with the element should be given. If the classification is attached to a glossary term, the level of confidentiality is a suggestion for any element linked to the glossary term via the SemanticAssignment classification. The level of confidence is expressed by the levelIdentifier property.
  
  Specified by:
  
  setConfidentialityClassification in interface AssetClassificationInterface
  
  Parameters:
  
  userId - calling user
  
  elementGUID - unique identifier of the metadata element to classify
  
  properties - details of the classification
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- clearConfidentialityClassification
  
  public void clearConfidentialityClassification(String userId, String elementGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove the confidence classification from the element. This normally occurs when the organization has lost track of the level of confidentiality to assign to the element.
  
  Specified by:
  
  clearConfidentialityClassification in interface AssetClassificationInterface
  
  Parameters:
  
  userId - calling user
  
  elementGUID - unique identifier of the metadata element to unclassify
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- setRetentionClassification
  
  public void setRetentionClassification(String userId, String elementGUID, RetentionClassificationProperties properties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Classify/reclassify the element (typically an asset) to indicate how long the element (or associated resource) is to be retained by the organization. The policy to apply to the element/resource is captured by the retentionBasis property. The dates after which the element/resource is archived and then deleted are specified in the archiveAfter and deleteAfter properties respectively.
  
  Specified by:
  
  setRetentionClassification in interface AssetClassificationInterface
  
  Parameters:
  
  userId - calling user
  
  elementGUID - unique identifier of the metadata element to classify
  
  properties - details of the classification
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- clearRetentionClassification
  
  public void clearRetentionClassification(String userId, String elementGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove the retention classification from the element. This normally occurs when the organization has lost track of, or no longer needs to track the retention period to assign to the element.
  
  Specified by:
  
  clearRetentionClassification in interface AssetClassificationInterface
  
  Parameters:
  
  userId - calling user
  
  elementGUID - unique identifier of the metadata element to unclassify
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- addGovernanceDefinitionToElement
  
  public void addGovernanceDefinitionToElement(String userId, String definitionGUID, String elementGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Link a governance definition to an element using the GovernedBy relationship.
  
  Specified by:
  
  addGovernanceDefinitionToElement in interface AssetClassificationInterface
  
  Parameters:
  
  userId - calling user
  
  definitionGUID - identifier of the governance definition to link
  
  elementGUID - unique identifier of the metadata element to link
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- removeGovernanceDefinitionFromElement
  
  public void removeGovernanceDefinitionFromElement(String userId, String definitionGUID, String elementGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove the GovernedBy relationship between a governance definition and an element.
  
  Specified by:
  
  removeGovernanceDefinitionFromElement in interface AssetClassificationInterface
  
  Parameters:
  
  userId - calling user
  
  definitionGUID - identifier of the governance definition to link
  
  elementGUID - unique identifier of the metadata element to update
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- createConnection
  
  public String createConnection(String userId, ConnectionProperties connectionProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a new metadata element to represent a connection. Classifications can be added later to define the type of connection.
  
  Specified by:
  
  createConnection in interface AssetConnectionManagementInterface
  
  Parameters:
  
  userId - calling user
  
  connectionProperties - properties to store
  
  Returns:
  
  unique identifier of the new metadata element
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- createConnectionFromTemplate
  
  public String createConnectionFromTemplate(String userId, String templateGUID, TemplateProperties templateProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a new metadata element to represent a connection using an existing metadata element as a template. The template defines additional classifications and relationships that should be added to the new connection.
  
  Specified by:
  
  createConnectionFromTemplate in interface AssetConnectionManagementInterface
  
  Parameters:
  
  userId - calling user
  
  templateGUID - unique identifier of the metadata element to copy
  
  templateProperties - properties that override the template
  
  Returns:
  
  unique identifier of the new metadata element
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- updateConnection
  
  public void updateConnection(String userId, String connectionGUID, boolean isMergeUpdate, ConnectionProperties connectionProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Update the metadata element representing a connection.
  
  Specified by:
  
  updateConnection in interface AssetConnectionManagementInterface
  
  Parameters:
  
  userId - calling user
  
  connectionGUID - unique identifier of the metadata element to update
  
  isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
  
  connectionProperties - new properties for this element
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- setupConnectorType
  
  public void setupConnectorType(String userId, String connectionGUID, String connectorTypeGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a relationship between a connection and a connector type.
  
  Specified by:
  
  setupConnectorType in interface AssetConnectionManagementInterface
  
  Parameters:
  
  userId - calling user
  
  connectionGUID - unique identifier of the connection in the external asset manager
  
  connectorTypeGUID - unique identifier of the connector type in the external asset manager
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- clearConnectorType
  
  public void clearConnectorType(String userId, String connectionGUID, String connectorTypeGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove a relationship between a connection and a connector type.
  
  Specified by:
  
  clearConnectorType in interface AssetConnectionManagementInterface
  
  Parameters:
  
  userId - calling user
  
  connectionGUID - unique identifier of the connection in the external asset manager
  
  connectorTypeGUID - unique identifier of the connector type in the external asset manager
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- setupEndpoint
  
  public void setupEndpoint(String userId, String connectionGUID, String endpointGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a relationship between a connection and an endpoint.
  
  Specified by:
  
  setupEndpoint in interface AssetConnectionManagementInterface
  
  Parameters:
  
  userId - calling user
  
  connectionGUID - unique identifier of the connection in the external asset manager
  
  endpointGUID - unique identifier of the endpoint in the external asset manager
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- clearEndpoint
  
  public void clearEndpoint(String userId, String connectionGUID, String endpointGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove a relationship between a connection and an endpoint.
  
  Specified by:
  
  clearEndpoint in interface AssetConnectionManagementInterface
  
  Parameters:
  
  userId - calling user
  
  connectionGUID - unique identifier of the connection in the external asset manager
  
  endpointGUID - unique identifier of the endpoint in the external asset manager
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- setupEmbeddedConnection
  
  public void setupEmbeddedConnection(String userId, String connectionGUID, int position, String displayName, Map<String,Object> arguments, String embeddedConnectionGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a relationship between a virtual connection and an embedded connection.
  
  Specified by:
  
  setupEmbeddedConnection in interface AssetConnectionManagementInterface
  
  Parameters:
  
  userId - calling user
  
  connectionGUID - unique identifier of the virtual connection in the external asset manager
  
  position - which order should this connection be processed
  
  arguments - What additional properties should be passed to the embedded connector via the configuration properties
  
  displayName - what does this connector signify?
  
  embeddedConnectionGUID - unique identifier of the embedded connection in the external asset manager
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- clearEmbeddedConnection
  
  public void clearEmbeddedConnection(String userId, String connectionGUID, String embeddedConnectionGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove a relationship between a virtual connection and an embedded connection.
  
  Specified by:
  
  clearEmbeddedConnection in interface AssetConnectionManagementInterface
  
  Parameters:
  
  userId - calling user
  
  connectionGUID - unique identifier of the virtual connection in the external asset manager
  
  embeddedConnectionGUID - unique identifier of the embedded connection in the external asset manager
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- setupAssetConnection
  
  public void setupAssetConnection(String userId, String assetGUID, String assetSummary, String connectionGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a relationship between an asset and its connection.
  
  Specified by:
  
  setupAssetConnection in interface AssetConnectionManagementInterface
  
  Parameters:
  
  userId - calling user
  
  assetGUID - unique identifier of the asset
  
  assetSummary - summary of the asset that is stored in the relationship between the asset and the connection.
  
  connectionGUID - unique identifier of the connection
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- clearAssetConnection
  
  public void clearAssetConnection(String userId, String assetGUID, String connectionGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove a relationship between an asset and its connection.
  
  Specified by:
  
  clearAssetConnection in interface AssetConnectionManagementInterface
  
  Parameters:
  
  userId - calling user
  
  assetGUID - unique identifier of the asset
  
  connectionGUID - unique identifier of the connection
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- removeConnection
  
  public void removeConnection(String userId, String connectionGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove the metadata element representing a connection.
  
  Specified by:
  
  removeConnection in interface AssetConnectionManagementInterface
  
  Parameters:
  
  userId - calling user
  
  connectionGUID - unique identifier of the metadata element to remove
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- findConnections
  
  public List<ConnectionElement> findConnections(String userId, String searchString, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of connection metadata elements that contain the search string. The search string is treated as a regular expression.
  
  Specified by:
  
  findConnections in interface AssetConnectionManagementInterface
  
  Parameters:
  
  userId - calling user
  
  searchString - string to find in the properties
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of matching metadata elements
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- scanConnections
  
  public List<ConnectionElement> scanConnections(String userId, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Step through the connections visible to this caller.
  
  Specified by:
  
  scanConnections in interface AssetConnectionManagementInterface
  
  Parameters:
  
  userId - calling user
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of metadata elements
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- getConnectionsByName
  
  public List<ConnectionElement> getConnectionsByName(String userId, String name, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of connection metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
  
  Specified by:
  
  getConnectionsByName in interface AssetConnectionManagementInterface
  
  Parameters:
  
  userId - calling user
  
  name - name to search for
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of matching metadata elements
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- getConnectionByGUID
  
  public ConnectionElement getConnectionByGUID(String userId, String connectionGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the connection metadata element with the supplied unique identifier.
  
  Specified by:
  
  getConnectionByGUID in interface AssetConnectionManagementInterface
  
  Parameters:
  
  userId - calling user
  
  connectionGUID - unique identifier of the requested metadata element
  
  Returns:
  
  matching metadata element
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- createEndpoint
  
  public String createEndpoint(String userId, EndpointProperties endpointProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a new metadata element to represent an endpoint. Classifications can be added later to define the type of endpoint.
  
  Specified by:
  
  createEndpoint in interface AssetConnectionManagementInterface
  
  Parameters:
  
  userId - calling user
  
  endpointProperties - properties to store
  
  Returns:
  
  unique identifier of the new metadata element
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- createEndpointFromTemplate
  
  public String createEndpointFromTemplate(String userId, String templateGUID, TemplateProperties templateProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a new metadata element to represent an endpoint using an existing metadata element as a template. The template defines additional classifications and relationships that should be added to the new endpoint.
  
  Specified by:
  
  createEndpointFromTemplate in interface AssetConnectionManagementInterface
  
  Parameters:
  
  userId - calling user
  
  templateGUID - unique identifier of the metadata element to copy
  
  templateProperties - properties that override the template
  
  Returns:
  
  unique identifier of the new metadata element
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- updateEndpoint
  
  public void updateEndpoint(String userId, boolean isMergeUpdate, String endpointGUID, EndpointProperties endpointProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Update the metadata element representing a endpoint.
  
  Specified by:
  
  updateEndpoint in interface AssetConnectionManagementInterface
  
  Parameters:
  
  userId - calling user
  
  isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
  
  endpointGUID - unique identifier of the metadata element to update
  
  endpointProperties - new properties for this element
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- removeEndpoint
  
  public void removeEndpoint(String userId, String endpointGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove the metadata element representing a endpoint.
  
  Specified by:
  
  removeEndpoint in interface AssetConnectionManagementInterface
  
  Parameters:
  
  userId - calling user
  
  endpointGUID - unique identifier of the metadata element to remove
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- findEndpoints
  
  public List<EndpointElement> findEndpoints(String userId, String searchString, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of endpoint metadata elements that contain the search string. The search string is treated as a regular expression.
  
  Specified by:
  
  findEndpoints in interface AssetConnectionManagementInterface
  
  Parameters:
  
  userId - calling user
  
  searchString - string to find in the properties
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of matching metadata elements
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- getEndpointsByName
  
  public List<EndpointElement> getEndpointsByName(String userId, String name, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of endpoint metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
  
  Specified by:
  
  getEndpointsByName in interface AssetConnectionManagementInterface
  
  Parameters:
  
  userId - calling user
  
  name - name to search for
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of matching metadata elements
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- getEndpointByGUID
  
  public EndpointElement getEndpointByGUID(String userId, String endpointGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the endpoint metadata element with the supplied unique identifier.
  
  Specified by:
  
  getEndpointByGUID in interface AssetConnectionManagementInterface
  
  Parameters:
  
  userId - calling user
  
  endpointGUID - unique identifier of the requested metadata element
  
  Returns:
  
  matching metadata element
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- findConnectorTypes
  
  public List<ConnectorTypeElement> findConnectorTypes(String userId, String searchString, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of connectorType metadata elements that contain the search string. The search string is treated as a regular expression.
  
  Specified by:
  
  findConnectorTypes in interface AssetConnectionManagementInterface
  
  Parameters:
  
  userId - calling user
  
  searchString - string to find in the properties
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of matching metadata elements
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- getConnectorTypesByName
  
  public List<ConnectorTypeElement> getConnectorTypesByName(String userId, String name, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of connectorType metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
  
  Specified by:
  
  getConnectorTypesByName in interface AssetConnectionManagementInterface
  
  Parameters:
  
  userId - calling user
  
  name - name to search for
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of matching metadata elements
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- getConnectorTypeByGUID
  
  public ConnectorTypeElement getConnectorTypeByGUID(String userId, String connectorTypeGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the connectorType metadata element with the supplied unique identifier.
  
  Specified by:
  
  getConnectorTypeByGUID in interface AssetConnectionManagementInterface
  
  Parameters:
  
  userId - calling user
  
  connectorTypeGUID - unique identifier of the requested metadata element
  
  Returns:
  
  matching metadata element
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- getAssetsByName
  
  public List<AssetElement> getAssetsByName(String userId, String name, int startFrom, int pageSize) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException
  
  Return a list of assets with the requested name.
  
  Specified by:
  
  getAssetsByName in interface AssetReviewInterface
  
  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
  
  Returns:
  
  list of unique identifiers of assets with matching name.
  
  Throws:
  
  InvalidParameterException - the name 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<AssetElement> findAssets(String userId, String searchString, int startFrom, int pageSize) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException
  
  Return a list of assets with the requested search string in their name, qualified name or description.
  
  Specified by:
  
  findAssets in interface AssetReviewInterface
  
  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
  
  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
- getAssetSummary
  
  public AssetElement getAssetSummary(String userId, String assetGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Return the basic attributes of an asset.
  
  Specified by:
  
  getAssetSummary in interface AssetReviewInterface
  
  Parameters:
  
  userId - calling user
  
  assetGUID - unique identifier of the asset
  
  Returns:
  
  basic asset properties
  
  Throws:
  
  InvalidParameterException - one of the parameters is null or invalid.
  
  UserNotAuthorizedException - user not authorized to issue this request.
  
  PropertyServerException - there was a problem that occurred within the property server.
- getConnectorToAsset
  
  public Connector getConnectorToAsset(String userId, String assetGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Return a connector for the asset to enable the calling user to access the content.
  
  Specified by:
  
  getConnectorToAsset in interface AssetReviewInterface
  
  Parameters:
  
  userId - calling user
  
  assetGUID - unique identifier of the asset
  
  Returns:
  
  connector object
  
  Throws:
  
  InvalidParameterException - one of the parameters is null or invalid.
  
  UserNotAuthorizedException - user not authorized to issue this request.
  
  PropertyServerException - there was a problem that occurred within the property server.
- getSurveyReports
  
  public List<SurveyReport> getSurveyReports(String userId, String assetGUID, int startingFrom, int maximumResults) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Return the survey reports about the asset.
  
  Specified by:
  
  getSurveyReports in interface AssetReviewInterface
  
  Parameters:
  
  userId - calling user
  
  assetGUID - unique identifier of the asset
  
  startingFrom - position in the list (used when there are so many reports that paging is needed
  
  maximumResults - maximum number of elements to return on this call
  
  Returns:
  
  list of discovery analysis reports
  
  Throws:
  
  InvalidParameterException - one of the parameters is null or invalid.
  
  UserNotAuthorizedException - user not authorized to issue this request.
  
  PropertyServerException - there was a problem that occurred within the property server.
- getTypesOfAnnotation
  
  public List<String> getTypesOfAnnotation(String userId) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Return the annotation subtype names.
  
  Specified by:
  
  getTypesOfAnnotation in interface AssetReviewInterface
  
  Parameters:
  
  userId - calling user
  
  Returns:
  
  list of type names that are subtypes of annotation
  
  Throws:
  
  InvalidParameterException - full path or userId is null
  
  PropertyServerException - problem accessing property server
  
  UserNotAuthorizedException - security access problem
- getTypesOfAnnotationWithDescriptions
  
  public Map<String,String> getTypesOfAnnotationWithDescriptions(String userId) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Return the annotation subtype names mapped to their descriptions.
  
  Specified by:
  
  getTypesOfAnnotationWithDescriptions in interface AssetReviewInterface
  
  Parameters:
  
  userId - calling user
  
  Returns:
  
  map of type names that are subtypes of annotation to their descriptions
  
  Throws:
  
  InvalidParameterException - full path or userId is null
  
  PropertyServerException - problem accessing property server
  
  UserNotAuthorizedException - security access problem
- getSurveyReportAnnotations
  
  public List<Annotation> getSurveyReportAnnotations(String userId, String surveyReportGUID, AnnotationStatus annotationStatus, int startingFrom, int maximumResults) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Return the annotations linked directly to the report.
  
  Specified by:
  
  getSurveyReportAnnotations in interface AssetReviewInterface
  
  Parameters:
  
  userId - identifier of calling user
  
  surveyReportGUID - identifier of the survey report.
  
  annotationStatus - status of the desired annotations - null means all statuses.
  
  startingFrom - initial position in the stored list.
  
  maximumResults - maximum number of definitions to return on this call.
  
  Returns:
  
  list of annotations
  
  Throws:
  
  InvalidParameterException - one of the parameters is null or invalid.
  
  UserNotAuthorizedException - user not authorized to issue this request.
  
  PropertyServerException - there was a problem that occurred within the property server.
- getExtendedAnnotations
  
  public List<Annotation> getExtendedAnnotations(String userId, String annotationGUID, AnnotationStatus annotationStatus, int startingFrom, int maximumResults) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Return any annotations attached to this annotation.
  
  Specified by:
  
  getExtendedAnnotations in interface AssetReviewInterface
  
  Parameters:
  
  userId - identifier of calling user
  
  annotationGUID - anchor annotation
  
  annotationStatus - status of the desired annotations - null means all statuses.
  
  startingFrom - starting position in the list
  
  maximumResults - maximum number of annotations that can be returned.
  
  Returns:
  
  list of Annotation objects
  
  Throws:
  
  InvalidParameterException - one of the parameters is null or invalid.
  
  UserNotAuthorizedException - user not authorized to issue this request.
  
  PropertyServerException - there was a problem that occurred within the property server.
- getDataFieldClassifiedElements
  
  public List<ElementStub> getDataFieldClassifiedElements(String userId, DataFieldQueryProperties properties, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Return information about the elements classified with the DataField classification.
  
  Specified by:
  
  getDataFieldClassifiedElements in interface AssetReviewInterface
  
  Parameters:
  
  userId - calling user
  
  properties - values to match on
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of element stubs
  
  Throws:
  
  InvalidParameterException - qualifiedName or userId is null
  
  PropertyServerException - problem accessing property server
  
  UserNotAuthorizedException - security access problem
- getConfidenceClassifiedElements
  
  public List<ElementStub> getConfidenceClassifiedElements(String userId, boolean returnSpecificLevel, int levelIdentifier, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Return information about the elements classified with the confidence classification.
  
  Specified by:
  
  getConfidenceClassifiedElements in interface AssetReviewInterface
  
  Parameters:
  
  userId - calling user
  
  returnSpecificLevel - should the results be filtered by levelIdentifier?
  
  levelIdentifier - the identifier to filter by (if returnSpecificLevel=true)
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of element stubs
  
  Throws:
  
  InvalidParameterException - qualifiedName or userId is null
  
  PropertyServerException - problem accessing property server
  
  UserNotAuthorizedException - security access problem
- getCriticalityClassifiedElements
  
  public List<ElementStub> getCriticalityClassifiedElements(String userId, boolean returnSpecificLevel, int levelIdentifier, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Return information about the elements classified with the criticality classification.
  
  Specified by:
  
  getCriticalityClassifiedElements in interface AssetReviewInterface
  
  Parameters:
  
  userId - calling user
  
  returnSpecificLevel - should the results be filtered by levelIdentifier?
  
  levelIdentifier - the identifier to filter by (if returnSpecificLevel=true)
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of element stubs
  
  Throws:
  
  InvalidParameterException - qualifiedName or userId is null
  
  PropertyServerException - problem accessing property server
  
  UserNotAuthorizedException - security access problem
- getConfidentialityClassifiedElements
  
  public List<ElementStub> getConfidentialityClassifiedElements(String userId, boolean returnSpecificLevel, int levelIdentifier, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Return information about the elements classified with the confidentiality classification.
  
  Specified by:
  
  getConfidentialityClassifiedElements in interface AssetReviewInterface
  
  Parameters:
  
  userId - calling user
  
  returnSpecificLevel - should the results be filtered by levelIdentifier?
  
  levelIdentifier - the identifier to filter by (if returnSpecificLevel=true)
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of element stubs
  
  Throws:
  
  InvalidParameterException - qualifiedName or userId is null
  
  PropertyServerException - problem accessing property server
  
  UserNotAuthorizedException - security access problem
- getRetentionClassifiedElements
  
  public List<ElementStub> getRetentionClassifiedElements(String userId, boolean returnSpecificBasisIdentifier, int basisIdentifier, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Return information about the elements classified with the retention classification.
  
  Specified by:
  
  getRetentionClassifiedElements in interface AssetReviewInterface
  
  Parameters:
  
  userId - calling user
  
  returnSpecificBasisIdentifier - should the results be filtered by basisIdentifier?
  
  basisIdentifier - the identifier to filter by (if returnSpecificBasisIdentifier=true)
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of element stubs
  
  Throws:
  
  InvalidParameterException - qualifiedName or userId is null
  
  PropertyServerException - problem accessing property server
  
  UserNotAuthorizedException - security access problem
- getSecurityTaggedElements
  
  public List<ElementStub> getSecurityTaggedElements(String userId, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Return information about the contents of a subject area such as the glossaries, reference data sets and quality definitions.
  
  Specified by:
  
  getSecurityTaggedElements in interface AssetReviewInterface
  
  Parameters:
  
  userId - calling user
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of element stubs
  
  Throws:
  
  InvalidParameterException - qualifiedName or userId is null
  
  PropertyServerException - problem accessing property server
  
  UserNotAuthorizedException - security access problem
- getOwnersElements
  
  public List<ElementStub> getOwnersElements(String userId, String owner, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Return information about the contents of a subject area such as the glossaries, reference data sets and quality definitions.
  
  Specified by:
  
  getOwnersElements in interface AssetReviewInterface
  
  Parameters:
  
  userId - calling user
  
  owner - unique identifier for the owner
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of element stubs
  
  Throws:
  
  InvalidParameterException - qualifiedName or userId is null
  
  PropertyServerException - problem accessing property server
  
  UserNotAuthorizedException - security access problem
- getAssetsByOrigin
  
  public List<AssetElement> getAssetsByOrigin(String userId, FindAssetOriginProperties properties, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Return information about the assets from a specific origin.
  
  Specified by:
  
  getAssetsByOrigin in interface AssetReviewInterface
  
  Parameters:
  
  userId - calling user
  
  properties - values to search on - null means any value
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of the assets
  
  Throws:
  
  InvalidParameterException - qualifiedName or userId is null
  
  PropertyServerException - problem accessing property server
  
  UserNotAuthorizedException - security access problem
- getMembersOfSubjectArea
  
  public List<ElementStub> getMembersOfSubjectArea(String userId, String subjectAreaName, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Return information about the contents of a subject area such as the glossaries, reference data sets and quality definitions.
  
  Specified by:
  
  getMembersOfSubjectArea in interface AssetReviewInterface
  
  Parameters:
  
  userId - calling user
  
  subjectAreaName - unique identifier for the subject area
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  effectiveTime - the time that the retrieved elements must be effective for
  
  forLineage - return elements marked with the Memento classification?
  
  forDuplicateProcessing - do not merge elements marked as duplicates?
  
  Returns:
  
  list of element stubs
  
  Throws:
  
  InvalidParameterException - qualifiedName or userId is null
  
  PropertyServerException - problem accessing property server
  
  UserNotAuthorizedException - security access problem
- getMeanings
  
  public List<GlossaryTermElement> getMeanings(String userId, String elementGUID, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the glossary terms linked via a "SemanticAssignment" relationship to the requested element.
  
  Specified by:
  
  getMeanings in interface AssetReviewInterface
  
  Parameters:
  
  userId - calling user
  
  elementGUID - unique identifier of the element
  
  startFrom - index of the list to start from (0 for start)
  
  pageSize - maximum number of elements to return.
  
  effectiveTime - the time that the retrieved elements must be effective for
  
  forLineage - return elements marked with the Memento classification?
  
  forDuplicateProcessing - do not merge elements marked as duplicates?
  
  Returns:
  
  list of related elements
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- getSemanticAssignees
  
  public List<RelatedElement> getSemanticAssignees(String userId, String glossaryTermGUID, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the elements linked via a "SemanticAssignment" relationship to the requested glossary term.
  
  Specified by:
  
  getSemanticAssignees in interface AssetReviewInterface
  
  Parameters:
  
  userId - calling user
  
  glossaryTermGUID - unique identifier of the glossary term that the returned elements are linked to
  
  startFrom - index of the list to start from (0 for start)
  
  pageSize - maximum number of elements to return.
  
  effectiveTime - the time that the retrieved elements must be effective for
  
  forLineage - return elements marked with the Memento classification?
  
  forDuplicateProcessing - do not merge elements marked as duplicates?
  
  Returns:
  
  list of related elements
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- getGovernedByDefinitions
  
  public List<GovernanceDefinitionElement> getGovernedByDefinitions(String userId, String elementGUID, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the governance definitions linked via a "GovernedBy" relationship to the requested element.
  
  Specified by:
  
  getGovernedByDefinitions in interface AssetReviewInterface
  
  Parameters:
  
  userId - calling user
  
  elementGUID - unique identifier of the element
  
  startFrom - index of the list to start from (0 for start)
  
  pageSize - maximum number of elements to return.
  
  effectiveTime - the time that the retrieved elements must be effective for
  
  forLineage - return elements marked with the Memento classification?
  
  forDuplicateProcessing - do not merge elements marked as duplicates?
  
  Returns:
  
  list of related elements
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- getGovernedElements
  
  public List<RelatedElement> getGovernedElements(String userId, String governanceDefinitionGUID, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the elements linked via a "GovernedBy" relationship to the requested governance definition.
  
  Specified by:
  
  getGovernedElements in interface AssetReviewInterface
  
  Parameters:
  
  userId - calling user
  
  governanceDefinitionGUID - unique identifier of the governance definition that the returned elements are linked to
  
  startFrom - index of the list to start from (0 for start)
  
  pageSize - maximum number of elements to return.
  
  effectiveTime - the time that the retrieved elements must be effective for
  
  forLineage - return elements marked with the Memento classification?
  
  forDuplicateProcessing - do not merge elements marked as duplicates?
  
  Returns:
  
  list of related elements
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- getSourceElements
  
  public List<RelatedElement> getSourceElements(String userId, String elementGUID, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the elements linked via a "SourceFrom" relationship to the requested element. The elements returned were used to create the requested element. Typically, only one element is returned.
  
  Specified by:
  
  getSourceElements in interface AssetReviewInterface
  
  Parameters:
  
  userId - calling user
  
  elementGUID - unique identifier of the element
  
  startFrom - index of the list to start from (0 for start)
  
  pageSize - maximum number of elements to return.
  
  effectiveTime - the time that the retrieved elements must be effective for
  
  forLineage - return elements marked with the Memento classification?
  
  forDuplicateProcessing - do not merge elements marked as duplicates?
  
  Returns:
  
  list of related elements
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- getElementsSourceFrom
  
  public List<RelatedElement> getElementsSourceFrom(String userId, String elementGUID, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the elements linked via a "SourceFrom" relationship to the requested element. The elements returned were created using the requested element as a template.
  
  Specified by:
  
  getElementsSourceFrom in interface AssetReviewInterface
  
  Parameters:
  
  userId - calling user
  
  elementGUID - unique identifier of the element that the returned elements are linked to
  
  startFrom - index of the list to start from (0 for start)
  
  pageSize - maximum number of elements to return.
  
  effectiveTime - the time that the retrieved elements must be effective for
  
  forLineage - return elements marked with the Memento classification?
  
  forDuplicateProcessing - do not merge elements marked as duplicates?
  
  Returns:
  
  list of related elements
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- deleteAsset
  
  public void deleteAsset(String userId, String assetGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Deletes an asset and all of its associated elements such as schema, connections (unless they are linked to another asset), discovery reports and associated feedback. Given the depth of the delete request performed by this call, it should be used with care.
  
  Specified by:
  
  deleteAsset in interface AssetDecommissioningInterface
  
  Parameters:
  
  userId - calling user
  
  assetGUID - unique identifier of the asset to remove
  
  Throws:
  
  InvalidParameterException - full path or userId is null
  
  PropertyServerException - problem accessing property server
  
  UserNotAuthorizedException - security access problem
- getCollections
  
  public List<CollectionElement> getCollections(String userId, String parentGUID, int startFrom, int pageSize) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException
  
  Returns the list of collections that are linked off of the supplied element.
  
  Specified by:
  
  getCollections in interface AssetCollectionInterface
  
  Parameters:
  
  userId - userId of user making request
  
  parentGUID - unique identifier of referenceable object (typically a personal profile, project or community) that the collections hang off of.
  
  startFrom - index of the list to start from (0 for start)
  
  pageSize - maximum number of elements to return
  
  Returns:
  
  a list of collections
  
  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.
- getCollection
  
  public CollectionElement getCollection(String userId, String collectionGUID) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException
  
  Return the properties of a specific collection.
  
  Specified by:
  
  getCollection in interface AssetCollectionInterface
  
  Parameters:
  
  userId - userId of user making request.
  
  collectionGUID - unique identifier of the required connection.
  
  Returns:
  
  collection properties
  
  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.
- findCollections
  
  public List<CollectionElement> findCollections(String userId, String searchString, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of collection metadata elements that contain the search string. The search string is treated as a regular expression.
  
  Specified by:
  
  findCollections in interface AssetCollectionInterface
  
  Parameters:
  
  userId - calling user
  
  searchString - string to find in the properties
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of matching metadata elements
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- getCollectionsByName
  
  public List<CollectionElement> getCollectionsByName(String userId, String name, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of collection metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
  
  Specified by:
  
  getCollectionsByName in interface AssetCollectionInterface
  
  Parameters:
  
  userId - calling user
  
  name - name to search for
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of matching metadata elements
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- createCollection
  
  public String createCollection(String userId, CollectionProperties properties) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException
  
  Create a new generic collection.
  
  Specified by:
  
  createCollection in interface AssetCollectionInterface
  
  Parameters:
  
  userId - userId of user making request.
  
  properties - description of the collection.
  
  Returns:
  
  unique identifier of the newly created Collection
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid.
  
  PropertyServerException - there is a problem retrieving information from the property server(s).
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.
- createFolderCollection
  
  public String createFolderCollection(String userId, CollectionFolderProperties properties) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException
  
  Create a collection that acts like a folder with an order.
  
  Specified by:
  
  createFolderCollection in interface AssetCollectionInterface
  
  Parameters:
  
  userId - userId of user making request.
  
  properties - description of the collection.
  
  Returns:
  
  unique identifier of the newly created Collection
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid.
  
  PropertyServerException - there is a problem retrieving information from the property server(s).
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.
- updateCollection
  
  public void updateCollection(String userId, String collectionGUID, boolean isMergeUpdate, CollectionProperties properties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Update the metadata element representing a collection.
  
  Specified by:
  
  updateCollection in interface AssetCollectionInterface
  
  Parameters:
  
  userId - calling user
  
  collectionGUID - unique identifier of the metadata element to update
  
  isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
  
  properties - new properties for this element
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- removeCollection
  
  public void removeCollection(String userId, String collectionGUID) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException
  
  Delete a collection. It is deleted from all parent elements. If members are anchored to the collection then they are also deleted.
  
  Specified by:
  
  removeCollection in interface AssetCollectionInterface
  
  Parameters:
  
  userId - userId of user making request.
  
  collectionGUID - unique identifier of the collection.
  
  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.
- getCollectionMembers
  
  public List<CollectionMember> getCollectionMembers(String userId, String collectionGUID, int startFrom, int pageSize) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException
  
  Return a list of elements that are a member of a collection.
  
  Specified by:
  
  getCollectionMembers in interface AssetCollectionInterface
  
  Parameters:
  
  userId - userId of user making request.
  
  collectionGUID - unique identifier of the collection.
  
  startFrom - index of the list to start from (0 for start)
  
  pageSize - maximum number of elements to return.
  
  Returns:
  
  list of asset details
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid.
  
  PropertyServerException - there is a problem retrieving information from the property server(s).
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.
- getCollectionMember
  
  public CollectionMember getCollectionMember(String userId, String collectionGUID, String memberGUID) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException
  
  Return details of the membership between a collection and a specific member of the collection.
  
  Specified by:
  
  getCollectionMember in interface AssetCollectionInterface
  
  Parameters:
  
  userId - userId of user making request.
  
  collectionGUID - unique identifier of the collection.
  
  memberGUID - unique identifier of the element who is a member of the collection.
  
  Returns:
  
  list of asset details
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid.
  
  PropertyServerException - there is a problem retrieving information from the property server(s).
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.
- getElementsCollections
  
  public List<CollectionElement> getElementsCollections(String userId, String elementGUID, int startFrom, int pageSize) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException
  
  Return a list of collections that the supplied element is a member of.
  
  Specified by:
  
  getElementsCollections in interface AssetCollectionInterface
  
  Parameters:
  
  userId - userId of user making request.
  
  elementGUID - unique identifier of the collection.
  
  startFrom - index of the list to start from (0 for start)
  
  pageSize - maximum number of elements to return.
  
  Returns:
  
  list of asset details
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid.
  
  PropertyServerException - there is a problem retrieving information from the property server(s).
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.
- updateCollectionMembership
  
  public void updateCollectionMembership(String userId, String collectionGUID, CollectionMembershipProperties properties, boolean isMergeUpdate, String elementGUID) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException
  
  Add an element to a collection (or update its membership properties).
  
  Specified by:
  
  updateCollectionMembership in interface AssetCollectionInterface
  
  Parameters:
  
  userId - userId of user making request.
  
  collectionGUID - unique identifier of the collection.
  
  properties - new properties
  
  isMergeUpdate - should the properties be merged with the existing properties or replace them?
  
  elementGUID - unique identifier of the element.
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid.
  
  PropertyServerException - there is a problem updating information in the property server(s).
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.
- removeFromCollection
  
  public void removeFromCollection(String userId, String collectionGUID, String elementGUID) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException
  
  Remove an element from a collection.
  
  Specified by:
  
  removeFromCollection in interface AssetCollectionInterface
  
  Parameters:
  
  userId - userId of user making request.
  
  collectionGUID - unique identifier of the collection.
  
  elementGUID - unique identifier of the element.
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid.
  
  PropertyServerException - there is a problem updating information in the property server(s).
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.

Class AssetOwner

Field Summary

Fields inherited from class org.odpi.openmetadata.accessservices.assetowner.client.AssetOwnerBaseClient

Fields inherited from class org.odpi.openmetadata.frameworkservices.ocf.metadatamanagement.client.ConnectedAssetClientBase

Constructor Summary

Method Summary

Methods inherited from class org.odpi.openmetadata.accessservices.assetowner.client.AssetOwnerBaseClient

Methods inherited from class org.odpi.openmetadata.frameworkservices.ocf.metadatamanagement.client.ConnectedAssetClientBase

Methods inherited from class java.lang.Object

Methods inherited from interface org.odpi.openmetadata.accessservices.assetowner.api.AssetReviewInterface

Constructor Details

AssetOwner

AssetOwner

AssetOwner

AssetOwner

AssetOwner

Method Details

getTypesOfAsset

getTypesOfAssetWithDescriptions

addAssetToCatalog

addAssetToCatalog

addAssetToCatalogUsingTemplate

updateAsset

setupRelatedAsset

getAssetRelationship

updateAssetRelationship

clearAssetRelationship

getRelatedAssetsAtEnd2

getRelatedAssetsAtEnd1

addCombinedSchemaToAsset

addSchemaTypeToAsset

attachSchemaTypeToAsset

detachSchemaTypeFromAsset

deleteAssetSchemaType

createSchemaType

createAnchoredSchemaType

createSchemaTypeFromTemplate

updateSchemaType

setupSchemaTypeParent

clearSchemaTypeParent

setupSchemaElementRelationship

clearSchemaElementRelationship

removeSchemaType

findSchemaType

getSchemaTypeForElement

getSchemaTypeByName

getSchemaTypeByGUID

getSchemaTypeParent

addSchemaAttributes

addSchemaAttribute

createSchemaAttributeFromTemplate

updateSchemaAttribute

setSchemaElementAsCalculatedValue

clearSchemaElementAsCalculatedValue

removeSchemaAttribute

findSchemaAttributes

getNestedSchemaAttributes

getSchemaAttributesByName

getSchemaAttributeByGUID

addConnectionToAsset

addSemanticAssignment

addSemanticAssignment

removeSemanticAssignment

addAssetOrigin

removeAssetOrigin

publishAsset

withdrawAsset

updateAssetZones

updateAssetOwner

removeAssetOwner

addSecurityTags

removeSecurityTags

addTemplateClassification

removeTemplateClassification

setElementAsDataField

clearElementAsDataField

setConfidenceClassification

clearConfidenceClassification

setCriticalityClassification

clearCriticalityClassification