Class CollaborationExchangeClient

    • Constructor Detail

      • CollaborationExchangeClient

        public CollaborationExchangeClient​(String serverName,
                                           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.
      • CollaborationExchangeClient

        public CollaborationExchangeClient​(String serverName,
                                           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.
      • CollaborationExchangeClient

        public CollaborationExchangeClient​(String serverName,
                                           String serverPlatformURLRoot,
                                           String userId,
                                           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.
      • CollaborationExchangeClient

        public CollaborationExchangeClient​(String serverName,
                                           String serverPlatformURLRoot,
                                           AssetManagerRESTClient 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.
      • CollaborationExchangeClient

        public CollaborationExchangeClient​(String serverName,
                                           String serverPlatformURLRoot,
                                           String userId,
                                           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.