Class StewardshipAction

  • All Implemented Interfaces:
    DuplicateManagementInterface

    public class StewardshipAction
    extends java.lang.Object
    implements DuplicateManagementInterface
    StewardshipAction provides the generic client-side interface for the Stewardship Action Open Metadata Access Service (OMAS). There are other clients that provide specialized methods for specific types of Asset. This client is initialized with the URL and name of the server that is running the Asset Owner OMAS. This server is responsible for locating and managing the asset owner's definitions exchanged with this client.
    • Constructor Summary

      Constructors 
      Constructor Description
      StewardshipAction​(java.lang.String serverName, java.lang.String serverPlatformURLRoot)
      Create a new client with no authentication embedded in the HTTP request.
      StewardshipAction​(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.
      StewardshipAction​(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.
      StewardshipAction​(java.lang.String serverName, java.lang.String serverPlatformURLRoot, StewardshipActionRESTClient restClient, int maxPageSize, AuditLog auditLog)
      Create a new client that is going to be used in an OMAG Server (view service or integration service typically).
      StewardshipAction​(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
      ElementStub getConsolidatedDuplicate​(java.lang.String userId, java.lang.String elementGUID)
      Return details of the consolidated duplicate for a requested element.
      java.util.List<ElementStub> getContributingDuplicates​(java.lang.String userId, java.lang.String consolidatedDuplicateGUID, int startFrom, int pageSize)
      List the elements that are contributing to a consolidating duplicate element.
      java.util.List<DuplicateElement> getPeerDuplicates​(java.lang.String userId, java.lang.String elementGUID, int startFrom, int pageSize)
      List the elements that are linked as peer duplicates to the requested element.
      void linkElementsAsDuplicates​(java.lang.String userId, java.lang.String element1GUID, java.lang.String element2GUID, int statusIdentifier, java.lang.String steward, java.lang.String stewardTypeName, java.lang.String stewardPropertyName, java.lang.String source, java.lang.String notes)
      Create a simple relationship between two elements.
      void linkElementToConsolidatedDuplicate​(java.lang.String userId, java.lang.String consolidatedDuplicateGUID, java.lang.String contributingElementGUID)
      Create a ConsolidatedDuplicateLink relationship between the consolidated duplicate element and one of its contributing element.
      void markAsConsolidatedDuplicate​(java.lang.String userId, java.lang.String consolidatedDuplicateGUID, int statusIdentifier, java.lang.String steward, java.lang.String stewardTypeName, java.lang.String stewardPropertyName, java.lang.String source, java.lang.String notes)
      Mark an element as a consolidated duplicate (or update the properties if it is already marked as such).
      void markElementAsKnownDuplicate​(java.lang.String userId, java.lang.String elementGUID)
      Classify an element as a known duplicate.
      void removeConsolidatedDuplicate​(java.lang.String userId, java.lang.String consolidatedDuplicateGUID)
      Remove the consolidated duplicate element and the links to the elements that contributed to its values.
      void unlinkElementFromConsolidatedDuplicate​(java.lang.String userId, java.lang.String consolidatedDuplicateGUID, java.lang.String contributingElementGUID)
      Remove the relationship between two elements that marks them as duplicates.
      void unlinkElementsAsDuplicates​(java.lang.String userId, java.lang.String element1GUID, java.lang.String element2GUID)
      Remove the relationship between two elements that marks them as duplicates.
      void unmarkElementAsKnownDuplicate​(java.lang.String userId, java.lang.String elementGUID)
      Remove the classification that identifies this element as a known duplicate.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • StewardshipAction

        public StewardshipAction​(java.lang.String serverName,
                                 java.lang.String serverPlatformURLRoot,
                                 AuditLog auditLog)
                          throws InvalidParameterException
        Create a new client with no authentication embedded in the HTTP request.
        Parameters:
        serverName - name of the server to connect to
        serverPlatformURLRoot - the network address of the server running the OMAS REST servers
        auditLog - logging destination
        Throws:
        InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
      • StewardshipAction

        public StewardshipAction​(java.lang.String serverName,
                                 java.lang.String serverPlatformURLRoot)
                          throws InvalidParameterException
        Create a new client with no authentication embedded in the HTTP request.
        Parameters:
        serverName - name of the server to connect to
        serverPlatformURLRoot - the network address of the server running the OMAS REST servers
        Throws:
        InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
      • StewardshipAction

        public StewardshipAction​(java.lang.String serverName,
                                 java.lang.String serverPlatformURLRoot,
                                 java.lang.String userId,
                                 java.lang.String password,
                                 AuditLog auditLog)
                          throws InvalidParameterException
        Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.
        Parameters:
        serverName - name of the server to connect to
        serverPlatformURLRoot - the network address of the server running the OMAS REST servers
        userId - caller's userId embedded in all HTTP requests
        password - caller's userId embedded in all HTTP requests
        auditLog - logging destination
        Throws:
        InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
      • StewardshipAction

        public StewardshipAction​(java.lang.String serverName,
                                 java.lang.String serverPlatformURLRoot,
                                 java.lang.String userId,
                                 java.lang.String password)
                          throws InvalidParameterException
        Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.
        Parameters:
        serverName - name of the server to connect to
        serverPlatformURLRoot - the network address of the server running the OMAS REST servers
        userId - caller's userId embedded in all HTTP requests
        password - caller's userId embedded in all HTTP requests
        Throws:
        InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
      • StewardshipAction

        public StewardshipAction​(java.lang.String serverName,
                                 java.lang.String serverPlatformURLRoot,
                                 StewardshipActionRESTClient restClient,
                                 int maxPageSize,
                                 AuditLog auditLog)
                          throws InvalidParameterException
        Create a new client that is going to be used in an OMAG Server (view service or integration service typically).
        Parameters:
        serverName - name of the server to connect to
        serverPlatformURLRoot - the network address of the server running the OMAS REST servers
        restClient - client that issues the REST API calls
        maxPageSize - maximum number of results supported by this server
        auditLog - logging destination
        Throws:
        InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.