Class GovernanceExchangeClient

    • Constructor Summary

      Constructors 
      Constructor Description
      GovernanceExchangeClient​(java.lang.String serverName, java.lang.String serverPlatformURLRoot)
      Create a new client with no authentication embedded in the HTTP request.
      GovernanceExchangeClient​(java.lang.String serverName, java.lang.String serverPlatformURLRoot, java.lang.String userId, java.lang.String password)
      Create a new client that passes userId and password in each HTTP request.
      GovernanceExchangeClient​(java.lang.String serverName, java.lang.String serverPlatformURLRoot, java.lang.String userId, java.lang.String password, AuditLog auditLog)
      Create a new client that passes userId and password in each HTTP request.
      GovernanceExchangeClient​(java.lang.String serverName, java.lang.String serverPlatformURLRoot, AssetManagerRESTClient restClient, int maxPageSize, AuditLog auditLog)
      Create a new client that is going to be used in an OMAG Server.
      GovernanceExchangeClient​(java.lang.String serverName, java.lang.String serverPlatformURLRoot, AuditLog auditLog)
      Create a new client with no authentication embedded in the HTTP request.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addElementToSubjectArea​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String elementGUID, java.lang.String elementExternalIdentifier, java.lang.String subjectAreaName, java.lang.String methodName)
      Classify the element to asset that the definitions it represents are part of a subject area definition.
      void addGovernanceDefinitionToElement​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String definitionGUID, java.lang.String elementGUID, java.lang.String methodName)
      Link a governance definition to an element using the GovernedBy relationship.
      void clearGovernanceDelegation​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String definitionGUID, java.lang.String delegatedToDefinitionGUID)
      Remove the link between a governance definition and a governance definition that is delegated to (ie provides an implementation of).
      java.lang.String createGovernanceDefinition​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String typeName, ExternalIdentifierProperties externalIdentifierProperties, GovernanceDefinitionProperties definitionProperties)
      Create a new definition.
      void deleteGovernanceDefinition​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String definitionGUID)
      Delete a specific governance definition.
      java.util.List<GovernanceActionProcessElement> findGovernanceActionProcesses​(java.lang.String userId, java.lang.String searchString, int startFrom, int pageSize)
      Retrieve the list of governance action process metadata elements that contain the search string.
      java.util.List<GovernanceActionTypeElement> findGovernanceActionTypes​(java.lang.String userId, java.lang.String searchString, int startFrom, int pageSize)
      Retrieve the list of governance action type metadata elements that contain the search string.
      java.util.List<GovernanceActionElement> getActiveGovernanceActions​(java.lang.String userId, int startFrom, int pageSize)
      Retrieve the governance actions that are still in process.
      GovernanceActionTypeElement getFirstActionType​(java.lang.String userId, java.lang.String processGUID)
      Return the governance action type that is the first step in a governance action process.
      GovernanceActionElement getGovernanceAction​(java.lang.String userId, java.lang.String governanceActionGUID)
      Request the status of an executing governance action request.
      GovernanceActionProcessElement getGovernanceActionProcessByGUID​(java.lang.String userId, java.lang.String processGUID)
      Retrieve the governance action process metadata element with the supplied unique identifier.
      java.util.List<GovernanceActionProcessElement> getGovernanceActionProcessesByName​(java.lang.String userId, java.lang.String name, int startFrom, int pageSize)
      Retrieve the list of governance action process metadata elements with a matching qualified or display name.
      java.util.List<GovernanceActionElement> getGovernanceActions​(java.lang.String userId, int startFrom, int pageSize)
      Retrieve the governance actions known to the server.
      GovernanceActionTypeElement getGovernanceActionTypeByGUID​(java.lang.String userId, java.lang.String actionTypeGUID)
      Retrieve the governance action type metadata element with the supplied unique identifier.
      java.util.List<GovernanceActionTypeElement> getGovernanceActionTypesByName​(java.lang.String userId, java.lang.String name, int startFrom, int pageSize)
      Retrieve the list of governance action type metadata elements with a matching qualified or display name.
      GovernanceDefinitionElement getGovernanceDefinitionByDocId​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String documentIdentifier)
      Retrieve the governance definition by its assigned unique document identifier.
      GovernanceDefinitionElement getGovernanceDefinitionByGUID​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String definitionGUID)
      Retrieve the governance definition by the unique identifier assigned by this service when it was created.
      java.util.List<NextGovernanceActionTypeElement> getNextGovernanceActionTypes​(java.lang.String userId, java.lang.String actionTypeGUID, int startFrom, int pageSize)
      Return the lust of next action type defined for the governance action process.
      void linkDefinitions​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String definitionOneGUID, java.lang.String definitionTwoGUID, java.lang.String description)
      Link two related definitions together.
      void removeElementFromSubjectArea​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String elementGUID, java.lang.String externalElementIdentifier, java.lang.String methodName)
      Remove the subject area designation from the identified element.
      void removeGovernanceDefinitionFromElement​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String definitionGUID, java.lang.String elementGUID, java.lang.String methodName)
      Remove the GovernedBy relationship between a governance definition and an element.
      void setupGovernanceDelegation​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String definitionGUID, java.lang.String delegatedToDefinitionGUID, java.lang.String rationale)
      Create a link to show that a governance definition supports the requirements of one of the governance drivers.
      void unlinkDefinitions​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String definitionOneGUID, java.lang.String definitionTwoGUID)
      Remove the link between two definitions.
      void updateGovernanceDefinition​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String definitionGUID, boolean isMergeUpdate, GovernanceDefinitionProperties definitionProperties)
      Update an existing definition.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait