Package org.odpi.openmetadata.integrationservices.infrastructure.connector

Class InfrastructureIntegratorContext

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, ActorProfileManagement actorProfileManagement, ContactMethodManagement contactMethodManagement, UserIdentityManagement userIdentityClient, 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
void	addSecurityGroupMembership(String userIdentityGUID, SecurityGroupMembershipProperties properties, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime)	Add the SecurityGroupMembership classification to the user identity.
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	createActorProfile(String anchorGUID, boolean isOwnAnchor, String anchorScopeGUID, ActorProfileProperties properties, String parentGUID, String parentRelationshipTypeName, ElementProperties parentRelationshipProperties, boolean parentAtEnd1, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime)	Create a new actor profile.
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	createContactMethod(String actorProfileGUID, ContactMethodProperties properties, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime)	Create a new contact method.
String	createContactMethodFromTemplate(String actorProfileGUID, Date effectiveFrom, Date effectiveTo, String templateGUID, ElementProperties replacementProperties, Map<String,String> placeholderProperties, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime)	Create a new metadata element to represent a contact method using an existing 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	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(String anchorGUID, boolean isOwnAnchor, String anchorScopeGUID, UserIdentityProperties properties, String parentGUID, String parentRelationshipTypeName, ElementProperties parentRelationshipProperties, boolean parentAtEnd1, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime)	Create a new user identity.
String	createUserIdentityFromTemplate(String anchorGUID, boolean isOwnAnchor, String anchorScopeGUID, Date effectiveFrom, Date effectiveTo, String templateGUID, ElementProperties replacementProperties, Map<String,String> placeholderProperties, String parentGUID, String parentRelationshipTypeName, ElementProperties parentRelationshipProperties, boolean parentAtEnd1, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime)	Create a new metadata element to represent a user identity using an existing element as a template.
void	deleteActorProfile(String actorProfileGUID, boolean cascadedDelete, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime)	Delete a actor profile.
void	deleteContactMethod(String contactMethodGUID, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime)	Delete a contact method.
void	deleteUserIdentity(String userIdentityGUID, boolean cascadedDelete, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime)	Delete a user identity.
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).
void	detachAssetFromProfile(String assetGUID, String itProfileGUID, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime)	Detach an asset from an IT profile.
void	detachLocationFromProfile(String actorProfileGUID, String locationGUID, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime)	Detach an actor profile from a location.
void	detachProfileIdentity(String userIdentityGUID, String profileGUID, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime)	Detach an actor profile from a user identity.
List<ActorProfileElement>	findActorProfiles(String searchString, TemplateFilter templateFilter, List<ElementStatus> limitResultsByStatus, Date asOfTime, SequencingOrder sequencingOrder, String sequencingProperty, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime)	Retrieve the list of actor profiles metadata elements that contain the search string and show which solution components (if any) are attached to it.
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<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, TemplateFilter templateFilter, List<ElementStatus> limitResultsByStatus, Date asOfTime, SequencingOrder sequencingOrder, String sequencingProperty, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime)	Retrieve the list of user identities metadata elements that contain the search string.
ActorProfileElement	getActorProfileByGUID(String actorProfileGUID, Date asOfTime, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime)	Return the properties of a specific actor profile.
ActorProfileElement	getActorProfileByUserId(String requiredUserId, Date asOfTime, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime)	Return the properties of a specific actor profile retrieved using an associated userId.
List<ActorProfileElement>	getActorProfilesByName(String name, TemplateFilter templateFilter, List<ElementStatus> limitResultsByStatus, Date asOfTime, SequencingOrder sequencingOrder, String sequencingProperty, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime)	Returns the list of actor profiles with a particular name.
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.
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, TemplateFilter templateFilter, List<ElementStatus> limitResultsByStatus, Date asOfTime, SequencingOrder sequencingOrder, String sequencingProperty, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime)	Returns the list of user identities with a particular name.
UserIdentityElement	getUserIdentityByGUID(String userIdentityGUID, Date asOfTime, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime)	Return the properties of a specific user identity.
void	linkAssetToProfile(String assetGUID, String itProfileGUID, ITInfrastructureProfileProperties relationshipProperties, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime)	Attach an asset to an IT profile.
void	linkIdentityToProfile(String userIdentityGUID, String profileGUID, ProfileIdentityProperties relationshipProperties, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime)	Attach a profile to a user identity.
void	linkLocationToProfile(String actorProfileGUID, String locationGUID, ProfileLocationProperties relationshipProperties, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime)	Attach a profile to a location.
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	removeAllSecurityGroupMembership(String userIdentityGUID, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime)	Remove the SecurityGroupMembership classification from the user identity.
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	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	updateActorProfile(String actorProfileGUID, boolean replaceAllProperties, ActorProfileProperties properties, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime)	Update the properties of an actor 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	updateContactMethod(String contactMethodGUID, boolean replaceAllProperties, ContactMethodProperties properties, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime)	Update the properties of a contact method.
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	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	updateSecurityGroupMembership(String userIdentityGUID, SecurityGroupMembershipProperties properties, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime)	Update the SecurityGroupMembership classification for the user identity.
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 replaceAllProperties, UserIdentityProperties properties, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime)	Update the properties of a user identity.
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,
 ActorProfileManagement actorProfileManagement,
 ContactMethodManagement contactMethodManagement,
 UserIdentityManagement userIdentityClient,
 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

actorProfileManagement - client for IT profiles

contactMethodManagement - client for IT profiles

userIdentityClient - client form managing user identities

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)

createActorProfile

public String createActorProfile(String anchorGUID,
 boolean isOwnAnchor,
 String anchorScopeGUID,
 ActorProfileProperties properties,
 String parentGUID,
 String parentRelationshipTypeName,
 ElementProperties parentRelationshipProperties,
 boolean parentAtEnd1,
 boolean forLineage,
 boolean forDuplicateProcessing,
 Date effectiveTime)
                          throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Create a new actor profile.

Parameters:

anchorGUID - unique identifier of the element that should be the anchor for the new element. Set to null if no anchor, or the Anchors classification is included in the initial classifications.

isOwnAnchor - boolean flag to day that the element should be classified as its own anchor once its element is created in the repository.

anchorScopeGUID - unique identifier of any anchor scope to use for searching

properties - properties for the new element.

parentGUID - unique identifier of optional parent entity

parentRelationshipTypeName - type of relationship to connect the new element to the parent

parentRelationshipProperties - properties to include in parent relationship

parentAtEnd1 - which end should the parent GUID go in the relationship

forLineage - the retrieved elements are for lineage processing so include archived elements

forDuplicateProcessing - the retrieved element is for duplicate processing so do not combine results from known duplicates.

effectiveTime - only return an element if it is effective at this time. Null means anytime. Use "new Date()" for now.

Returns:

unique identifier of the newly created element

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.

updateActorProfile

public void updateActorProfile(String actorProfileGUID,
 boolean replaceAllProperties,
 ActorProfileProperties properties,
 boolean forLineage,
 boolean forDuplicateProcessing,
 Date effectiveTime)
                        throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Update the properties of an actor profile.

Parameters:

actorProfileGUID - unique identifier of the actor profile (returned from create)

replaceAllProperties - flag to indicate whether to completely replace the existing properties with the new properties, or just update the individual properties specified on the request.

properties - properties for the element.

forLineage - the query is to support lineage retrieval

forDuplicateProcessing - the query is for duplicate processing and so must not deduplicate

effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)

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.

linkLocationToProfile

public void linkLocationToProfile(String actorProfileGUID,
 String locationGUID,
 ProfileLocationProperties relationshipProperties,
 boolean forLineage,
 boolean forDuplicateProcessing,
 Date effectiveTime)
                           throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Attach a profile to a location.

Parameters:

locationGUID - unique identifier of the location

actorProfileGUID - unique identifier of the actor profile

relationshipProperties - description of the relationship.

forLineage - the query is to support lineage retrieval

forDuplicateProcessing - the query is for duplicate processing and so must not deduplicate

effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)

Throws:

InvalidParameterException - one of the parameters is null or invalid.

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

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

detachLocationFromProfile

public void detachLocationFromProfile(String actorProfileGUID,
 String locationGUID,
 boolean forLineage,
 boolean forDuplicateProcessing,
 Date effectiveTime)
                               throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Detach an actor profile from a location.

Parameters:

locationGUID - unique identifier of the parent actor profile.

actorProfileGUID - unique identifier of the nested actor profile.

forLineage - the query is to support lineage retrieval

forDuplicateProcessing - the query is for duplicate processing and so must not deduplicate

effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)

Throws:

InvalidParameterException - one of the parameters is null or invalid.

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

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

linkAssetToProfile

public void linkAssetToProfile(String assetGUID,
 String itProfileGUID,
 ITInfrastructureProfileProperties relationshipProperties,
 boolean forLineage,
 boolean forDuplicateProcessing,
 Date effectiveTime)
                        throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Attach an asset to an IT profile.

Parameters:

assetGUID - unique identifier of the asset

itProfileGUID - unique identifier of the IT profile

relationshipProperties - description of the relationship.

forLineage - the query is to support lineage retrieval

forDuplicateProcessing - the query is for duplicate processing and so must not deduplicate

effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)

Throws:

InvalidParameterException - one of the parameters is null or invalid.

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

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

detachAssetFromProfile

public void detachAssetFromProfile(String assetGUID,
 String itProfileGUID,
 boolean forLineage,
 boolean forDuplicateProcessing,
 Date effectiveTime)
                            throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Detach an asset from an IT profile.

Parameters:

assetGUID - unique identifier of the asset

itProfileGUID - unique identifier of the IT profile

forLineage - the query is to support lineage retrieval

forDuplicateProcessing - the query is for duplicate processing and so must not deduplicate

effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)

Throws:

InvalidParameterException - one of the parameters is null or invalid.

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

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

deleteActorProfile

public void deleteActorProfile(String actorProfileGUID,
 boolean cascadedDelete,
 boolean forLineage,
 boolean forDuplicateProcessing,
 Date effectiveTime)
                        throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Delete a actor profile.

Parameters:

actorProfileGUID - unique identifier of the element

cascadedDelete - can the actor profile be deleted if it has nested components linked to it?

forLineage - the query is to support lineage retrieval

forDuplicateProcessing - the query is for duplicate processing and so must not deduplicate

effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)

Throws:

InvalidParameterException - one of the parameters is null or invalid.

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

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

createContactMethod

public String createContactMethod(String actorProfileGUID,
 ContactMethodProperties properties,
 boolean forLineage,
 boolean forDuplicateProcessing,
 Date effectiveTime)
                           throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Create a new contact method.

Parameters:

actorProfileGUID - unique identifier of the actor profile that should be the anchor for the new element.

properties - properties for the new element.

forLineage - the retrieved elements are for lineage processing so include archived elements

forDuplicateProcessing - the retrieved element is for duplicate processing so do not combine results from known duplicates.

effectiveTime - only return an element if it is effective at this time. Null means anytime. Use "new Date()" for now.

Returns:

unique identifier of the newly created element

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.

createContactMethodFromTemplate

public String createContactMethodFromTemplate(String actorProfileGUID,
 Date effectiveFrom,
 Date effectiveTo,
 String templateGUID,
 ElementProperties replacementProperties,
 Map<String,String> placeholderProperties,
 boolean forLineage,
 boolean forDuplicateProcessing,
 Date effectiveTime)
                                       throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create a new metadata element to represent a contact method using an existing element as a template. The template defines additional classifications and relationships that should be added to the new contact method.

Parameters:

actorProfileGUID - unique identifier of the actor profile that should be the anchor for the new element.

effectiveFrom - the date when this element is active - null for active on creation

effectiveTo - the date when this element becomes inactive - null for active until deleted

templateGUID - the unique identifier of the existing asset to copy (this will copy all the attachments such as nested content, schema connection etc)

replacementProperties - properties of the new metadata element. These override the template values

placeholderProperties - property name-to-property value map to replace any placeholder values in the template element - and their anchored elements, which are also copied as part of this operation.

forLineage - the retrieved elements are for lineage processing so include archived elements

forDuplicateProcessing - the retrieved element is for duplicate processing so do not combine results from known duplicates.

effectiveTime - only return an element if it is effective at this time. Null means anytime. Use "new Date()" for now.

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)

updateContactMethod

public void updateContactMethod(String contactMethodGUID,
 boolean replaceAllProperties,
 ContactMethodProperties properties,
 boolean forLineage,
 boolean forDuplicateProcessing,
 Date effectiveTime)
                         throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Update the properties of a contact method.

Parameters:

contactMethodGUID - unique identifier of the contact method (returned from create)

replaceAllProperties - flag to indicate whether to completely replace the existing properties with the new properties, or just update the individual properties specified on the request.

properties - properties for the element.

forLineage - the query is to support lineage retrieval

forDuplicateProcessing - the query is for duplicate processing and so must not deduplicate

effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)

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.

deleteContactMethod

public void deleteContactMethod(String contactMethodGUID,
 boolean forLineage,
 boolean forDuplicateProcessing,
 Date effectiveTime)
                         throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Delete a contact method.

Parameters:

contactMethodGUID - unique identifier of the element

forLineage - the query is to support lineage retrieval

forDuplicateProcessing - the query is for duplicate processing and so must not deduplicate

effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)

Throws:

InvalidParameterException - one of the parameters is null or invalid.

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

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

getActorProfilesByName

public List<ActorProfileElement> getActorProfilesByName(String name,
 TemplateFilter templateFilter,
 List<ElementStatus> limitResultsByStatus,
 Date asOfTime,
 SequencingOrder sequencingOrder,
 String sequencingProperty,
 int startFrom,
 int pageSize,
 boolean forLineage,
 boolean forDuplicateProcessing,
 Date effectiveTime)
                                                 throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Returns the list of actor profiles with a particular name.

Parameters:

name - name of the element to return - match is full text match in qualifiedName or name

templateFilter - should templates be returned?

limitResultsByStatus - control the status of the elements to retrieve - default is everything but Deleted

asOfTime - repository time to use

sequencingOrder - order to retrieve results

sequencingProperty - property to use for sequencing order

startFrom - paging start point

pageSize - maximum results that can be returned

forLineage - the query is to support lineage retrieval

forDuplicateProcessing - the query is for duplicate processing and so must not deduplicate

effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)

Returns:

a list of elements

Throws:

InvalidParameterException - one of the parameters is null or invalid.

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

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

getActorProfileByGUID

public ActorProfileElement getActorProfileByGUID(String actorProfileGUID,
 Date asOfTime,
 boolean forLineage,
 boolean forDuplicateProcessing,
 Date effectiveTime)
                                          throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Return the properties of a specific actor profile.

Parameters:

actorProfileGUID - unique identifier of the required element

asOfTime - repository time to use

forLineage - the query is to support lineage retrieval

forDuplicateProcessing - the query is for duplicate processing and so must not deduplicate

effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)

Returns:

retrieved properties

Throws:

InvalidParameterException - one of the parameters is null or invalid.

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

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

getActorProfileByUserId

public ActorProfileElement getActorProfileByUserId(String requiredUserId,
 Date asOfTime,
 boolean forLineage,
 boolean forDuplicateProcessing,
 Date effectiveTime)
                                            throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Return the properties of a specific actor profile retrieved using an associated userId.

Parameters:

requiredUserId - identifier of user

asOfTime - repository time to use

forLineage - the query is to support lineage retrieval

forDuplicateProcessing - the query is for duplicate processing and so must not deduplicate

effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)

Returns:

retrieved properties

Throws:

InvalidParameterException - one of the parameters is null or invalid.

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

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

findActorProfiles

public List<ActorProfileElement> findActorProfiles(String searchString,
 TemplateFilter templateFilter,
 List<ElementStatus> limitResultsByStatus,
 Date asOfTime,
 SequencingOrder sequencingOrder,
 String sequencingProperty,
 int startFrom,
 int pageSize,
 boolean forLineage,
 boolean forDuplicateProcessing,
 Date effectiveTime)
                                            throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the list of actor profiles metadata elements that contain the search string and show which solution components (if any) are attached to it. The returned actor profiles include a list of the components that are associated with it. The search string is treated as a regular expression.

Parameters:

searchString - string to find in the properties

templateFilter - should templates be returned?

limitResultsByStatus - control the status of the elements to retrieve - default is everything but Deleted

asOfTime - repository time to use

sequencingOrder - order to retrieve results

sequencingProperty - property to use for sequencing order

startFrom - paging start point

pageSize - maximum results that can be returned

forLineage - the retrieved elements are for lineage processing so include archived elements

forDuplicateProcessing - the retrieved element is for duplicate processing so do not combine results from known duplicates.

effectiveTime - only return an element if it is effective at this time. Null means anytime. Use "new Date()" for now.

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)

createUserIdentity

public String createUserIdentity(String anchorGUID,
 boolean isOwnAnchor,
 String anchorScopeGUID,
 UserIdentityProperties properties,
 String parentGUID,
 String parentRelationshipTypeName,
 ElementProperties parentRelationshipProperties,
 boolean parentAtEnd1,
 boolean forLineage,
 boolean forDuplicateProcessing,
 Date effectiveTime)
                          throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Create a new user identity.

Parameters:

anchorGUID - unique identifier of the element that should be the anchor for the new element. Set to null if no anchor, or the Anchors classification is included in the initial classifications.

isOwnAnchor - boolean flag to day that the element should be classified as its own anchor once its element is created in the repository.

anchorScopeGUID - unique identifier of any anchor scope to use for searching

properties - properties for the new element.

parentGUID - unique identifier of optional parent entity

parentRelationshipTypeName - type of relationship to connect the new element to the parent

parentRelationshipProperties - properties to include in parent relationship

parentAtEnd1 - which end should the parent GUID go in the relationship

forLineage - the retrieved elements are for lineage processing so include archived elements

forDuplicateProcessing - the retrieved element is for duplicate processing so do not combine results from known duplicates.

effectiveTime - only return an element if it is effective at this time. Null means anytime. Use "new Date()" for now.

Returns:

unique identifier of the newly created element

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.

createUserIdentityFromTemplate

public String createUserIdentityFromTemplate(String anchorGUID,
 boolean isOwnAnchor,
 String anchorScopeGUID,
 Date effectiveFrom,
 Date effectiveTo,
 String templateGUID,
 ElementProperties replacementProperties,
 Map<String,String> placeholderProperties,
 String parentGUID,
 String parentRelationshipTypeName,
 ElementProperties parentRelationshipProperties,
 boolean parentAtEnd1,
 boolean forLineage,
 boolean forDuplicateProcessing,
 Date effectiveTime)
                                      throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create a new metadata element to represent a user identity using an existing element as a template. The template defines additional classifications and relationships that should be added to the new user identity.

Parameters:

anchorGUID - unique identifier of the element that should be the anchor for the new element. Set to null if no anchor, or the Anchors classification is included in the initial classifications.

isOwnAnchor - boolean flag to day that the element should be classified as its own anchor once its element is created in the repository.

anchorScopeGUID - unique identifier of any anchor scope to use for searching

effectiveFrom - the date when this element is active - null for active on creation

effectiveTo - the date when this element becomes inactive - null for active until deleted

templateGUID - the unique identifier of the existing asset to copy (this will copy all the attachments such as nested content, schema connection etc)

replacementProperties - properties of the new metadata element. These override the template values

placeholderProperties - property name-to-property value map to replace any placeholder values in the template element - and their anchored elements, which are also copied as part of this operation.

parentGUID - unique identifier of optional parent entity

parentRelationshipTypeName - type of relationship to connect the new element to the parent

parentRelationshipProperties - properties to include in parent relationship

parentAtEnd1 - which end should the parent GUID go in the relationship

forLineage - the retrieved elements are for lineage processing so include archived elements

forDuplicateProcessing - the retrieved element is for duplicate processing so do not combine results from known duplicates.

effectiveTime - only return an element if it is effective at this time. Null means anytime. Use "new Date()" for now.

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)

updateUserIdentity

public void updateUserIdentity(String userIdentityGUID,
 boolean replaceAllProperties,
 UserIdentityProperties properties,
 boolean forLineage,
 boolean forDuplicateProcessing,
 Date effectiveTime)
                        throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Update the properties of a user identity.

Parameters:

userIdentityGUID - unique identifier of the user identity (returned from create)

replaceAllProperties - flag to indicate whether to completely replace the existing properties with the new properties, or just update the individual properties specified on the request.

properties - properties for the element.

forLineage - the query is to support lineage retrieval

forDuplicateProcessing - the query is for duplicate processing and so must not deduplicate

effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)

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.

linkIdentityToProfile

public void linkIdentityToProfile(String userIdentityGUID,
 String profileGUID,
 ProfileIdentityProperties relationshipProperties,
 boolean forLineage,
 boolean forDuplicateProcessing,
 Date effectiveTime)
                           throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Attach a profile to a user identity.

Parameters:

userIdentityGUID - unique identifier of the parent

profileGUID - unique identifier of the actor profile

relationshipProperties - description of the relationship.

forLineage - the query is to support lineage retrieval

forDuplicateProcessing - the query is for duplicate processing and so must not deduplicate

effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)

Throws:

InvalidParameterException - one of the parameters is null or invalid.

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

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

detachProfileIdentity

public void detachProfileIdentity(String userIdentityGUID,
 String profileGUID,
 boolean forLineage,
 boolean forDuplicateProcessing,
 Date effectiveTime)
                           throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Detach an actor profile from a user identity.

Parameters:

userIdentityGUID - unique identifier of the parent actor profile.

profileGUID - unique identifier of the nested actor profile.

forLineage - the query is to support lineage retrieval

forDuplicateProcessing - the query is for duplicate processing and so must not deduplicate

effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)

Throws:

InvalidParameterException - one of the parameters is null or invalid.

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

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

addSecurityGroupMembership

public void addSecurityGroupMembership(String userIdentityGUID,
 SecurityGroupMembershipProperties properties,
 boolean forLineage,
 boolean forDuplicateProcessing,
 Date effectiveTime)
                                throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Add the SecurityGroupMembership classification to the user identity.

Parameters:

userIdentityGUID - unique identifier of the user identity.

properties - properties for the classification

forLineage - the query is to support lineage retrieval

forDuplicateProcessing - the query is for duplicate processing and so must not deduplicate

effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)

Throws:

InvalidParameterException - one of the parameters is null or invalid.

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

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

updateSecurityGroupMembership

public void updateSecurityGroupMembership(String userIdentityGUID,
 SecurityGroupMembershipProperties properties,
 boolean forLineage,
 boolean forDuplicateProcessing,
 Date effectiveTime)
                                   throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Update the SecurityGroupMembership classification for the user identity.

Parameters:

userIdentityGUID - unique identifier of the user identity.

properties - properties for the classification

forLineage - the query is to support lineage retrieval

forDuplicateProcessing - the query is for duplicate processing and so must not deduplicate

effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)

Throws:

InvalidParameterException - one of the parameters is null or invalid.

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

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

removeAllSecurityGroupMembership

public void removeAllSecurityGroupMembership(String userIdentityGUID,
 boolean forLineage,
 boolean forDuplicateProcessing,
 Date effectiveTime)
                                      throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Remove the SecurityGroupMembership classification from the user identity.

Parameters:

userIdentityGUID - unique identifier of the user identity.

forLineage - the query is to support lineage retrieval

forDuplicateProcessing - the query is for duplicate processing and so must not deduplicate

effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)

Throws:

InvalidParameterException - one of the parameters is null or invalid.

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

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

deleteUserIdentity

public void deleteUserIdentity(String userIdentityGUID,
 boolean cascadedDelete,
 boolean forLineage,
 boolean forDuplicateProcessing,
 Date effectiveTime)
                        throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Delete a user identity.

Parameters:

userIdentityGUID - unique identifier of the element

cascadedDelete - can the user identity be deleted if it has actor profiles linked to it?

forLineage - the query is to support lineage retrieval

forDuplicateProcessing - the query is for duplicate processing and so must not deduplicate

effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)

Throws:

InvalidParameterException - one of the parameters is null or invalid.

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

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

getUserIdentitiesByName

public List<UserIdentityElement> getUserIdentitiesByName(String name,
 TemplateFilter templateFilter,
 List<ElementStatus> limitResultsByStatus,
 Date asOfTime,
 SequencingOrder sequencingOrder,
 String sequencingProperty,
 int startFrom,
 int pageSize,
 boolean forLineage,
 boolean forDuplicateProcessing,
 Date effectiveTime)
                                                  throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Returns the list of user identities with a particular name.

Parameters:

name - name of the element to return - match is full text match in qualifiedName or name

templateFilter - should templates be returned?

limitResultsByStatus - control the status of the elements to retrieve - default is everything but Deleted

asOfTime - repository time to use

sequencingOrder - order to retrieve results

sequencingProperty - property to use for sequencing order

startFrom - paging start point

pageSize - maximum results that can be returned

forLineage - the query is to support lineage retrieval

forDuplicateProcessing - the query is for duplicate processing and so must not deduplicate

effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)

Returns:

a list of elements

Throws:

InvalidParameterException - one of the parameters is null or invalid.

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

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

getUserIdentityByGUID

public UserIdentityElement getUserIdentityByGUID(String userIdentityGUID,
 Date asOfTime,
 boolean forLineage,
 boolean forDuplicateProcessing,
 Date effectiveTime)
                                          throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Return the properties of a specific user identity.

Parameters:

userIdentityGUID - unique identifier of the required element

asOfTime - repository time to use

forLineage - the query is to support lineage retrieval

forDuplicateProcessing - the query is for duplicate processing and so must not deduplicate

effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)

Returns:

retrieved properties

Throws:

InvalidParameterException - one of the parameters is null or invalid.

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

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

findUserIdentities

public List<UserIdentityElement> findUserIdentities(String searchString,
 TemplateFilter templateFilter,
 List<ElementStatus> limitResultsByStatus,
 Date asOfTime,
 SequencingOrder sequencingOrder,
 String sequencingProperty,
 int startFrom,
 int pageSize,
 boolean forLineage,
 boolean forDuplicateProcessing,
 Date effectiveTime)
                                             throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the list of user identities metadata elements that contain the search string. The search string is treated as a regular expression.

Parameters:

searchString - string to find in the properties

templateFilter - should templates be returned?

limitResultsByStatus - control the status of the elements to retrieve - default is everything but Deleted

asOfTime - repository time to use

sequencingOrder - order to retrieve results

sequencingProperty - property to use for sequencing order

startFrom - paging start point

pageSize - maximum results that can be returned

forLineage - the query is to support lineage retrieval

forDuplicateProcessing - the query is for duplicate processing and so must not deduplicate

effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)

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)