Class ExternalReferenceManagerClient

    • Constructor Summary

      Constructors 
      Constructor Description
      ExternalReferenceManagerClient​(java.lang.String serverName, java.lang.String serverPlatformURLRoot)
      Create a new client with no authentication embedded in the HTTP request.
      ExternalReferenceManagerClient​(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.
      ExternalReferenceManagerClient​(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.
      ExternalReferenceManagerClient​(java.lang.String serverName, java.lang.String serverPlatformURLRoot, DataManagerRESTClient restClient, int maxPageSize, AuditLog auditLog)
      Create a new client that is going to be used in an OMAG Server.
      ExternalReferenceManagerClient​(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
      java.lang.String createExternalReference​(java.lang.String userId, java.lang.String anchorGUID, java.lang.String linkId, java.lang.String linkDescription, ExternalReferenceProperties properties)
      Create a definition of a external reference.
      void deleteExternalReference​(java.lang.String userId, java.lang.String externalReferenceGUID)
      Remove the definition of a external reference.
      java.util.List<ExternalReferenceElement> findExternalReferencesById​(java.lang.String userId, java.lang.String resourceId, int startFrom, int pageSize)
      Retrieve the list of external references for this resourceId (qualified name).
      java.util.List<ExternalReferenceElement> findExternalReferencesByURL​(java.lang.String userId, java.lang.String url, int startFrom, int pageSize)
      Retrieve the list of external references for this URL.
      ExternalReferenceElement getExternalReferenceByGUID​(java.lang.String userId, java.lang.String externalReferenceGUID)
      Return information about a specific external reference.
      void linkExternalReferenceToElement​(java.lang.String userId, java.lang.String attachedToGUID, java.lang.String linkId, java.lang.String linkDescription, java.lang.String externalReferenceGUID)
      Link an external reference to an object.
      java.util.List<ExternalReferenceElement> retrieveAttachedExternalReferences​(java.lang.String userId, java.lang.String attachedToGUID, int startFrom, int pageSize)
      Retrieve the list of external references attached to the supplied object.
      void unlinkExternalReferenceFromElement​(java.lang.String userId, java.lang.String attachedToGUID, java.lang.String externalReferenceGUID)
      Remove the link between a external reference and an element.
      void updateExternalReference​(java.lang.String userId, java.lang.String externalReferenceGUID, boolean isMergeUpdate, ExternalReferenceProperties properties)
      Update the definition of a external reference.
      • Methods inherited from class java.lang.Object

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

      • ExternalReferenceManagerClient

        public ExternalReferenceManagerClient​(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.
      • ExternalReferenceManagerClient

        public ExternalReferenceManagerClient​(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.
      • ExternalReferenceManagerClient

        public ExternalReferenceManagerClient​(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.
      • ExternalReferenceManagerClient

        public ExternalReferenceManagerClient​(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.
      • ExternalReferenceManagerClient

        public ExternalReferenceManagerClient​(java.lang.String serverName,
                                              java.lang.String serverPlatformURLRoot,
                                              DataManagerRESTClient restClient,
                                              int maxPageSize,
                                              AuditLog auditLog)
                                       throws InvalidParameterException
        Create a new client that is going to be used in an OMAG Server.
        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.