java.lang.Object

org.odpi.openmetadata.frameworks.integration.context.IntegrationContext

org.odpi.openmetadata.integrationservices.infrastructure.connector.InfrastructureIntegratorContext

public class InfrastructureIntegratorContext extends IntegrationContext

InfrastructureIntegratorContext provides a wrapper around the IT Infrastructure OMAS client. It provides the simplified interface to open metadata needed by the InfrastructureIntegratorConnector.

Field Summary

Fields inherited from class org.odpi.openmetadata.frameworks.integration.context.IntegrationContext
actionControlInterface, connectorName, externalSourceGUID, externalSourceName, fileClassifier, governanceConfiguration, integrationConnectorGUID, integrationReportWriter, maxPageSize, openIntegrationClient, openMetadataStoreClient, permittedSynchronization, propertyHelper, userId
Constructor Summary

Constructors

Constructor

Description

InfrastructureIntegratorContext(String connectorId, String connectorName, String connectorUserId, String serverName, OpenIntegrationClient openIntegrationClient, GovernanceConfiguration governanceConfiguration, OpenMetadataClient openMetadataStoreClient, ActionControlInterface actionControlInterface, CapabilityManagerClient capabilityManagerClient, ConnectionManagerClient connectionManagerClient, ConnectorTypeManagerClient connectorTypeManagerClient, DataAssetManagerClient dataAssetManagerClient, EndpointManagerClient endpointManagerClient, HostManagerClient hostManagerClient, ITProfileManagerClient itProfileManagerClient, PlatformManagerClient platformManagerClient, ProcessManagerClient processManagerClient, ServerManagerClient serverManagerClient, ITInfrastructureEventClient eventClient, boolean generateIntegrationReport, PermittedSynchronization permittedSynchronization, String integrationConnectorGUID, String externalSourceGUID, String externalSourceName, AuditLog auditLog, int maxPageSize)

Create a new context for a connector.
Method Summary

Modifier and Type

Method

Description

String

addContactMethod(String itProfileGUID, ContactMethodProperties properties)

Add a new contact method to the profile.

void

addIdentityToProfile(String userIdentityGUID, String profileGUID, ProfileIdentityProperties properties)

Link a user identity to a profile.

void

addServerPurpose(String itAssetGUID, String classificationName, Date effectiveFrom, Date effectiveTo, Map<String,Object> classificationProperties)

Add a Server Purpose classification to an IT asset.

void

clearAssetConnection(String assetGUID, String connectionGUID)

Remove a relationship between an asset and its connection.

void

clearBusinessSignificant(String elementGUID, Date effectiveTime)

Remove the "BusinessSignificant" designation from the element.

void

clearClusterMember(String hostGUID, String clusterMemberGUID, Date effectiveTime)

Remove a relationship between a host and a cluster member host.

void

clearConnectorType(String connectionGUID, String connectorTypeGUID)

Remove a relationship between a connection and a connector type.

void

clearControlFlow(String controlFlowGUID, Date effectiveTime)

Remove the control flow relationship between two elements.

void

clearDataAssetAsReferenceData(String assetGUID, Date effectiveTime)

Remove the reference data designation from the asset.

void

clearDataFlow(String dataFlowGUID, Date effectiveTime)

Remove the data flow relationship between two elements.

void

clearDeployment(String itAssetGUID, String destinationGUID, Date effectiveTime)

Remove a deployment relationship.

void

clearEmbeddedConnection(String connectionGUID, String embeddedConnectionGUID)

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

void

clearEndpoint(String connectionGUID, String endpointGUID)

Remove a relationship between a connection and an endpoint.

void

clearLineageMapping(String lineageMappingGUID, Date effectiveTime)

Remove the lineage mapping between two elements.

void

clearProcessCall(String processCallGUID, Date effectiveTime)

Remove the process call relationship.

void

clearProcessParent(String parentProcessGUID, String childProcessGUID, Date effectiveTime)

Remove a parent-child relationship between two processes.

void

clearServerPurpose(String assetGUID, String classificationName, Date effectiveTime)

Remove a server purpose classification.

String

createConnection(ConnectionProperties connectionProperties)

Create a new metadata element to represent a connection.

String

createConnectionFromTemplate(String templateGUID, TemplateProperties templateProperties)

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

String

createConnectorType(ConnectorTypeProperties connectorTypeProperties)

Create a new metadata element to represent an connectorType

String

createConnectorTypeFromTemplate(String templateGUID, TemplateProperties templateProperties)

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

String

createDataAsset(DataAssetProperties dataAssetProperties)

Create a new metadata element to represent the root of an asset.

String

createDataAssetFromTemplate(String templateGUID, TemplateProperties templateProperties)

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

String

createEndpoint(String infrastructureGUID, EndpointProperties endpointProperties)

Create a new metadata element to represent an endpoint

String

createEndpointFromTemplate(String infrastructureGUID, String networkAddress, String templateGUID, TemplateProperties templateProperties)

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

String

createHost(HostProperties hostProperties)

Create a new metadata element to represent a host.

String

createHostFromTemplate(String templateGUID, TemplateProperties templateProperties)

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

String

createITProfile(String itInfrastructureGUID, String itUserId, ITProfileProperties properties)

Create a definition of an IT profile.

String

createProcess(ProcessStatus processStatus, ProcessProperties processProperties)

Create a new metadata element to represent a process.

String

createProcessFromTemplate(String templateGUID, TemplateProperties templateProperties)

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

String

createServerAssetUse(String capabilityGUID, String assetGUID, ServerAssetUseProperties properties)

Create a new metadata relationship to represent the use of an asset by a software server capability.

String

createSoftwareCapability(String classificationName, SoftwareCapabilityProperties capabilityProperties)

Create a new metadata element to represent a software server capability.

String

createSoftwareCapabilityFromTemplate(String templateGUID, TemplateProperties templateProperties)

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

String

createSoftwareServer(SoftwareServerProperties softwareServerProperties)

Create a new metadata element to represent a software server.

String

createSoftwareServerFromTemplate(String templateGUID, TemplateProperties templateProperties)

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

String

createSoftwareServerPlatform(SoftwareServerPlatformProperties platformProperties)

Create a new metadata element to represent a platform.

String

createSoftwareServerPlatformFromTemplate(String templateGUID, TemplateProperties templateProperties)

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

String

createUserIdentity(UserIdentityProperties newIdentity)

Create a UserIdentity.

void

deleteContactMethod(String contactMethodGUID)

Remove an obsolete contact method from the profile.

void

deleteITProfile(String itProfileGUID)

Remove the definition of an IT profile.

void

deleteUserIdentity(String userIdentityGUID)

Remove a user identity object.

void

deployCapability(String capabilityGUID, String infrastructureAssetGUID, CapabilityDeploymentProperties deploymentProperties)

Link a software capability to a software server.

void

deployITAsset(String itAssetGUID, String destinationGUID, DeploymentProperties deploymentProperties)

Create a relationship that represents the deployment of an IT infrastructure asset to a specific deployment destination (another asset).

List<ConnectionElement>

findConnections(String searchString, int startFrom, int pageSize)

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

List<ConnectorTypeElement>

findConnectorTypes(String searchString, int startFrom, int pageSize)

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

List<DataAssetElement>

findDataAssets(String searchString, Date effectiveTime, int startFrom, int pageSize)

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

List<EndpointElement>

findEndpoints(String searchString, int startFrom, int pageSize)

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

List<HostElement>

findHosts(String searchString, Date effectiveTime, int startFrom, int pageSize)

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

List<ITProfileElement>

findITProfile(String searchString, int startFrom, int pageSize)

Retrieve the list of matching profiles for the search string.

List<ProcessElement>

findProcesses(String searchString, Date effectiveTime, int startFrom, int pageSize)

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

List<SoftwareCapabilityElement>

findSoftwareCapabilities(String searchString, Date effectiveTime, int startFrom, int pageSize)

Retrieve the list of software capability metadata elements that contain the search string.

List<SoftwareServerPlatformElement>

findSoftwareServerPlatforms(String searchString, Date effectiveTime, int startFrom, int pageSize)

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

List<SoftwareServerElement>

findSoftwareServers(String searchString, Date effectiveTime, int startFrom, int pageSize)

Retrieve the list of software server metadata elements that contain the search string.

List<UserIdentityElement>

findUserIdentities(String searchString, int startFrom, int pageSize)

Retrieve the list of user identity metadata elements that contain the search string.

List<ServerAssetUseElement>

getCapabilityUsesForAsset(String assetGUID, ServerAssetUseType useType, Date effectiveTime, int startFrom, int pageSize)

Return the list of software server capabilities that make use of a specific asset.

List<HostElement>

getClusterMembersForHost(String hostGUID, Date effectiveTime, int startFrom, int pageSize)

Return the list of cluster members associated with a host.

ConnectionElement

getConnectionByGUID(String connectionGUID)

Retrieve the metadata element with the supplied unique identifier.

List<ConnectionElement>

getConnectionsByName(String name, int startFrom, int pageSize)

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

ConnectorTypeElement

getConnectorTypeByGUID(String connectorTypeGUID)

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

List<ConnectorTypeElement>

getConnectorTypesByName(String name, int startFrom, int pageSize)

Retrieve the list of connector type metadata elements with a matching qualified name, display name or connector provider class name.

ControlFlowElement

getControlFlow(String currentStepGUID, String nextStepGUID, String qualifiedName, Date effectiveTime)

Retrieve the control flow relationship between two elements.

List<ControlFlowElement>

getControlFlowNextSteps(String currentStepGUID, int startFrom, int pageSize, Date effectiveTime)

Retrieve the control relationships linked from a specific element to the possible next elements in the process.

List<ControlFlowElement>

getControlFlowPreviousSteps(String currentStepGUID, int startFrom, int pageSize, Date effectiveTime)

Retrieve the control relationships linked from a specific element to the possible previous elements in the process.

DataAssetElement

getDataAssetByGUID(String guid)

Retrieve the asset metadata element with the supplied unique identifier.

List<DataAssetElement>

getDataAssetsByName(String name, Date effectiveTime, int startFrom, int pageSize)

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

List<DataAssetElement>

getDataAssetsForInfrastructureManager(Date effectiveTime, int startFrom, int pageSize)

Retrieve the list of assets created on behalf of the named infrastructure manager.

DataFlowElement

getDataFlow(String dataSupplierGUID, String dataConsumerGUID, String qualifiedName, Date effectiveTime)

Retrieve the data flow relationship between two elements.

List<DataFlowElement>

getDataFlowConsumers(String dataSupplierGUID, int startFrom, int pageSize, Date effectiveTime)

Retrieve the data flow relationships linked from a specific element to the downstream consumers.

List<DataFlowElement>

getDataFlowSuppliers(String dataConsumerGUID, int startFrom, int pageSize, Date effectiveTime)

Retrieve the data flow relationships linked from a specific element to the upstream suppliers.

List<DeploymentElement>

getDeployedITAssets(String destinationGUID, Date effectiveTime, int startFrom, int pageSize)

Return the list of assets deployed on a particular destination.

List<SoftwareCapabilityElement>

getDeployedSoftwareCapabilities(String itAssetGUID, Date effectiveTime, int startFrom, int pageSize)

Retrieve the software capabilities that are deployed to an IT asset.

List<DeploymentElement>

getDeploymentDestinations(String itAssetGUID, Date effectiveTime, int startFrom, int pageSize)

Return the list of destinations that a particular IT infrastructure asset is deployed to.

List<LineageMappingElement>

getDestinationLineageMappings(String sourceElementGUID, int startFrom, int pageSize, Date effectiveTime)

Retrieve the lineage mapping relationships linked from a specific source element to its destinations.

EndpointElement

getEndpointByGUID(String endpointGUID)

Retrieve the endpoint metadata element with the supplied unique identifier.

List<EndpointElement>

getEndpointsByName(String name, int startFrom, int pageSize)

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

List<EndpointElement>

getEndpointsByNetworkAddress(String networkAddress, int startFrom, int pageSize)

Retrieve the list of endpoint metadata elements with a matching networkAddress.

List<EndpointElement>

getEndpointsForInfrastructure(String infrastructureGUID, int startFrom, int pageSize)

Retrieve the list of endpoint metadata elements that are attached to a specific infrastructure element.

HostElement

getHostByGUID(String guid)

Retrieve the host metadata element with the supplied unique identifier.

List<HostElement>

getHostsByName(String name, Date effectiveTime, int startFrom, int pageSize)

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

List<HostElement>

getHostsForInfrastructureManager(Date effectiveTime, int startFrom, int pageSize)

Retrieve the list of hosts created by this caller.

ITProfileElement

getITProfileByGUID(String itProfileGUID)

Return information about a specific IT profile.

List<ITProfileElement>

getITProfileByName(String name, int startFrom, int pageSize)

Return information about a named IT profile.

ITProfileElement

getITProfileByUserId(String itProfileUserId)

Return information about a specific IT profile.

LineageMappingElement

getLineageMapping(String sourceElementGUID, String destinationElementGUID, String qualifiedName, Date effectiveTime)

Retrieve the lineage mapping relationship between two elements.

ProcessElement

getProcessByGUID(String processGUID)

Retrieve the process metadata element with the supplied unique identifier.

ProcessCallElement

getProcessCall(String callerGUID, String calledGUID, String qualifiedName, Date effectiveTime)

Retrieve the process call relationship between two elements.

List<ProcessCallElement>

getProcessCalled(String callerGUID, int startFrom, int pageSize, Date effectiveTime)

Retrieve the process call relationships linked from a specific element to the elements it calls.

List<ProcessCallElement>

getProcessCallers(String calledGUID, int startFrom, int pageSize, Date effectiveTime)

Retrieve the process call relationships linked from a specific element to its callers.

List<ProcessElement>

getProcessesByName(String name, Date effectiveTime, int startFrom, int pageSize)

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

List<ProcessElement>

getProcessesForInfrastructureManager(Date effectiveTime, int startFrom, int pageSize)

Return the list of processes associated with the infrastructure manager.

ProcessElement

getProcessParent(String processGUID, Date effectiveTime)

Retrieve the process metadata element with the supplied unique identifier.

ServerAssetUseElement

getServerAssetUseByGUID(String guid)

Retrieve the server asset use type relationship with the supplied unique identifier.

List<ServerAssetUseElement>

getServerAssetUsesForCapability(String capabilityGUID, ServerAssetUseType useType, Date effectiveTime, int startFrom, int pageSize)

Return the list of server asset use relationships associated with a software server capability.

List<ServerAssetUseElement>

getServerAssetUsesForElements(String capabilityGUID, String assetGUID, Date effectiveTime, int startFrom, int pageSize)

Retrieve the list of relationships between a specific software server capability and a specific asset.

List<SoftwareCapabilityElement>

getSoftwareCapabilitiesByName(String name, Date effectiveTime, int startFrom, int pageSize)

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

List<SoftwareCapabilityElement>

getSoftwareCapabilitiesForInfrastructureManager(Date effectiveTime, int startFrom, int pageSize)

Retrieve the list of capabilities created by this caller.

SoftwareCapabilityElement

getSoftwareCapabilityByGUID(String guid)

Retrieve the software capability metadata element with the supplied unique identifier.

List<RelatedAssetElement>

getSoftwareCapabilityDeployments(String guid, Date effectiveTime, int startFrom, int pageSize)

Retrieve the IT asset metadata elements where the software with the supplied unique identifier is deployed.

SoftwareServerElement

getSoftwareServerByGUID(String guid)

Retrieve the softwareServer metadata element with the supplied unique identifier.

SoftwareServerPlatformElement

getSoftwareServerPlatformByGUID(String guid)

Retrieve the platform metadata element with the supplied unique identifier.

List<SoftwareServerPlatformElement>

getSoftwareServerPlatformsByName(String name, Date effectiveTime, int startFrom, int pageSize)

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

List<SoftwareServerPlatformElement>

getSoftwareServerPlatformsForInfrastructureManager(Date effectiveTime, int startFrom, int pageSize)

Retrieve the list of platforms created by this caller.

List<SoftwareServerElement>

getSoftwareServersByName(String name, Date effectiveTime, int startFrom, int pageSize)

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

List<SoftwareServerElement>

getSoftwareServersForInfrastructureManager(Date effectiveTime, int startFrom, int pageSize)

Retrieve the list of software servers created by this caller.

List<LineageMappingElement>

getSourceLineageMappings(String destinationElementGUID, int startFrom, int pageSize, Date effectiveTime)

Retrieve the lineage mapping relationships linked from a specific destination element to its sources.

List<ProcessElement>

getSubProcesses(String processGUID, Date effectiveTime, int startFrom, int pageSize)

Retrieve the process metadata element with the supplied unique identifier.

List<UserIdentityElement>

getUserIdentitiesByName(String name, int startFrom, int pageSize)

Retrieve the list of user identity metadata elements with a matching qualified name.

UserIdentityElement

getUserIdentityByGUID(String userIdentityGUID)

Retrieve the userIdentity metadata element with the supplied unique identifier.

void

linkITInfrastructureToProfile(String itInfrastructureGUID, String itProfileGUID, Date effectiveFrom, Date effectiveTo)

Link a piece of infrastructure to an IT profile.

void

publishDataAsset(String assetGUID)

Update the zones for the asset so that it becomes visible to consumers.

void

publishHost(String hostGUID)

Update the zones for the host asset so that it becomes visible to consumers.

void

publishProcess(String processGUID)

Update the zones for the asset so that it becomes visible to consumers.

void

publishSoftwareServer(String softwareServerGUID)

Update the zones for the software server asset so that it becomes visible to consumers.

void

publishSoftwareServerPlatform(String platformGUID)

Update the zones for the platform asset so that it becomes visible to consumers.

void

registerListener(ITInfrastructureEventListener listener)

Register a listener object that will be passed each of the events published by the IT Infrastructure OMAS.

void

removeCapabilityDeployment(String itAssetGUID, String capabilityGUID, Date effectiveTime)

Remove the link between a software server capability and a software server.

void

removeConnection(String connectionGUID)

Remove the metadata element representing a connection.

void

removeConnectorType(String connectorTypeGUID)

Remove the metadata element representing an connectorType.

void

removeDataAsset(String assetGUID)

Remove the metadata element representing an asset.

void

removeEndpoint(String endpointGUID)

Remove the metadata element representing a endpoint.

void

removeHost(String hostGUID)

Remove the metadata element representing a host.

void

removeIdentityFromProfile(String userIdentityGUID, String profileGUID)

Unlink a user identity from a profile.

void

removeProcess(String processGUID)

Remove the metadata element representing a process.

void

removeServerAssetUse(String serverAssetUseGUID)

Remove the metadata relationship to represent the use of an asset by a software server capability.

void

removeSoftwareCapability(String capabilityGUID)

Remove the metadata element representing a software capability.

void

removeSoftwareServer(String softwareServerGUID)

Remove the metadata element representing a software server.

void

removeSoftwareServerPlatform(String platformGUID)

Remove the metadata element representing a platform.

void

setBusinessSignificant(String elementGUID, Date effectiveFrom, Date effectiveTo)

Classify a port, process or asset as "BusinessSignificant" (this may affect the way that lineage is displayed).

void

setDataAssetAsReferenceData(String assetGUID, Date effectiveFrom, Date effectiveTo)

Classify the asset to indicate that it can be used as reference data.

void

setInfrastructureManagerIsHome(boolean externalSourceIsHome)

Set up the flag that controls the ownership of metadata created for this infrastructure manager.

void

setupAssetConnection(String assetGUID, String connectionGUID)

Create a relationship between an asset and its connection.

void

setupClusterMember(String hostGUID, String clusterMemberGUID, Date effectiveFrom, Date effectiveTo)

Create a relationship between a host and a cluster member host.

void

setupConnectorType(String connectionGUID, String connectorTypeGUID)

Create a relationship between a connection and a connector type.

String

setupControlFlow(String currentStepGUID, String nextStepGUID, ControlFlowProperties properties, Date effectiveTime)

Link two elements to show that when one completes the next is started.

String

setupDataFlow(String dataSupplierGUID, String dataConsumerGUID, DataFlowProperties properties, Date effectiveTime)

Link two elements together to show that data flows from one to the other.

void

setupEmbeddedConnection(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 connectionGUID, String endpointGUID)

Create a relationship between a connection and an endpoint.

void

setupLineageMapping(String sourceElementGUID, String destinationElementGUID, LineageMappingProperties properties, Date effectiveTime)

Link two elements together to show that they are part of the lineage of the data that is moving between the processes.

String

setupProcessCall(String callerGUID, String calledGUID, ProcessCallProperties properties, Date effectiveTime)

Link two elements together to show a request-response call between them.

void

setupProcessParent(String parentProcessGUID, String childProcessGUID, ProcessContainmentType containmentType, Date effectiveFrom, Date effectiveTo)

Create a parent-child relationship between two processes.

void

unlinkITInfrastructureFromProfile(String itInfrastructureGUID, String itProfileGUID, Date effectiveTime)

Remove the link between a piece of infrastructure to an IT profile.

void

updateCapabilityDeployment(String deploymentGUID, boolean isMergeUpdate, CapabilityDeploymentProperties deploymentProperties)

Update the properties of a server capability's deployment.

void

updateConnection(String connectionGUID, boolean isMergeUpdate, ConnectionProperties connectionProperties)

Update the metadata element representing a connection.

void

updateConnectorType(boolean isMergeUpdate, String connectorTypeGUID, ConnectorTypeProperties connectorTypeProperties)

Update the metadata element representing an connectorType.

void

updateControlFlow(String controlFlowGUID, ControlFlowProperties properties, Date effectiveTime)

Update the relationship between two elements that shows that when one completes the next is started.

void

updateDataAsset(String assetGUID, boolean isMergeUpdate, DataAssetProperties dataAssetProperties)

Update the metadata element representing an asset.

void

updateDataFlow(String dataFlowGUID, DataFlowProperties properties, Date effectiveTime)

Update relationship between two elements that shows that data flows from one to the other.

void

updateEndpoint(boolean isMergeUpdate, String endpointGUID, EndpointProperties endpointProperties)

Update the metadata element representing an endpoint.

void

updateHost(String hostGUID, boolean isMergeUpdate, HostProperties hostProperties)

Update the metadata element representing a host.

void

updateITAssetDeployment(String deploymentGUID, boolean isMergeUpdate, DeploymentProperties deploymentProperties)

Update a deployment relationship.

void

updateITInfrastructureToProfile(String itInfrastructureGUID, String itProfileGUID, Date effectiveFrom, Date effectiveTo)

Update the effectivity dates of a link from a piece of infrastructure to an IT profile.

void

updateITProfile(String itProfileGUID, boolean isMergeUpdate, ITProfileProperties properties)

Update the definition of an IT profile.

void

updateLineageMapping(String lineageMappingGUID, LineageMappingProperties properties, Date effectiveTime)

Update the lineage mapping relationship between two elements.

void

updateProcess(String processGUID, boolean isMergeUpdate, ProcessProperties processProperties)

Update the metadata element representing a process.

void

updateProcessCall(String processCallGUID, ProcessCallProperties properties, Date effectiveTime)

Update the relationship between two elements that shows a request-response call between them.

void

updateProcessStatus(String processGUID, ProcessStatus processStatus)

Update the status of the metadata element representing a process.

void

updateProfileIdentity(String userIdentityGUID, String profileGUID, boolean isMergeUpdate, ProfileIdentityProperties properties)

Update the properties of the relationship between a user identity and profile.

void

updateServerAssetUse(String serverAssetUseGUID, boolean isMergeUpdate, ServerAssetUseProperties properties)

Update the metadata relationship to represent the use of an asset by a software server capability.

void

updateServerPurpose(String assetGUID, String classificationName, Date effectiveFrom, Date effectiveTo, boolean isMergeUpdate, Map<String,Object> classificationProperties)

Update the properties of a classification for an asset.

void

updateSoftwareCapability(String capabilityGUID, boolean isMergeUpdate, SoftwareCapabilityProperties capabilityProperties)

Update the metadata element representing a software capability.

void

updateSoftwareServer(String softwareServerGUID, boolean isMergeUpdate, SoftwareServerProperties softwareServerProperties)

Update the metadata element representing a software server.

void

updateSoftwareServerPlatform(String platformGUID, boolean isMergeUpdate, SoftwareServerPlatformProperties platformProperties)

Update the metadata element representing a platform.

void

updateUserIdentity(String userIdentityGUID, boolean isMergeUpdate, UserIdentityProperties properties)

Update a UserIdentity.

void

withdrawDataAsset(String assetGUID)

Update the zones for the asset so that it is no longer visible to consumers.

void

withdrawHost(String hostGUID)

Update the zones for the host asset so that it is no longer visible to consumers.

void

withdrawProcess(String processGUID)

Update the zones for the asset so that it is no longer visible to consumers.

void

withdrawSoftwareServer(String softwareServerGUID)

Update the zones for the software server asset so that it is no longer visible to consumers.

void

withdrawSoftwareServerPlatform(String platformGUID)

Update the zones for the platform asset so that it is no longer visible to consumers.

Methods inherited from class org.odpi.openmetadata.frameworks.integration.context.IntegrationContext
addCatalogTarget, addCatalogTarget, disconnect, elementShouldBeCatalogued, getAnchorGUID, getAnchorGUID, getCatalogTarget, getCatalogTargets, getCatalogTargets, getConnectedAssetContext, getExternalSourceIsHome, getFileClassifier, getIntegrationGovernanceContext, getMaxPageSize, getMetadataSourceGUID, getMetadataSourceQualifiedName, getMyUserId, getPermittedSynchronization, isRefreshInProgress, isTypeOf, isTypeOf, registerDirectoryListener, registerDirectoryTreeListener, registerFileListener, removeCatalogTarget, reportElementCreation, reportElementDelete, reportElementUpdate, setActiveReportPublishing, setExternalSourceIsHome, setMetadataSourceQualifiedName, setMetadataSourceQualifiedName, unregisterDirectoryListener, unregisterDirectoryTreeListener, unregisterFileListener, updateCatalogTarget

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

Constructor Details
- InfrastructureIntegratorContext
  
  public InfrastructureIntegratorContext(String connectorId, String connectorName, String connectorUserId, String serverName, OpenIntegrationClient openIntegrationClient, GovernanceConfiguration governanceConfiguration, OpenMetadataClient openMetadataStoreClient, ActionControlInterface actionControlInterface, CapabilityManagerClient capabilityManagerClient, ConnectionManagerClient connectionManagerClient, ConnectorTypeManagerClient connectorTypeManagerClient, DataAssetManagerClient dataAssetManagerClient, EndpointManagerClient endpointManagerClient, HostManagerClient hostManagerClient, ITProfileManagerClient itProfileManagerClient, PlatformManagerClient platformManagerClient, ProcessManagerClient processManagerClient, ServerManagerClient serverManagerClient, ITInfrastructureEventClient eventClient, boolean generateIntegrationReport, PermittedSynchronization permittedSynchronization, String integrationConnectorGUID, String externalSourceGUID, String externalSourceName, AuditLog auditLog, int maxPageSize)
  
  Create a new context for a connector.
  
  Parameters:
  
  connectorId - unique identifier of the connector (used to configure the event listener)
  
  connectorName - name of connector from config
  
  connectorUserId - userId for the connector
  
  serverName - name of the integration daemon
  
  openIntegrationClient - client for calling the metadata server
  
  governanceConfiguration - client for managing catalog targets
  
  openMetadataStoreClient - client for calling the metadata server
  
  actionControlInterface - client for initiating governance actions
  
  capabilityManagerClient - client for software capabilities
  
  connectionManagerClient - client for connections
  
  connectorTypeManagerClient - client for connector types
  
  dataAssetManagerClient - clients for data stores, data sets and data feeds
  
  endpointManagerClient - client for endpoints
  
  hostManagerClient - client for hosts
  
  itProfileManagerClient - client for IT profiles
  
  platformManagerClient - client for software platforms
  
  processManagerClient - client for processes
  
  serverManagerClient - client for software servers
  
  eventClient - client for receiving events
  
  generateIntegrationReport - should the connector generate an integration reports?
  
  permittedSynchronization - the direction of integration permitted by the integration connector
  
  integrationConnectorGUID - unique identifier for the integration connector if it is started via an integration group (otherwise it is null).
  
  externalSourceGUID - unique identifier of the software server capability for the asset manager
  
  externalSourceName - unique name of the software server capability for the asset manager
  
  auditLog - logging destination
  
  maxPageSize - max number of elements that can be returned on a query
Method Details
- setInfrastructureManagerIsHome
  
  public void setInfrastructureManagerIsHome(boolean externalSourceIsHome)
  
  Set up the flag that controls the ownership of metadata created for this infrastructure manager. Default is true.
  
  Parameters:
  
  externalSourceIsHome - should the metadata be marked as owned by the infrastructure manager so others can not update?
- registerListener
  
  public void registerListener(ITInfrastructureEventListener listener) throws InvalidParameterException, ConnectionCheckedException, ConnectorCheckedException, PropertyServerException, UserNotAuthorizedException
  
  Register a listener object that will be passed each of the events published by the IT Infrastructure OMAS.
  
  Parameters:
  
  listener - listener object
  
  Throws:
  
  InvalidParameterException - one of the parameters is null or invalid.
  
  ConnectionCheckedException - there are errors in the configuration of the connection which is preventing the creation of a connector.
  
  ConnectorCheckedException - there are errors in the initialization of the connector.
  
  PropertyServerException - there is a problem retrieving information from the property server(s).
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.
- createHost
  
  public String createHost(HostProperties hostProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a new metadata element to represent a host.
  
  Parameters:
  
  hostProperties - 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)
- createHostFromTemplate
  
  public String createHostFromTemplate(String templateGUID, TemplateProperties templateProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a new metadata element to represent a host using an existing metadata element as a template.
  
  Parameters:
  
  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)
- updateHost
  
  public void updateHost(String hostGUID, boolean isMergeUpdate, HostProperties hostProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Update the metadata element representing a host.
  
  Parameters:
  
  hostGUID - unique identifier of the metadata element to update
  
  isMergeUpdate - are unspecified properties unchanged (true) or removed?
  
  hostProperties - 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)
- setupClusterMember
  
  public void setupClusterMember(String hostGUID, String clusterMemberGUID, Date effectiveFrom, Date effectiveTo) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a relationship between a host and a cluster member host.
  
  Parameters:
  
  hostGUID - unique identifier of the host
  
  clusterMemberGUID - unique identifier of the cluster member host
  
  effectiveFrom - time when this hosting is effective - null means immediately
  
  effectiveTo - time when this hosting is no longer effective - null means forever
  
  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)
- clearClusterMember
  
  public void clearClusterMember(String hostGUID, String clusterMemberGUID, Date effectiveTime) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove a relationship between a host and a cluster member host.
  
  Parameters:
  
  hostGUID - unique identifier of the host
  
  clusterMemberGUID - unique identifier of the cluster member host
  
  effectiveTime - time when the hosting is effective
  
  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)
- publishHost
  
  public void publishHost(String hostGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Update the zones for the host asset so that it becomes visible to consumers. (The zones are set to the list of zones in the publishedZones option configured for each instance of the IT Infrastructure OMAS).
  
  Parameters:
  
  hostGUID - unique identifier of the metadata element to publish
  
  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)
- withdrawHost
  
  public void withdrawHost(String hostGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Update the zones for the host asset so that it is no longer visible to consumers. (The zones are set to the list of zones in the defaultZones option configured for each instance of the IT Infrastructure OMAS. This is the setting when the host is first created).
  
  Parameters:
  
  hostGUID - unique identifier of the metadata element to withdraw
  
  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)
- removeHost
  
  public void removeHost(String hostGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove the metadata element representing a host.
  
  Parameters:
  
  hostGUID - 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)
- findHosts
  
  public List<HostElement> findHosts(String searchString, Date effectiveTime, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of host metadata elements that contain the search string. The search string is treated as a regular expression.
  
  Parameters:
  
  searchString - string to find in the properties
  
  effectiveTime - effective time for the query
  
  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)
- getHostsByName
  
  public List<HostElement> getHostsByName(String name, Date effectiveTime, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of host metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
  
  Parameters:
  
  name - name to search for
  
  effectiveTime - effective time for the query
  
  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)
- getHostsForInfrastructureManager
  
  public List<HostElement> getHostsForInfrastructureManager(Date effectiveTime, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of hosts created by this caller.
  
  Parameters:
  
  effectiveTime - effective time for the query
  
  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)
- getClusterMembersForHost
  
  public List<HostElement> getClusterMembersForHost(String hostGUID, Date effectiveTime, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Return the list of cluster members associated with a host.
  
  Parameters:
  
  hostGUID - unique identifier of the host to query
  
  effectiveTime - effective time for the query
  
  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)
- getHostByGUID
  
  public HostElement getHostByGUID(String guid) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the host metadata element with the supplied unique identifier.
  
  Parameters:
  
  guid - 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)
- createSoftwareServerPlatform
  
  public String createSoftwareServerPlatform(SoftwareServerPlatformProperties platformProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a new metadata element to represent a platform.
  
  Parameters:
  
  platformProperties - 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)
- createSoftwareServerPlatformFromTemplate
  
  public String createSoftwareServerPlatformFromTemplate(String templateGUID, TemplateProperties templateProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a new metadata element to represent a platform using an existing metadata element as a template.
  
  Parameters:
  
  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)
- updateSoftwareServerPlatform
  
  public void updateSoftwareServerPlatform(String platformGUID, boolean isMergeUpdate, SoftwareServerPlatformProperties platformProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Update the metadata element representing a platform.
  
  Parameters:
  
  platformGUID - unique identifier of the metadata element to update
  
  isMergeUpdate - are unspecified properties unchanged (true) or removed?
  
  platformProperties - 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)
- publishSoftwareServerPlatform
  
  public void publishSoftwareServerPlatform(String platformGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Update the zones for the platform asset so that it becomes visible to consumers. (The zones are set to the list of zones in the publishedZones option configured for each instance of the IT Infrastructure OMAS).
  
  Parameters:
  
  platformGUID - unique identifier of the metadata element to publish
  
  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)
- withdrawSoftwareServerPlatform
  
  public void withdrawSoftwareServerPlatform(String platformGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Update the zones for the platform asset so that it is no longer visible to consumers. (The zones are set to the list of zones in the defaultZones option configured for each instance of the IT Infrastructure OMAS. This is the setting when the platform is first created).
  
  Parameters:
  
  platformGUID - unique identifier of the metadata element to withdraw
  
  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)
- removeSoftwareServerPlatform
  
  public void removeSoftwareServerPlatform(String platformGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove the metadata element representing a platform.
  
  Parameters:
  
  platformGUID - 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)
- findSoftwareServerPlatforms
  
  public List<SoftwareServerPlatformElement> findSoftwareServerPlatforms(String searchString, Date effectiveTime, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of platform metadata elements that contain the search string. The search string is treated as a regular expression.
  
  Parameters:
  
  searchString - string to find in the properties
  
  effectiveTime - effective time for the query
  
  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)
- getSoftwareServerPlatformsByName
  
  public List<SoftwareServerPlatformElement> getSoftwareServerPlatformsByName(String name, Date effectiveTime, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of platform metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
  
  Parameters:
  
  name - name to search for
  
  effectiveTime - effective time for the query
  
  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)
- getSoftwareServerPlatformsForInfrastructureManager
  
  public List<SoftwareServerPlatformElement> getSoftwareServerPlatformsForInfrastructureManager(Date effectiveTime, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of platforms created by this caller.
  
  Parameters:
  
  effectiveTime - effective time for the query
  
  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)
- getSoftwareServerPlatformByGUID
  
  public SoftwareServerPlatformElement getSoftwareServerPlatformByGUID(String guid) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the platform metadata element with the supplied unique identifier.
  
  Parameters:
  
  guid - 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)
- createSoftwareServer
  
  public String createSoftwareServer(SoftwareServerProperties softwareServerProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a new metadata element to represent a software server.
  
  Parameters:
  
  softwareServerProperties - 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)
- createSoftwareServerFromTemplate
  
  public String createSoftwareServerFromTemplate(String templateGUID, TemplateProperties templateProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a new metadata element to represent a software server using an existing metadata element as a template.
  
  Parameters:
  
  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)
- updateSoftwareServer
  
  public void updateSoftwareServer(String softwareServerGUID, boolean isMergeUpdate, SoftwareServerProperties softwareServerProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Update the metadata element representing a software server.
  
  Parameters:
  
  softwareServerGUID - unique identifier of the metadata element to update
  
  isMergeUpdate - are unspecified properties unchanged (true) or removed?
  
  softwareServerProperties - 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)
- publishSoftwareServer
  
  public void publishSoftwareServer(String softwareServerGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Update the zones for the software server asset so that it becomes visible to consumers. (The zones are set to the list of zones in the publishedZones option configured for each instance of the IT Infrastructure OMAS).
  
  Parameters:
  
  softwareServerGUID - unique identifier of the metadata element to publish
  
  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)
- withdrawSoftwareServer
  
  public void withdrawSoftwareServer(String softwareServerGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Update the zones for the software server asset so that it is no longer visible to consumers. (The zones are set to the list of zones in the defaultZones option configured for each instance of the IT Infrastructure OMAS. This is the setting when the softwareServer is first created).
  
  Parameters:
  
  softwareServerGUID - unique identifier of the metadata element to withdraw
  
  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)
- removeSoftwareServer
  
  public void removeSoftwareServer(String softwareServerGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove the metadata element representing a software server.
  
  Parameters:
  
  softwareServerGUID - 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)
- findSoftwareServers
  
  public List<SoftwareServerElement> findSoftwareServers(String searchString, Date effectiveTime, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of software server metadata elements that contain the search string. The search string is treated as a regular expression.
  
  Parameters:
  
  searchString - string to find in the properties
  
  effectiveTime - time that the element is effective
  
  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)
- getSoftwareServersByName
  
  public List<SoftwareServerElement> getSoftwareServersByName(String name, Date effectiveTime, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of softwareServer metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
  
  Parameters:
  
  name - name to search for
  
  effectiveTime - time that the element is effective
  
  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)
- getSoftwareServersForInfrastructureManager
  
  public List<SoftwareServerElement> getSoftwareServersForInfrastructureManager(Date effectiveTime, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of software servers created by this caller.
  
  Parameters:
  
  effectiveTime - time that the element is effective
  
  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)
- getSoftwareServerByGUID
  
  public SoftwareServerElement getSoftwareServerByGUID(String guid) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the softwareServer metadata element with the supplied unique identifier.
  
  Parameters:
  
  guid - 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)
- addServerPurpose
  
  public void addServerPurpose(String itAssetGUID, String classificationName, Date effectiveFrom, Date effectiveTo, Map<String,Object> classificationProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Add a Server Purpose classification to an IT asset.
  
  Parameters:
  
  itAssetGUID - unique identifier of the asset
  
  classificationName - name of the classification type
  
  effectiveFrom - when should relationship be effective - null means immediately
  
  effectiveTo - when should relationship no longer be effective - null means never
  
  classificationProperties - 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)
- updateServerPurpose
  
  public void updateServerPurpose(String assetGUID, String classificationName, Date effectiveFrom, Date effectiveTo, boolean isMergeUpdate, Map<String,Object> classificationProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Update the properties of a classification for an asset.
  
  Parameters:
  
  assetGUID - unique identifier of the asset
  
  classificationName - name of the classification type
  
  effectiveFrom - when should relationship be effective - null means immediately
  
  effectiveTo - when should relationship no longer be effective - null means never
  
  isMergeUpdate - should the supplied properties be merged with existing properties (true) by replacing just the properties with matching names, or should the entire properties of the instance be replaced?
  
  classificationProperties - 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)
- clearServerPurpose
  
  public void clearServerPurpose(String assetGUID, String classificationName, Date effectiveTime) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove a server purpose classification.
  
  Parameters:
  
  assetGUID - unique identifier of the asset
  
  classificationName - name of the classification type
  
  effectiveTime - effective time of the classification 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)
- deployITAsset
  
  public void deployITAsset(String itAssetGUID, String destinationGUID, DeploymentProperties deploymentProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a relationship that represents the deployment of an IT infrastructure asset to a specific deployment destination (another asset).
  
  Parameters:
  
  itAssetGUID - unique identifier of the IT infrastructure asset
  
  destinationGUID - unique identifier of the destination where the asset is being deployed to
  
  deploymentProperties - 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)
- updateITAssetDeployment
  
  public void updateITAssetDeployment(String deploymentGUID, boolean isMergeUpdate, DeploymentProperties deploymentProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Update a deployment relationship.
  
  Parameters:
  
  deploymentGUID - unique identifier of the relationship
  
  isMergeUpdate - should the supplied properties be merged with existing properties (true) by replacing just the properties with matching names, or should the entire properties of the instance be replaced?
  
  deploymentProperties - 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)
- clearDeployment
  
  public void clearDeployment(String itAssetGUID, String destinationGUID, Date effectiveTime) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove a deployment relationship.
  
  Parameters:
  
  itAssetGUID - unique identifier of the IT infrastructure asset
  
  destinationGUID - unique identifier of the destination where the asset is being deployed to
  
  effectiveTime - time when the deployment is effective
  
  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)
- getDeployedITAssets
  
  public List<DeploymentElement> getDeployedITAssets(String destinationGUID, Date effectiveTime, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Return the list of assets deployed on a particular destination.
  
  Parameters:
  
  destinationGUID - unique identifier of the destination asset to query
  
  effectiveTime - effective time for the query
  
  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)
- getDeploymentDestinations
  
  public List<DeploymentElement> getDeploymentDestinations(String itAssetGUID, Date effectiveTime, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Return the list of destinations that a particular IT infrastructure asset is deployed to.
  
  Parameters:
  
  itAssetGUID - unique identifier of the IT infrastructure asset to query
  
  effectiveTime - effective time for the query
  
  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)
- createSoftwareCapability
  
  public String createSoftwareCapability(String classificationName, SoftwareCapabilityProperties capabilityProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a new metadata element to represent a software server capability.
  
  Parameters:
  
  classificationName - optional classification name that refines the type of the software server capability.
  
  capabilityProperties - 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)
- createSoftwareCapabilityFromTemplate
  
  public String createSoftwareCapabilityFromTemplate(String templateGUID, TemplateProperties templateProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a new metadata element to represent a software capability using an existing metadata element as a template.
  
  Parameters:
  
  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)
- updateSoftwareCapability
  
  public void updateSoftwareCapability(String capabilityGUID, boolean isMergeUpdate, SoftwareCapabilityProperties capabilityProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Update the metadata element representing a software capability.
  
  Parameters:
  
  capabilityGUID - unique identifier of the metadata element to update
  
  isMergeUpdate - are unspecified properties unchanged (true) or removed?
  
  capabilityProperties - 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)
- deployCapability
  
  public void deployCapability(String capabilityGUID, String infrastructureAssetGUID, CapabilityDeploymentProperties deploymentProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Link a software capability to a software server.
  
  Parameters:
  
  capabilityGUID - unique identifier of the software server capability
  
  infrastructureAssetGUID - unique identifier of the software server
  
  deploymentProperties - describes the deployment of the capability onto the server
  
  Throws:
  
  InvalidParameterException - one of the guids is null or not known
  
  PropertyServerException - problem accessing property server
  
  UserNotAuthorizedException - security access problem
- updateCapabilityDeployment
  
  public void updateCapabilityDeployment(String deploymentGUID, boolean isMergeUpdate, CapabilityDeploymentProperties deploymentProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Update the properties of a server capability's deployment.
  
  Parameters:
  
  deploymentGUID - unique identifier of the relationship
  
  deploymentProperties - describes the deployment of the capability onto the server
  
  isMergeUpdate - are unspecified properties unchanged (true) or removed?
  
  Throws:
  
  InvalidParameterException - one of the guids is null or not known
  
  PropertyServerException - problem accessing property server
  
  UserNotAuthorizedException - security access problem
- removeCapabilityDeployment
  
  public void removeCapabilityDeployment(String itAssetGUID, String capabilityGUID, Date effectiveTime) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove the link between a software server capability and a software server.
  
  Parameters:
  
  itAssetGUID - unique identifier of the software server/platform/host
  
  capabilityGUID - unique identifier of the software server capability
  
  effectiveTime - time that the relationship is effective
  
  Throws:
  
  InvalidParameterException - one of the guids is null or not known
  
  PropertyServerException - problem accessing property server
  
  UserNotAuthorizedException - security access problem
- removeSoftwareCapability
  
  public void removeSoftwareCapability(String capabilityGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove the metadata element representing a software capability.
  
  Parameters:
  
  capabilityGUID - 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)
- findSoftwareCapabilities
  
  public List<SoftwareCapabilityElement> findSoftwareCapabilities(String searchString, Date effectiveTime, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of software capability metadata elements that contain the search string. The search string is treated as a regular expression.
  
  Parameters:
  
  searchString - string to find in the properties
  
  effectiveTime - effective time for the query
  
  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)
- getSoftwareCapabilitiesByName
  
  public List<SoftwareCapabilityElement> getSoftwareCapabilitiesByName(String name, Date effectiveTime, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of software capability metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
  
  Parameters:
  
  name - name to search for
  
  effectiveTime - effective time for the query
  
  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)
- getSoftwareCapabilityDeployments
  
  public List<RelatedAssetElement> getSoftwareCapabilityDeployments(String guid, Date effectiveTime, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the IT asset metadata elements where the software with the supplied unique identifier is deployed.
  
  Parameters:
  
  guid - unique identifier of the requested metadata element
  
  effectiveTime - effective time for the query
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of related IT Assets
  
  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)
- getDeployedSoftwareCapabilities
  
  public List<SoftwareCapabilityElement> getDeployedSoftwareCapabilities(String itAssetGUID, Date effectiveTime, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the software capabilities that are deployed to an IT asset.
  
  Parameters:
  
  itAssetGUID - unique identifier of the hosting metadata element
  
  effectiveTime - effective time for the query
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of related IT Assets
  
  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)
- getSoftwareCapabilitiesForInfrastructureManager
  
  public List<SoftwareCapabilityElement> getSoftwareCapabilitiesForInfrastructureManager(Date effectiveTime, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of capabilities created by this caller.
  
  Parameters:
  
  effectiveTime - effective time for the query
  
  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)
- getSoftwareCapabilityByGUID
  
  public SoftwareCapabilityElement getSoftwareCapabilityByGUID(String guid) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the software capability metadata element with the supplied unique identifier.
  
  Parameters:
  
  guid - 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)
- createServerAssetUse
  
  public String createServerAssetUse(String capabilityGUID, String assetGUID, ServerAssetUseProperties properties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a new metadata relationship to represent the use of an asset by a software server capability.
  
  Parameters:
  
  capabilityGUID - unique identifier of a software server capability
  
  assetGUID - unique identifier of an asset
  
  properties - properties about the ServerAssetUse relationship
  
  Returns:
  
  unique identifier of the new ServerAssetUse 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)
- updateServerAssetUse
  
  public void updateServerAssetUse(String serverAssetUseGUID, boolean isMergeUpdate, ServerAssetUseProperties properties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Update the metadata relationship to represent the use of an asset by a software server capability.
  
  Parameters:
  
  serverAssetUseGUID - unique identifier of the relationship between a software server capability and an asset
  
  isMergeUpdate - are unspecified properties unchanged (true) or removed?
  
  properties - new properties for the ServerAssetUse 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)
- removeServerAssetUse
  
  public void removeServerAssetUse(String serverAssetUseGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove the metadata relationship to represent the use of an asset by a software server capability.
  
  Parameters:
  
  serverAssetUseGUID - unique identifier of the relationship between a software server capability and an asset
  
  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)
- getServerAssetUsesForCapability
  
  public List<ServerAssetUseElement> getServerAssetUsesForCapability(String capabilityGUID, ServerAssetUseType useType, Date effectiveTime, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Return the list of server asset use relationships associated with a software server capability.
  
  Parameters:
  
  capabilityGUID - unique identifier of the software server capability to query
  
  useType - value to search for. Null means all use types.
  
  effectiveTime - effective time for the query
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of matching relationships
  
  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)
- getCapabilityUsesForAsset
  
  public List<ServerAssetUseElement> getCapabilityUsesForAsset(String assetGUID, ServerAssetUseType useType, Date effectiveTime, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Return the list of software server capabilities that make use of a specific asset.
  
  Parameters:
  
  assetGUID - unique identifier of the asset to query
  
  useType - Optionally restrict the search to a specific user type. Null means all use types.
  
  effectiveTime - effective time for the query
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of matching relationships
  
  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)
- getServerAssetUsesForElements
  
  public List<ServerAssetUseElement> getServerAssetUsesForElements(String capabilityGUID, String assetGUID, Date effectiveTime, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of relationships between a specific software server capability and a specific asset.
  
  Parameters:
  
  capabilityGUID - unique identifier of a software server capability
  
  assetGUID - unique identifier of an asset
  
  effectiveTime - effective time for the query
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of matching relationships
  
  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)
- getServerAssetUseByGUID
  
  public ServerAssetUseElement getServerAssetUseByGUID(String guid) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the server asset use type relationship with the supplied unique identifier.
  
  Parameters:
  
  guid - unique identifier of the requested metadata element
  
  Returns:
  
  requested 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)
- createDataAsset
  
  public String createDataAsset(DataAssetProperties dataAssetProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a new metadata element to represent the root of an asset.
  
  Parameters:
  
  dataAssetProperties - 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)
- createDataAssetFromTemplate
  
  public String createDataAssetFromTemplate(String templateGUID, TemplateProperties templateProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a new metadata element to represent an asset using an existing metadata element as a template. The template defines additional classifications and relationships that should be added to the new asset.
  
  Parameters:
  
  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)
- updateDataAsset
  
  public void updateDataAsset(String assetGUID, boolean isMergeUpdate, DataAssetProperties dataAssetProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Update the metadata element representing an asset.
  
  Parameters:
  
  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)?
  
  dataAssetProperties - 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)
- setDataAssetAsReferenceData
  
  public void setDataAssetAsReferenceData(String assetGUID, Date effectiveFrom, Date effectiveTo) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Classify the asset to indicate that it can be used as reference data.
  
  Parameters:
  
  assetGUID - unique identifier of the metadata element to update
  
  effectiveFrom - when should classification be effective - null means immediately
  
  effectiveTo - when should classification no longer be effective - null means never
  
  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)
- clearDataAssetAsReferenceData
  
  public void clearDataAssetAsReferenceData(String assetGUID, Date effectiveTime) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove the reference data designation from the asset.
  
  Parameters:
  
  assetGUID - unique identifier of the metadata element to update
  
  effectiveTime - time when the classification is effective
  
  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)
- publishDataAsset
  
  public void publishDataAsset(String assetGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Update the zones for the asset so that it becomes visible to consumers. (The zones are set to the list of zones in the publishedZones option configured for each instance of the IT Infrastructure OMAS).
  
  Parameters:
  
  assetGUID - unique identifier of the metadata element to publish
  
  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)
- withdrawDataAsset
  
  public void withdrawDataAsset(String assetGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Update the zones for the asset so that it is no longer visible to consumers. (The zones are set to the list of zones in the defaultZones option configured for each instance of the IT Infrastructure OMAS).
  
  Parameters:
  
  assetGUID - unique identifier of the metadata element to withdraw
  
  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)
- removeDataAsset
  
  public void removeDataAsset(String assetGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove the metadata element representing an asset. This will delete the asset and all anchored elements such as schema and comments.
  
  Parameters:
  
  assetGUID - 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)
- findDataAssets
  
  public List<DataAssetElement> findDataAssets(String searchString, Date effectiveTime, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of asset metadata elements that contain the search string. The search string is treated as a regular expression.
  
  Parameters:
  
  searchString - string to find in the properties
  
  effectiveTime - effective time for the query
  
  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)
- getDataAssetsByName
  
  public List<DataAssetElement> getDataAssetsByName(String name, Date effectiveTime, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of asset metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
  
  Parameters:
  
  name - name to search for
  
  effectiveTime - effective time for the query
  
  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)
- getDataAssetsForInfrastructureManager
  
  public List<DataAssetElement> getDataAssetsForInfrastructureManager(Date effectiveTime, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of assets created on behalf of the named infrastructure manager.
  
  Parameters:
  
  effectiveTime - effective time for the query
  
  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)
- getDataAssetByGUID
  
  public DataAssetElement getDataAssetByGUID(String guid) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the asset metadata element with the supplied unique identifier.
  
  Parameters:
  
  guid - 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)
- createProcess
  
  public String createProcess(ProcessStatus processStatus, ProcessProperties processProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a new metadata element to represent a process.
  
  Parameters:
  
  processStatus - initial status of the process
  
  processProperties - properties about the process to store
  
  Returns:
  
  unique identifier of the new process
  
  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)
- createProcessFromTemplate
  
  public String createProcessFromTemplate(String templateGUID, TemplateProperties templateProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a new metadata element to represent a process using an existing metadata element as a template.
  
  Parameters:
  
  templateGUID - unique identifier of the metadata element to copy
  
  templateProperties - properties that override the template
  
  Returns:
  
  unique identifier of the new process
  
  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)
- updateProcess
  
  public void updateProcess(String processGUID, boolean isMergeUpdate, ProcessProperties processProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Update the metadata element representing a process.
  
  Parameters:
  
  processGUID - unique identifier of the metadata element to update
  
  isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
  
  processProperties - 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)
- updateProcessStatus
  
  public void updateProcessStatus(String processGUID, ProcessStatus processStatus) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Update the status of the metadata element representing a process.
  
  Parameters:
  
  processGUID - unique identifier of the process to update
  
  processStatus - new status for the process
  
  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)
- setupProcessParent
  
  public void setupProcessParent(String parentProcessGUID, String childProcessGUID, ProcessContainmentType containmentType, Date effectiveFrom, Date effectiveTo) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a parent-child relationship between two processes.
  
  Parameters:
  
  parentProcessGUID - unique identifier of the process in the external infrastructure manager that is to be the parent process
  
  childProcessGUID - unique identifier of the process in the external infrastructure manager that is to be the nested sub-process
  
  containmentType - describes the ownership of the sub-process
  
  effectiveFrom - time when this relationship is effective - null means immediately
  
  effectiveTo - time when this relationship is no longer effective - null means forever
  
  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)
- clearProcessParent
  
  public void clearProcessParent(String parentProcessGUID, String childProcessGUID, Date effectiveTime) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove a parent-child relationship between two processes.
  
  Parameters:
  
  parentProcessGUID - unique identifier of the process in the external infrastructure manager that is to be the parent process
  
  childProcessGUID - unique identifier of the process in the external infrastructure manager that is to be the nested sub-process
  
  effectiveTime - time when the relationship is effective
  
  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)
- publishProcess
  
  public void publishProcess(String processGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Update the zones for the asset so that it becomes visible to consumers. (The zones are set to the list of zones in the publishedZones option configured for each instance of the IT Infrastructure OMAS).
  
  Parameters:
  
  processGUID - unique identifier of the metadata element to publish
  
  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)
- withdrawProcess
  
  public void withdrawProcess(String processGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Update the zones for the asset so that it is no longer visible to consumers. (The zones are set to the list of zones in the defaultZones option configured for each instance of the IT Infrastructure OMAS. This is the setting when the host is first created).
  
  Parameters:
  
  processGUID - unique identifier of the metadata element to withdraw
  
  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)
- removeProcess
  
  public void removeProcess(String processGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove the metadata element representing a process.
  
  Parameters:
  
  processGUID - 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)
- findProcesses
  
  public List<ProcessElement> findProcesses(String searchString, Date effectiveTime, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of process metadata elements that contain the search string. The search string is treated as a regular expression.
  
  Parameters:
  
  searchString - string to find in the properties
  
  effectiveTime - effective time for the query
  
  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)
- getProcessesByName
  
  public List<ProcessElement> getProcessesByName(String name, Date effectiveTime, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of process metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
  
  Parameters:
  
  name - name to search for
  
  effectiveTime - effective time for the query
  
  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)
- getProcessesForInfrastructureManager
  
  public List<ProcessElement> getProcessesForInfrastructureManager(Date effectiveTime, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Return the list of processes associated with the infrastructure manager.
  
  Parameters:
  
  effectiveTime - effective time for the query
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of metadata elements describing the processes associated with the requested infrastructure 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)
- getProcessByGUID
  
  public ProcessElement getProcessByGUID(String processGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the process metadata element with the supplied unique identifier.
  
  Parameters:
  
  processGUID - 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)
- getProcessParent
  
  public ProcessElement getProcessParent(String processGUID, Date effectiveTime) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the process metadata element with the supplied unique identifier.
  
  Parameters:
  
  processGUID - unique identifier of the requested metadata element
  
  effectiveTime - effective time for the query
  
  Returns:
  
  parent process 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)
- getSubProcesses
  
  public List<ProcessElement> getSubProcesses(String processGUID, Date effectiveTime, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the process metadata element with the supplied unique identifier.
  
  Parameters:
  
  processGUID - unique identifier of the requested metadata element
  
  effectiveTime - effective time for the query
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of process 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)
- setBusinessSignificant
  
  public void setBusinessSignificant(String elementGUID, Date effectiveFrom, Date effectiveTo) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Classify a port, process or asset as "BusinessSignificant" (this may affect the way that lineage is displayed).
  
  Parameters:
  
  elementGUID - unique identifier of the metadata element to update
  
  effectiveFrom - time when this hosting is effective - null means immediately
  
  effectiveTo - time when this hosting is no longer effective - null means forever
  
  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)
- clearBusinessSignificant
  
  public void clearBusinessSignificant(String elementGUID, Date effectiveTime) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove the "BusinessSignificant" designation from the element.
  
  Parameters:
  
  effectiveTime - effective time for the query
  
  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)
- setupDataFlow
  
  public String setupDataFlow(String dataSupplierGUID, String dataConsumerGUID, DataFlowProperties properties, Date effectiveTime) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Link two elements together to show that data flows from one to the other.
  
  Parameters:
  
  dataSupplierGUID - unique identifier of the data supplier
  
  dataConsumerGUID - unique identifier of the data consumer
  
  properties - unique identifier for this relationship along with description and/or additional relevant properties
  
  effectiveTime - optional date for effective time of the query. Null means any effective time
  
  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)
- getDataFlow
  
  public DataFlowElement getDataFlow(String dataSupplierGUID, String dataConsumerGUID, String qualifiedName, Date effectiveTime) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the data flow relationship between two elements. The qualifiedName is optional unless there is more than one data flow relationships between these two elements since it is used to disambiguate the request. This is often used in conjunction with update.
  
  Parameters:
  
  dataSupplierGUID - unique identifier of the data supplier
  
  dataConsumerGUID - unique identifier of the data consumer
  
  qualifiedName - unique identifier for this relationship
  
  effectiveTime - time when the hosting is effective
  
  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)
- updateDataFlow
  
  public void updateDataFlow(String dataFlowGUID, DataFlowProperties properties, Date effectiveTime) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Update relationship between two elements that shows that data flows from one to the other.
  
  Parameters:
  
  dataFlowGUID - unique identifier of the data flow relationship
  
  properties - unique identifier for this relationship along with description and/or additional relevant properties
  
  effectiveTime - optional date for effective time of the query. Null means any effective time
  
  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)
- clearDataFlow
  
  public void clearDataFlow(String dataFlowGUID, Date effectiveTime) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove the data flow relationship between two elements.
  
  Parameters:
  
  dataFlowGUID - unique identifier of the data flow relationship
  
  effectiveTime - time when the relationship is effective
  
  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)
- getDataFlowConsumers
  
  public List<DataFlowElement> getDataFlowConsumers(String dataSupplierGUID, int startFrom, int pageSize, Date effectiveTime) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the data flow relationships linked from a specific element to the downstream consumers.
  
  Parameters:
  
  dataSupplierGUID - unique identifier of the data supplier
  
  effectiveTime - time when the hosting is effective
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  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)
- getDataFlowSuppliers
  
  public List<DataFlowElement> getDataFlowSuppliers(String dataConsumerGUID, int startFrom, int pageSize, Date effectiveTime) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the data flow relationships linked from a specific element to the upstream suppliers.
  
  Parameters:
  
  dataConsumerGUID - unique identifier of the data consumer
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  effectiveTime - time when the hosting is effective
  
  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)
- setupControlFlow
  
  public String setupControlFlow(String currentStepGUID, String nextStepGUID, ControlFlowProperties properties, Date effectiveTime) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Link two elements to show that when one completes the next is started.
  
  Parameters:
  
  currentStepGUID - unique identifier of the previous step
  
  nextStepGUID - unique identifier of the next step
  
  properties - unique identifier for this relationship along with description and/or additional relevant properties
  
  effectiveTime - optional date for effective time of the query. Null means any effective time
  
  Returns:
  
  unique identifier for the control flow 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)
- getControlFlow
  
  public ControlFlowElement getControlFlow(String currentStepGUID, String nextStepGUID, String qualifiedName, Date effectiveTime) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the control flow relationship between two elements. The qualifiedName is optional unless there is more than one control flow relationships between these two elements since it is used to disambiguate the request. This is often used in conjunction with update.
  
  Parameters:
  
  currentStepGUID - unique identifier of the previous step
  
  nextStepGUID - unique identifier of the next step
  
  qualifiedName - unique identifier for this relationship
  
  effectiveTime - time when the hosting is effective
  
  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)
- updateControlFlow
  
  public void updateControlFlow(String controlFlowGUID, ControlFlowProperties properties, Date effectiveTime) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Update the relationship between two elements that shows that when one completes the next is started.
  
  Parameters:
  
  controlFlowGUID - unique identifier of the control flow relationship
  
  properties - unique identifier for this relationship along with description and/or additional relevant properties
  
  effectiveTime - optional date for effective time of the query. Null means any effective time
  
  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)
- clearControlFlow
  
  public void clearControlFlow(String controlFlowGUID, Date effectiveTime) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove the control flow relationship between two elements.
  
  Parameters:
  
  controlFlowGUID - unique identifier of the control flow relationship
  
  effectiveTime - time when the relationship is effective
  
  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)
- getControlFlowNextSteps
  
  public List<ControlFlowElement> getControlFlowNextSteps(String currentStepGUID, int startFrom, int pageSize, Date effectiveTime) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the control relationships linked from a specific element to the possible next elements in the process.
  
  Parameters:
  
  currentStepGUID - unique identifier of the current step
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  effectiveTime - time when the hosting is effective
  
  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)
- getControlFlowPreviousSteps
  
  public List<ControlFlowElement> getControlFlowPreviousSteps(String currentStepGUID, int startFrom, int pageSize, Date effectiveTime) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the control relationships linked from a specific element to the possible previous elements in the process.
  
  Parameters:
  
  currentStepGUID - unique identifier of the current step
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  effectiveTime - time when the hosting is effective
  
  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)
- setupProcessCall
  
  public String setupProcessCall(String callerGUID, String calledGUID, ProcessCallProperties properties, Date effectiveTime) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Link two elements together to show a request-response call between them.
  
  Parameters:
  
  callerGUID - unique identifier of the element that is making the call
  
  calledGUID - unique identifier of the element that is processing the call
  
  properties - unique identifier for this relationship along with description and/or additional relevant properties
  
  effectiveTime - optional date for effective time of the query. Null means any effective time
  
  Returns:
  
  unique identifier of the new 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)
- getProcessCall
  
  public ProcessCallElement getProcessCall(String callerGUID, String calledGUID, String qualifiedName, Date effectiveTime) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the process call relationship between two elements. The qualifiedName is optional unless there is more than one process call relationships between these two elements since it is used to disambiguate the request. This is often used in conjunction with update.
  
  Parameters:
  
  callerGUID - unique identifier of the element that is making the call
  
  calledGUID - unique identifier of the element that is processing the call
  
  qualifiedName - unique identifier for this relationship
  
  effectiveTime - time when the hosting is effective
  
  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)
- updateProcessCall
  
  public void updateProcessCall(String processCallGUID, ProcessCallProperties properties, Date effectiveTime) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Update the relationship between two elements that shows a request-response call between them.
  
  Parameters:
  
  processCallGUID - unique identifier of the process call relationship
  
  properties - unique identifier for this relationship along with description and/or additional relevant properties
  
  effectiveTime - optional date for effective time of the query. Null means any effective time
  
  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)
- clearProcessCall
  
  public void clearProcessCall(String processCallGUID, Date effectiveTime) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove the process call relationship.
  
  Parameters:
  
  processCallGUID - unique identifier of the process call relationship
  
  effectiveTime - time when the relationship is effective
  
  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)
- getProcessCalled
  
  public List<ProcessCallElement> getProcessCalled(String callerGUID, int startFrom, int pageSize, Date effectiveTime) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the process call relationships linked from a specific element to the elements it calls.
  
  Parameters:
  
  callerGUID - unique identifier of the element that is making the call
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  effectiveTime - time when the hosting is effective
  
  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)
- getProcessCallers
  
  public List<ProcessCallElement> getProcessCallers(String calledGUID, int startFrom, int pageSize, Date effectiveTime) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the process call relationships linked from a specific element to its callers.
  
  Parameters:
  
  calledGUID - unique identifier of the element that is processing the call
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  effectiveTime - time when the hosting is effective
  
  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)
- setupLineageMapping
  
  public void setupLineageMapping(String sourceElementGUID, String destinationElementGUID, LineageMappingProperties properties, Date effectiveTime) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Link two elements together to show that they are part of the lineage of the data that is moving between the processes. Typically, the lineage relationships stitch together processes and data assets supported by different technologies.
  
  Parameters:
  
  sourceElementGUID - unique identifier of the source
  
  destinationElementGUID - unique identifier of the destination
  
  properties - unique identifier for this relationship along with description and/or additional relevant properties
  
  effectiveTime - optional date for effective time of the query. Null means any effective time
  
  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)
- getLineageMapping
  
  public LineageMappingElement getLineageMapping(String sourceElementGUID, String destinationElementGUID, String qualifiedName, Date effectiveTime) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the lineage mapping relationship between two elements. The qualifiedName is optional unless there is more than one relationship between these two elements since it is used to disambiguate the request. This is often used in conjunction with update.
  
  Parameters:
  
  sourceElementGUID - unique identifier of the source
  
  destinationElementGUID - unique identifier of the destination
  
  qualifiedName - unique identifier for this relationship
  
  effectiveTime - time when the hosting is effective
  
  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)
- updateLineageMapping
  
  public void updateLineageMapping(String lineageMappingGUID, LineageMappingProperties properties, Date effectiveTime) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Update the lineage mapping relationship between two elements.
  
  Parameters:
  
  lineageMappingGUID - unique identifier of the relationship
  
  properties - unique identifier for this relationship along with description and/or additional relevant properties
  
  effectiveTime - optional date for effective time of the query. Null means any effective time
  
  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)
- clearLineageMapping
  
  public void clearLineageMapping(String lineageMappingGUID, Date effectiveTime) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove the lineage mapping between two elements.
  
  Parameters:
  
  lineageMappingGUID - unique identifier of the source
  
  effectiveTime - time when the relationship is effective
  
  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)
- getDestinationLineageMappings
  
  public List<LineageMappingElement> getDestinationLineageMappings(String sourceElementGUID, int startFrom, int pageSize, Date effectiveTime) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the lineage mapping relationships linked from a specific source element to its destinations.
  
  Parameters:
  
  sourceElementGUID - unique identifier of the source
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  effectiveTime - time when the hosting is effective
  
  Returns:
  
  list of lineage mapping relationships
  
  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)
- getSourceLineageMappings
  
  public List<LineageMappingElement> getSourceLineageMappings(String destinationElementGUID, int startFrom, int pageSize, Date effectiveTime) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the lineage mapping relationships linked from a specific destination element to its sources.
  
  Parameters:
  
  destinationElementGUID - unique identifier of the destination
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  effectiveTime - time when the hosting is effective
  
  Returns:
  
  list of lineage mapping relationships
  
  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(ConnectionProperties connectionProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a new metadata element to represent a connection.
  
  Parameters:
  
  connectionProperties - properties about the connection to store
  
  Returns:
  
  unique identifier of the new 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)
- createConnectionFromTemplate
  
  public String createConnectionFromTemplate(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.
  
  Parameters:
  
  templateGUID - unique identifier of the metadata element to copy
  
  templateProperties - properties that override the template
  
  Returns:
  
  unique identifier of the new 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)
- updateConnection
  
  public void updateConnection(String connectionGUID, boolean isMergeUpdate, ConnectionProperties connectionProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Update the metadata element representing a connection. It is possible to use the subtype property classes or set up specialized properties in extended properties.
  
  Parameters:
  
  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 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)
- setupConnectorType
  
  public void setupConnectorType(String connectionGUID, String connectorTypeGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a relationship between a connection and a connector type.
  
  Parameters:
  
  connectionGUID - unique identifier of the connection in the external data manager
  
  connectorTypeGUID - unique identifier of the connector type in the external data 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 connectionGUID, String connectorTypeGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove a relationship between a connection and a connector type.
  
  Parameters:
  
  connectionGUID - unique identifier of the connection in the external data manager
  
  connectorTypeGUID - unique identifier of the connector type in the external data 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 connectionGUID, String endpointGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a relationship between a connection and an endpoint.
  
  Parameters:
  
  connectionGUID - unique identifier of the connection in the external data manager
  
  endpointGUID - unique identifier of the endpoint in the external data 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 connectionGUID, String endpointGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove a relationship between a connection and an endpoint.
  
  Parameters:
  
  connectionGUID - unique identifier of the connection in the external data manager
  
  endpointGUID - unique identifier of the endpoint in the external data 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 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.
  
  Parameters:
  
  connectionGUID - unique identifier of the virtual connection in the external data 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 data 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 connectionGUID, String embeddedConnectionGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove a relationship between a virtual connection and an embedded connection.
  
  Parameters:
  
  connectionGUID - unique identifier of the virtual connection in the external data manager
  
  embeddedConnectionGUID - unique identifier of the embedded connection in the external data 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 assetGUID, String connectionGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a relationship between an asset and its connection.
  
  Parameters:
  
  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)
- clearAssetConnection
  
  public void clearAssetConnection(String assetGUID, String connectionGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove a relationship between an asset and its connection.
  
  Parameters:
  
  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 connectionGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove the metadata element representing a connection.
  
  Parameters:
  
  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 searchString, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of metadata elements that contain the search string. The search string is treated as a regular expression.
  
  Parameters:
  
  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)
- getConnectionsByName
  
  public List<ConnectionElement> getConnectionsByName(String name, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
  
  Parameters:
  
  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 connectionGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the metadata element with the supplied unique identifier.
  
  Parameters:
  
  connectionGUID - 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)
- createEndpoint
  
  public String createEndpoint(String infrastructureGUID, EndpointProperties endpointProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a new metadata element to represent an endpoint
  
  Parameters:
  
  infrastructureGUID - unique identifier of the infrastructure to connect it to (optional)
  
  endpointProperties - properties about the endpoint to store
  
  Returns:
  
  unique identifier of the new endpoint
  
  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 infrastructureGUID, String networkAddress, String templateGUID, TemplateProperties templateProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a new metadata element to represent a endpoint using an existing metadata element as a template.
  
  Parameters:
  
  infrastructureGUID - unique identifier of the infrastructure to connect it to (optional)
  
  networkAddress - location of the endpoint
  
  templateGUID - unique identifier of the metadata element to copy
  
  templateProperties - descriptive properties that override the template
  
  Returns:
  
  unique identifier of the new endpoint
  
  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(boolean isMergeUpdate, String endpointGUID, EndpointProperties endpointProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Update the metadata element representing an endpoint. It is possible to use the subtype property classes or set up specialized properties in extended properties.
  
  Parameters:
  
  endpointGUID - unique identifier of the metadata element to update
  
  isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
  
  endpointProperties - 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)
- removeEndpoint
  
  public void removeEndpoint(String endpointGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove the metadata element representing a endpoint.
  
  Parameters:
  
  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 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.
  
  Parameters:
  
  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 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.
  
  Parameters:
  
  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)
- getEndpointsByNetworkAddress
  
  public List<EndpointElement> getEndpointsByNetworkAddress(String networkAddress, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of endpoint metadata elements with a matching networkAddress. There are no wildcards supported on this request.
  
  Parameters:
  
  networkAddress - networkAddress 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)
- getEndpointsForInfrastructure
  
  public List<EndpointElement> getEndpointsForInfrastructure(String infrastructureGUID, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of endpoint metadata elements that are attached to a specific infrastructure element.
  
  Parameters:
  
  infrastructureGUID - element 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 endpointGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the endpoint metadata element with the supplied unique identifier.
  
  Parameters:
  
  endpointGUID - 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)
- createConnectorType
  
  public String createConnectorType(ConnectorTypeProperties connectorTypeProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a new metadata element to represent an connectorType
  
  Parameters:
  
  connectorTypeProperties - properties about the connector type to store
  
  Returns:
  
  unique identifier of the new connectorType
  
  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)
- createConnectorTypeFromTemplate
  
  public String createConnectorTypeFromTemplate(String templateGUID, TemplateProperties templateProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a new metadata element to represent an connectorType using an existing metadata element as a template.
  
  Parameters:
  
  templateGUID - unique identifier of the metadata element to copy
  
  templateProperties - descriptive properties that override the template
  
  Returns:
  
  unique identifier of the new connectorType
  
  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)
- updateConnectorType
  
  public void updateConnectorType(boolean isMergeUpdate, String connectorTypeGUID, ConnectorTypeProperties connectorTypeProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Update the metadata element representing an connectorType. It is possible to use the subtype property classes or set up specialized properties in extended properties.
  
  Parameters:
  
  connectorTypeGUID - unique identifier of the metadata element to update
  
  isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
  
  connectorTypeProperties - 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)
- removeConnectorType
  
  public void removeConnectorType(String connectorTypeGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove the metadata element representing an connectorType.
  
  Parameters:
  
  connectorTypeGUID - 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)
- findConnectorTypes
  
  public List<ConnectorTypeElement> findConnectorTypes(String searchString, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of connector type metadata elements that contain the search string. The search string is treated as a regular expression.
  
  Parameters:
  
  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 name, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of connector type metadata elements with a matching qualified name, display name or connector provider class name. There are no wildcards supported on this request.
  
  Parameters:
  
  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 connectorTypeGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the connector type metadata element with the supplied unique identifier.
  
  Parameters:
  
  connectorTypeGUID - 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)
- createITProfile
  
  public String createITProfile(String itInfrastructureGUID, String itUserId, ITProfileProperties properties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a definition of an IT profile. If the itInfrastructureGUID is provided, it is connected to the infrastructure element that the profile describes using the ITInfrastructureProfile relationship. If the itUserId is specified, a UserIdentity for that userId is found/created and connected to the new IT profile.
  
  Parameters:
  
  itInfrastructureGUID - unique identifier of the piece of IT infrastructure that is described by the new IT profile.
  
  itUserId - userId used by the IT Infrastructure
  
  properties - properties for an IT profile
  
  Returns:
  
  unique identifier of IT profile
  
  Throws:
  
  InvalidParameterException - qualifiedName or userId is null; qualifiedName is not unique
  
  PropertyServerException - problem accessing property server
  
  UserNotAuthorizedException - security access problem
- updateITProfile
  
  public void updateITProfile(String itProfileGUID, boolean isMergeUpdate, ITProfileProperties properties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Update the definition of an IT profile.
  
  Parameters:
  
  itProfileGUID - unique identifier of IT profile
  
  isMergeUpdate - are unspecified properties unchanged (true) or replaced with null?
  
  properties - properties to change
  
  Throws:
  
  InvalidParameterException - guid, qualifiedName or userId is null; qualifiedName is not unique; guid is not known
  
  PropertyServerException - problem accessing property server
  
  UserNotAuthorizedException - security access problem
- deleteITProfile
  
  public void deleteITProfile(String itProfileGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove the definition of an IT profile.
  
  Parameters:
  
  itProfileGUID - unique identifier of IT profile
  
  Throws:
  
  InvalidParameterException - guid or userId is null; guid is not known
  
  PropertyServerException - problem accessing property server
  
  UserNotAuthorizedException - security access problem
- addContactMethod
  
  public String addContactMethod(String itProfileGUID, ContactMethodProperties properties) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException
  
  Add a new contact method to the profile.
  
  Parameters:
  
  itProfileGUID - identifier of the profile to update.
  
  properties - properties of contact method.
  
  Returns:
  
  unique identifier (guid) for the new contact method.
  
  Throws:
  
  InvalidParameterException - the userId is null or invalid. Another property 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.
- deleteContactMethod
  
  public void deleteContactMethod(String contactMethodGUID) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException
  
  Remove an obsolete contact method from the profile.
  
  Parameters:
  
  contactMethodGUID - unique identifier (guid) for the obsolete contact method.
  
  Throws:
  
  InvalidParameterException - the userId is null or invalid. Another property 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.
- linkITInfrastructureToProfile
  
  public void linkITInfrastructureToProfile(String itInfrastructureGUID, String itProfileGUID, Date effectiveFrom, Date effectiveTo) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Link a piece of infrastructure to an IT profile.
  
  Parameters:
  
  itInfrastructureGUID - unique identifier of the IT Infrastructure element
  
  itProfileGUID - unique identifier of the IT profile
  
  effectiveFrom - start date for the relationship
  
  effectiveTo - end date for the relationship
  
  Throws:
  
  InvalidParameterException - one of the guids is null or not known
  
  PropertyServerException - problem accessing property server
  
  UserNotAuthorizedException - security access problem
- updateITInfrastructureToProfile
  
  public void updateITInfrastructureToProfile(String itInfrastructureGUID, String itProfileGUID, Date effectiveFrom, Date effectiveTo) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Update the effectivity dates of a link from a piece of infrastructure to an IT profile.
  
  Parameters:
  
  itInfrastructureGUID - unique identifier of the IT Infrastructure element
  
  itProfileGUID - unique identifier of the IT profile
  
  effectiveFrom - start date for the relationship
  
  effectiveTo - end date for the relationship
  
  Throws:
  
  InvalidParameterException - one of the guids is null or not known
  
  PropertyServerException - problem accessing property server
  
  UserNotAuthorizedException - security access problem
- unlinkITInfrastructureFromProfile
  
  public void unlinkITInfrastructureFromProfile(String itInfrastructureGUID, String itProfileGUID, Date effectiveTime) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove the link between a piece of infrastructure to an IT profile.
  
  Parameters:
  
  itInfrastructureGUID - unique identifier of the IT Infrastructure element
  
  itProfileGUID - unique identifier of the IT profile
  
  effectiveTime - time that the relationship is active - null for any time
  
  Throws:
  
  InvalidParameterException - one of the guids is null or not known
  
  PropertyServerException - problem accessing property server
  
  UserNotAuthorizedException - security access problem
- getITProfileByGUID
  
  public ITProfileElement getITProfileByGUID(String itProfileGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Return information about a specific IT profile.
  
  Parameters:
  
  itProfileGUID - unique identifier for the IT profile
  
  Returns:
  
  properties of the IT profile
  
  Throws:
  
  InvalidParameterException - itProfileGUID or userId is null
  
  PropertyServerException - problem accessing property server
  
  UserNotAuthorizedException - security access problem
- getITProfileByUserId
  
  public ITProfileElement getITProfileByUserId(String itProfileUserId) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Return information about a specific IT profile.
  
  Parameters:
  
  itProfileUserId - unique identifier for the IT profile
  
  Returns:
  
  properties of the IT profile
  
  Throws:
  
  InvalidParameterException - itProfileUserId or userId is null
  
  PropertyServerException - problem accessing property server
  
  UserNotAuthorizedException - security access problem
- getITProfileByName
  
  public List<ITProfileElement> getITProfileByName(String name, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Return information about a named IT profile.
  
  Parameters:
  
  name - unique name for the IT profile
  
  startFrom - index of the list to start from (0 for start)
  
  pageSize - maximum number of elements to return.
  
  Returns:
  
  list of matching IT profiles (hopefully only one)
  
  Throws:
  
  InvalidParameterException - name or userId is null
  
  PropertyServerException - problem accessing property server
  
  UserNotAuthorizedException - security access problem
- findITProfile
  
  public List<ITProfileElement> findITProfile(String searchString, int startFrom, int pageSize) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException
  
  Retrieve the list of matching profiles for the search string.
  
  Parameters:
  
  searchString - RegEx string to search for
  
  startFrom - index of the list to start from (0 for start)
  
  pageSize - maximum number of elements to return.
  
  Returns:
  
  list of matching IT profiles
  
  Throws:
  
  InvalidParameterException - guid invalid or the external references are not correctly specified, or are null.
  
  PropertyServerException - the server is not available.
  
  UserNotAuthorizedException - the calling user is not authorized to issue the call.
- createUserIdentity
  
  public String createUserIdentity(UserIdentityProperties newIdentity) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException
  
  Create a UserIdentity. This is not connected to a profile.
  
  Parameters:
  
  newIdentity - properties for the new userIdentity.
  
  Returns:
  
  unique identifier of the UserIdentity
  
  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.
- updateUserIdentity
  
  public void updateUserIdentity(String userIdentityGUID, boolean isMergeUpdate, UserIdentityProperties properties) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException
  
  Update a UserIdentity.
  
  Parameters:
  
  userIdentityGUID - unique identifier of the UserIdentity
  
  isMergeUpdate - should the supplied properties be overlaid on the existing properties (true) or replace them (false
  
  properties - updated properties for the new userIdentity
  
  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.
- deleteUserIdentity
  
  public void deleteUserIdentity(String userIdentityGUID) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException
  
  Remove a user identity object. This will fail if the profile would be left without an associated user identity.
  
  Parameters:
  
  userIdentityGUID - unique identifier of the UserIdentity
  
  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.
- addIdentityToProfile
  
  public void addIdentityToProfile(String userIdentityGUID, String profileGUID, ProfileIdentityProperties properties) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException
  
  Link a user identity to a profile. This will fail if the user identity is already connected to a profile.
  
  Parameters:
  
  profileGUID - the profile to add the identity to.
  
  userIdentityGUID - additional userId for the profile.
  
  properties - the properties that describe how the owner of the profile uses the user identity
  
  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.
- updateProfileIdentity
  
  public void updateProfileIdentity(String userIdentityGUID, String profileGUID, boolean isMergeUpdate, ProfileIdentityProperties properties) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException
  
  Update the properties of the relationship between a user identity and profile.
  
  Parameters:
  
  userIdentityGUID - additional userId for the profile
  
  profileGUID - the profile to add the identity to
  
  isMergeUpdate - should the supplied properties be overlaid on the existing properties (true) or replace them (false
  
  properties - the properties that describe how the owner of the profile uses the user identity
  
  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.
- removeIdentityFromProfile
  
  public void removeIdentityFromProfile(String userIdentityGUID, String profileGUID) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException
  
  Unlink a user identity from a profile.
  
  Parameters:
  
  userIdentityGUID - unique identifier of the UserIdentity
  
  profileGUID - profile to remove it from.
  
  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.
- findUserIdentities
  
  public List<UserIdentityElement> findUserIdentities(String searchString, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of user identity metadata elements that contain the search string. The search string is treated as a regular expression.
  
  Parameters:
  
  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)
- getUserIdentitiesByName
  
  public List<UserIdentityElement> getUserIdentitiesByName(String name, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of user identity metadata elements with a matching qualified name. There are no wildcards supported on this request.
  
  Parameters:
  
  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)
- getUserIdentityByGUID
  
  public UserIdentityElement getUserIdentityByGUID(String userIdentityGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the userIdentity metadata element with the supplied unique identifier.
  
  Parameters:
  
  userIdentityGUID - 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)

Class InfrastructureIntegratorContext

Field Summary

Fields inherited from class org.odpi.openmetadata.frameworks.integration.context.IntegrationContext

Constructor Summary

Method Summary

Methods inherited from class org.odpi.openmetadata.frameworks.integration.context.IntegrationContext

Methods inherited from class java.lang.Object

Constructor Details

InfrastructureIntegratorContext

Method Details

setInfrastructureManagerIsHome

registerListener

createHost

createHostFromTemplate

updateHost

setupClusterMember

clearClusterMember

publishHost

withdrawHost

removeHost

findHosts

getHostsByName

getHostsForInfrastructureManager

getClusterMembersForHost

getHostByGUID

createSoftwareServerPlatform

createSoftwareServerPlatformFromTemplate

updateSoftwareServerPlatform

publishSoftwareServerPlatform

withdrawSoftwareServerPlatform

removeSoftwareServerPlatform

findSoftwareServerPlatforms

getSoftwareServerPlatformsByName

getSoftwareServerPlatformsForInfrastructureManager

getSoftwareServerPlatformByGUID

createSoftwareServer

createSoftwareServerFromTemplate

updateSoftwareServer

publishSoftwareServer

withdrawSoftwareServer

removeSoftwareServer

findSoftwareServers

getSoftwareServersByName

getSoftwareServersForInfrastructureManager

getSoftwareServerByGUID

addServerPurpose

updateServerPurpose

clearServerPurpose

deployITAsset

updateITAssetDeployment

clearDeployment

getDeployedITAssets

getDeploymentDestinations

createSoftwareCapability

createSoftwareCapabilityFromTemplate

updateSoftwareCapability

deployCapability

updateCapabilityDeployment

removeCapabilityDeployment

removeSoftwareCapability

findSoftwareCapabilities

getSoftwareCapabilitiesByName

getSoftwareCapabilityDeployments

getDeployedSoftwareCapabilities

getSoftwareCapabilitiesForInfrastructureManager

getSoftwareCapabilityByGUID

createServerAssetUse

updateServerAssetUse

removeServerAssetUse

getServerAssetUsesForCapability

getCapabilityUsesForAsset

getServerAssetUsesForElements

getServerAssetUseByGUID

createDataAsset

createDataAssetFromTemplate

updateDataAsset

setDataAssetAsReferenceData

clearDataAssetAsReferenceData

publishDataAsset

withdrawDataAsset