Class CSVFileAssetOwner

    • Constructor Detail

      • CSVFileAssetOwner

        public CSVFileAssetOwner​(java.lang.String serverName,
                                 java.lang.String serverPlatformURLRoot,
                                 AuditLog auditLog)
                          throws InvalidParameterException
        Create a new client with no authentication embedded in the HTTP request and an audit log.
        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.
      • CSVFileAssetOwner

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

        public CSVFileAssetOwner​(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. There is also an audit log destination.
        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.
      • CSVFileAssetOwner

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

        public CSVFileAssetOwner​(java.lang.String serverName,
                                 java.lang.String serverPlatformURLRoot,
                                 AssetOwnerRESTClient 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.
    • Method Detail

      • addCSVFileToCatalog

        public java.util.List<java.lang.String> addCSVFileToCatalog​(java.lang.String userId,
                                                                    java.lang.String displayName,
                                                                    java.lang.String description,
                                                                    java.lang.String fullPath,
                                                                    java.util.List<java.lang.String> columnHeaders,
                                                                    java.lang.Character delimiterCharacter,
                                                                    java.lang.Character quoteCharacter)
                                                             throws InvalidParameterException,
                                                                    UserNotAuthorizedException,
                                                                    PropertyServerException
        Add a simple asset description linked to a connection object for a CSV file.
        Specified by:
        addCSVFileToCatalog in interface AssetOnboardingCSVFileInterface
        Parameters:
        userId - calling user (assumed to be the owner)
        displayName - display name for the file in the catalog
        description - description of the file in the catalog
        fullPath - full path of the file - used to access the file through the connector
        columnHeaders - does the first line of the file contain the column names. If not pass the list of column headers.
        delimiterCharacter - what is the delimiter character - null for default of comma
        quoteCharacter - what is the character to group a field that contains delimiter characters
        Returns:
        list of GUIDs from the top level to the root of the pathname
        Throws:
        InvalidParameterException - full path or userId is null
        PropertyServerException - problem accessing property server
        UserNotAuthorizedException - security access problem