Class OpenGovernanceClient
java.lang.Object
org.odpi.openmetadata.frameworks.openmetadata.client.OpenMetadataClient
org.odpi.openmetadata.frameworks.governanceaction.client.OpenGovernanceClient
- All Implemented Interfaces:
ExternalIdentifiersInterface
,MetadataElementInterface
,MultiLanguageInterface
,OpenMetadataTypesInterface
,StewardshipRequestInterface
,ValidMetadataValuesInterface
OpenMetadataClient provides access to metadata elements stored in the metadata repositories. It is implemented by a
metadata repository provider. In Egeria, this class is implemented in the GAF Metadata Management running in the
Metadata Access Server OMAG Server.
-
Field Summary
Fields inherited from class org.odpi.openmetadata.frameworks.openmetadata.client.OpenMetadataClient
serverName, serverPlatformURLRoot, serviceURLMarker
-
Constructor Summary
ConstructorsConstructorDescriptionOpenGovernanceClient
(String serviceURLMarker, String serverName, String serverPlatformURLRoot) Create a new client with no authentication embedded in the HTTP request. -
Method Summary
Modifier and TypeMethodDescriptionabstract String
createIncidentReport
(String userId, String qualifiedName, int domainIdentifier, String background, List<IncidentImpactedElement> impactedResources, List<IncidentDependency> previousIncidents, Map<String, Integer> incidentClassifiers, Map<String, String> additionalProperties, String originatorGUID) Create an incident report to capture the situation detected by this governance service.abstract String
initiateGovernanceActionProcess
(String userId, String processQualifiedName, List<String> requestSourceGUIDs, List<NewActionTarget> actionTargets, Date startTime, Map<String, String> requestParameters, String originatorServiceName, String originatorEngineName) Using the named governance action process as a template, initiate a chain of engine actions.toString()
Standard toString method.Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.client.OpenMetadataClient
addExternalIdentifier, classifyMetadataElementInStore, confirmSynchronization, createMetadataElementFromTemplate, createMetadataElementInStore, createMetadataElementInStore, createRelatedElementsInStore, declassifyMetadataElementInStore, deleteMetadataElementInStore, deleteRelationshipInStore, detachRelatedElementsInStore, findAttributeTypeDefsByCategory, findElementsForAnchor, findElementsInAnchorDomain, findElementsInAnchorScope, findMetadataElements, findMetadataElementsWithString, findMetadataElementsWithString, findRelationshipsBetweenMetadataElements, findTypeDefsByCategory, findTypesByExternalId, getAllTypes, getAnchoredElementsGraph, getAttributeTypeDefByGUID, getAttributeTypeDefByName, getDeletedElementByUniqueName, getElementsForExternalIdentifier, getExternalIdentifiers, getMaxPagingSize, getMetadataElementByGUID, getMetadataElementByUniqueName, getMetadataElementGUIDByUniqueName, getMetadataElementHistory, getMetadataElementRelationships, getRelatedMetadataElement, getRelatedMetadataElements, getRelationshipByGUID, getRelationshipHistory, getServerName, getSubTypes, getTypeDefByGUID, getTypeDefByName, getVendorProperties, reclassifyMetadataElementInStore, removeExternalIdentifier, updateClassificationEffectivityInStore, updateExternalIdentifier, updateMetadataElementEffectivityInStore, updateMetadataElementInStore, updateMetadataElementStatusInStore, updateRelatedElementsInStore, updateRelationshipEffectivityInStore, updateRelationshipInStore, validateExternalIdentifier
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.odpi.openmetadata.frameworks.openmetadata.client.ExternalIdentifiersInterface
removeExternalScope
Methods inherited from interface org.odpi.openmetadata.frameworks.openmetadata.client.MetadataElementInterface
archiveMetadataElementInStore, archiveMetadataElementInStore, classifyMetadataElementInStore, createMetadataElementFromTemplate, createMetadataElementInStore, createMetadataElementInStore, createRelatedElementsInStore, declassifyMetadataElementInStore, deleteMetadataElementInStore, deleteRelationshipInStore, detachRelatedElementsInStore, getMetadataElementFromTemplate, reclassifyMetadataElementInStore, updateClassificationEffectivityInStore, updateMetadataElementEffectivityInStore, updateMetadataElementInStore, updateMetadataElementStatusInStore, updateRelatedElementsInStore, updateRelationshipEffectivityInStore, updateRelationshipInStore
Methods inherited from interface org.odpi.openmetadata.frameworks.openmetadata.client.MultiLanguageInterface
clearTranslation, getTranslation, getTranslations, setTranslation
Methods inherited from interface org.odpi.openmetadata.frameworks.openmetadata.client.StewardshipRequestInterface
openToDo, registerContextEvent
Methods inherited from interface org.odpi.openmetadata.frameworks.openmetadata.client.ValidMetadataValuesInterface
clearValidMetadataMapName, clearValidMetadataMapValue, clearValidMetadataValue, getConsistentMetadataValues, getSpecification, getValidMetadataMapName, getValidMetadataMapValue, getValidMetadataValue, getValidMetadataValues, setConsistentMetadataValues, setUpValidMetadataMapName, setUpValidMetadataMapValue, setUpValidMetadataValue, validateMetadataMapName, validateMetadataMapValue, validateMetadataValue
-
Constructor Details
-
OpenGovernanceClient
public OpenGovernanceClient(String serviceURLMarker, String serverName, String serverPlatformURLRoot) Create a new client with no authentication embedded in the HTTP request.- Parameters:
serviceURLMarker
- the identifier of the access service (for example asset-owner for the Asset Owner OMAS)serverName
- name of the server to connect toserverPlatformURLRoot
- the network address of the server running the OMAS REST services
-
-
Method Details
-
initiateGovernanceActionProcess
public abstract String initiateGovernanceActionProcess(String userId, String processQualifiedName, List<String> requestSourceGUIDs, List<NewActionTarget> actionTargets, Date startTime, Map<String, String> requestParameters, String originatorServiceName, String originatorEngineName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerExceptionUsing the named governance action process as a template, initiate a chain of engine actions.- Parameters:
userId
- caller's userIdprocessQualifiedName
- unique name of the governance action process to userequestSourceGUIDs
- request source elements for the resulting governance serviceactionTargets
- map of action target names to GUIDs for the resulting governance servicestartTime
- future start time or null for "as soon as possible"requestParameters
- request properties to be passed to the first engine actionoriginatorServiceName
- unique name of the requesting governance service (if initiated by a governance engine).originatorEngineName
- optional unique name of the governance engine (if initiated by a governance engine).- Returns:
- unique identifier of the first governance action of the process
- Throws:
InvalidParameterException
- null or unrecognized qualified name of the processUserNotAuthorizedException
- the userId is not permitted to perform this operationPropertyServerException
- there is a problem with the metadata store
-
createIncidentReport
public abstract String createIncidentReport(String userId, String qualifiedName, int domainIdentifier, String background, List<IncidentImpactedElement> impactedResources, List<IncidentDependency> previousIncidents, Map<String, Integer> incidentClassifiers, Map<String, throws InvalidParameterException, UserNotAuthorizedException, PropertyServerExceptionString> additionalProperties, String originatorGUID) Create an incident report to capture the situation detected by this governance service. This incident report will be processed by other governance activities.- Parameters:
userId
- caller's userIdqualifiedName
- unique identifier to give this new incident reportdomainIdentifier
- governance domain associated with this action (0=ALL)background
- description of the situationimpactedResources
- details of the resources impacted by this situationpreviousIncidents
- links to previous incident reports covering this situationincidentClassifiers
- initial classifiers for the incident reportadditionalProperties
- additional arbitrary properties for the incident reportsoriginatorGUID
- the unique identifier of the person or process that created the incident- Returns:
- unique identifier of the resulting incident report
- Throws:
InvalidParameterException
- null or non-unique qualified name for the incident reportUserNotAuthorizedException
- the userId is not permitted to perform this operationPropertyServerException
- there is a problem with the metadata store
-
toString
Standard toString method.- Overrides:
toString
in classOpenMetadataClient
- Returns:
- print out of variables in a JSON-style
-