java.lang.Object
- org.odpi.openmetadata.commonservices.ocf.metadatamanagement.client.ConnectedAssetClientBase
- - org.odpi.openmetadata.accessservices.assetowner.client.AssetOwner

All Implemented Interfaces:

AssetClassificationInterface, AssetConnectionManagementInterface, AssetDecommissioningInterface, AssetKnowledgeInterface, AssetOnboardingInterface, AssetReviewInterface, ConnectorFactoryInterface

Direct Known Subclasses:

AvroFileAssetOwner, CSVFileAssetOwner, FileSystemAssetOwner, ValidValuesAssetOwner
```
public class AssetOwner
extends ConnectedAssetClientBase
implements AssetKnowledgeInterface, AssetOnboardingInterface, AssetClassificationInterface, AssetConnectionManagementInterface, 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
Modifier and Type Field Description

protected AssetOwnerRESTClient restClient
- Fields inherited from class org.odpi.openmetadata.commonservices.ocf.metadatamanagement.client.ConnectedAssetClientBase
  auditLog, invalidParameterHandler, nullRequestBody, 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

All Methods Instance Methods Concrete Methods Deprecated Methods
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 displayName, 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.
`String`	`addSchemaAttribute(String serverName, 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 serverName, 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)`	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`	`addTemplateClassification(String userId, String assetGUID, String name, String description, Map<String,String> additionalProperties)`	Classify an asset as suitable to be used as a template for cataloguing assets of a similar types.
`void`	`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`	`clearConnectorType(String userId, String connectionGUID, String connectorTypeGUID)`	Remove a relationship between a connection and a connector type.
`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.
`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.
`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<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.
`AssetUniverse`	`getAssetProperties(String userId, String assetGUID)`	Returns a comprehensive collection of properties about the requested asset.
`List<AssetElement>`	`getAssetsByName(String userId, String name, int startFrom, int pageSize)`	Return a list of assets with the requested name.
`AssetElement`	`getAssetSummary(String userId, String assetGUID)`	Return the basic attributes of an asset.
`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<DiscoveryAnalysisReport>`	`getDiscoveryAnalysisReports(String userId, String assetGUID, int startingFrom, int maximumResults)`	Return the discovery analysis reports about the asset.
`List<Annotation>`	`getDiscoveryReportAnnotations(String userId, String discoveryReportGUID, AnnotationStatus annotationStatus, int startingFrom, int maximumResults)`	Return the annotations linked directly to the report.
`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<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`	`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`	`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`	`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.
`void`	`updateAssetOwner(String userId, String assetGUID, String ownerId, String ownerTypeName, String ownerPropertyName)`	Update the owner information for a specific asset.
`void`	`updateAssetOwner(String userId, String assetGUID, String ownerId, OwnerType ownerType)`	Deprecated.
`void`	`updateAssetZones(String userId, String assetGUID, List<String> assetZones)`	Update the zones for a specific asset.
`void`	`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`	`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.commonservices.ocf.metadatamanagement.client.ConnectedAssetClientBase
getAssetForConnection, getAssetProperties, getAssetSummary, getConnectionByGUID, getConnectionByName, getConnectionForAsset, getConnectorByConnection, getConnectorByGUID, getConnectorByName, getConnectorForAsset, getConnectorForConnection

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

- Field Detail
  - restClient
```
protected AssetOwnerRESTClient restClient
```
- Constructor Detail
  - 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 servers
    
    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 servers
    
    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 servers
    
    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 servers
    
    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 servers
    
    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 Detail
  - getAssetProperties
```
public AssetUniverse getAssetProperties(String userId,
                                        String assetGUID)
                                 throws InvalidParameterException,
                                        PropertyServerException,
                                        UserNotAuthorizedException
```
    Returns a comprehensive collection of properties about the requested asset.
    
    Specified by:
    
    getAssetProperties in interface AssetReviewInterface
    
    Parameters:
    
    userId - userId of user making request.
    
    assetGUID - unique identifier for asset.
    
    Returns:
    
    a comprehensive collection of properties about the asset.
    
    Throws:
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    PropertyServerException - there is a problem retrieving the asset properties from the property servers).
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
  - 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 - full path or 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:
    
    list 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 displayName,
                                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
    
    displayName - display name for the asset in the catalog
    
    description - description of the asset in the catalog
    
    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)
  - 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
  - addSchemaAttributes
```
public void addSchemaAttributes(String serverName,
                                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:
    
    serverName - name of the server instance to connect to
    
    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 serverName,
                                 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:
    
    serverName - name of the server instance to connect to
    
    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
  - 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
  - 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
```
@Deprecated
public void updateAssetOwner(String userId,
                             String assetGUID,
                             String ownerId,
                             OwnerType ownerType)
                      throws InvalidParameterException,
                             UserNotAuthorizedException,
                             PropertyServerException
```
    Deprecated.
    
    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 - userId or profileGUID of the owner - or null to clear the field
    
    ownerType - indicator of the type of identifier provided above - or null to clear the field
    
    Throws:
    
    InvalidParameterException - 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
  - addSecurityTags
```
public void addSecurityTags(String userId,
                            String assetGUID,
                            String assetElementGUID,
                            List<String> securityLabels,
                            Map<String,Object> securityProperties)
                     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
    
    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 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
    
    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
  - 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.
  - getDiscoveryAnalysisReports
```
public List<DiscoveryAnalysisReport> getDiscoveryAnalysisReports(String userId,
                                                                 String assetGUID,
                                                                 int startingFrom,
                                                                 int maximumResults)
                                                          throws InvalidParameterException,
                                                                 UserNotAuthorizedException,
                                                                 PropertyServerException
```
    Return the discovery analysis reports about the asset.
    
    Specified by:
    
    getDiscoveryAnalysisReports 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
  - getDiscoveryReportAnnotations
```
public List<Annotation> getDiscoveryReportAnnotations(String userId,
                                                      String discoveryReportGUID,
                                                      AnnotationStatus annotationStatus,
                                                      int startingFrom,
                                                      int maximumResults)
                                               throws InvalidParameterException,
                                                      UserNotAuthorizedException,
                                                      PropertyServerException
```
    Return the annotations linked directly to the report.
    
    Specified by:
    
    getDiscoveryReportAnnotations in interface AssetReviewInterface
    
    Parameters:
    
    userId - identifier of calling user
    
    discoveryReportGUID - identifier of the discovery request.
    
    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.
  - 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

Class AssetOwner

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

restClient

Constructor Detail

AssetOwner

AssetOwner

AssetOwner

AssetOwner

AssetOwner

Method Detail

getAssetProperties

getTypesOfAsset

getTypesOfAssetWithDescriptions

addAssetToCatalog

addAssetToCatalog

addAssetToCatalogUsingTemplate

addCombinedSchemaToAsset

addSchemaTypeToAsset

attachSchemaTypeToAsset

detachSchemaTypeFromAsset

deleteAssetSchemaType

addSchemaAttributes

addSchemaAttribute

addConnectionToAsset

addSemanticAssignment

removeSemanticAssignment

addAssetOrigin

removeAssetOrigin

publishAsset

withdrawAsset

updateAssetZones

updateAssetOwner

updateAssetOwner

addSecurityTags

removeSecurityTags

addTemplateClassification

removeTemplateClassification

createConnection

createConnectionFromTemplate

updateConnection

setupConnectorType

clearConnectorType

setupEndpoint

clearEndpoint

setupEmbeddedConnection

clearEmbeddedConnection

setupAssetConnection

clearAssetConnection

removeConnection

findConnections

scanConnections

getConnectionsByName

getConnectionByGUID

createEndpoint

createEndpointFromTemplate

updateEndpoint

removeEndpoint

findEndpoints

getEndpointsByName

getEndpointByGUID

findConnectorTypes

getConnectorTypesByName

getConnectorTypeByGUID

getAssetsByName

findAssets

getAssetSummary

getConnectorToAsset

getDiscoveryAnalysisReports

getTypesOfAnnotation

getTypesOfAnnotationWithDescriptions

getDiscoveryReportAnnotations

getExtendedAnnotations

deleteAsset