CPF Client Java API

Process the object.

Construct a new CpfClient connected to the specified server using the consumerKey and consumerSecret for authentication.

The following code fragment shows an example of using the API.

  String url = "https://apps.gov.bc.ca/pub/cpf";
  String consumerKey = "cpftest";
  String consumerSecret = "cpftest";
  CpfClient client = new CpfClient(url, consumerKey, consumerSecret);

Close the connection to the CPF service. Once this method has been called the client can no longer be used and a new instance must be created. This should be called when the client is no longer needed to clean up resources.

The following code fragment shows an example of using the API.

  String url = "https://apps.gov.bc.ca/pub/cpf";
  String consumerKey = "cpftest";
  String consumerSecret = "cpftest";

  try (CpfClient client = new CpfClient(url, consumerKey, consumerSecret)) {
    // Use the client
  }

Close the connection to the CPF service. Once this method has been called the client can no longer be used and a new instance must be created. This should be called when the client is no longer needed to clean up resources.

The following code fragment shows an example of using the API.

  String url = "https://apps.gov.bc.ca/pub/cpf";
  String consumerKey = "cpftest";
  String consumerSecret = "cpftest";
  CpfClient client = new CpfClient(url, consumerKey, consumerSecret);
  try {
    // Use the client
  } finally {
    client.closeConnection();
  }

Delete the job using the Delete Job REST API.

The following code fragment shows an example of using the API.

  String url = "https://apps.gov.bc.ca/pub/cpf";
  String consumerKey = "cpftest";
  String consumerSecret = "cpftest";
  CpfClient client = new CpfClient(url, consumerKey, consumerSecret);
  try {
    Map<String, Object> parameters = new HashMap<String, Object>();
    parameters.put("mapGridName", "BCGS 1:20 000");
    parameters.put("mapTileId", "92g025");
    String jobId = client.createJobWithStructuredSingleRequest(
      "MapTileByTileId", parameters, "application/json");
    // Download the results of the job
    client.closeJob(jobId);
  } finally {
    client.closeConnection();
  }

Construct a new new job on the CPF server for a business application that accepts opaque input data using the Create Job With Multiple Requests REST API.

The content of the opaque data for each request is specified using a spring framework Resource object.

NOTE: There is a limit of 20MB of data for a multipart/form-data HTTP request. For jobs with large volumes of data make the data available on a HTTP server use the URL versions of this method instead.

The following code fragment shows an example of using the API.

  String url = "https://apps.gov.bc.ca/pub/cpf";
  String consumerKey = "cpftest";
  String consumerSecret = "cpftest";
  CpfClient client = new CpfClient(url, consumerKey, consumerSecret);
  try {
    Map<String, Object> parameters = new HashMap<String, Object>();
    parameters.put("algorithmName", "MD5");

    List<Resource> requests = new ArrayList<Resource>();
    requests.add(new ByteArrayResource("Test string".getBytes()));
    // requests.add(new FileSystemResource(pathToFile));

    String jobId = client.createJobWithOpaqueResourceRequests("Digest",
      "1.0.0", parameters, "text/plain", "application/json", requests);
    // Download the results of the job
    client.closeJob(jobId);
  } finally {
    client.closeConnection();
  }

String The job id (URL) of the created job.

Construct a new new job on the CPF server for a business application that accepts opaque input data using the Create Job With Multiple Requests REST API.

The content of the opaque data for each request is specified using a spring framework Resource object.

NOTE: There is a limit of 20MB of data for a multipart/form-data HTTP request. For jobs with large volumes of data make the data available on a HTTP server use the URL versions of this method instead.

The following code fragment shows an example of using the API.

  String url = "https://apps.gov.bc.ca/pub/cpf";
  String consumerKey = "cpftest";
  String consumerSecret = "cpftest";
  CpfClient client = new CpfClient(url, consumerKey, consumerSecret);
  try {
    Map<String, Object> parameters = new HashMap<String, Object>();
    parameters.put("algorithmName", "MD5");

    List<Resource> requests = new ArrayList<Resource>();
    requests.add(new ByteArrayResource("Test string".getBytes()));
    // requests.add(Resource resource = new FileSystemResource(pathToFile));

    String jobId = client.createJobWithOpaqueResourceRequests("Digest",
      "1.0.0", parameters, "text/plain", "application/json", requests);
    // Download the results of the job
    client.closeJob(jobId);
  } finally {
    client.closeConnection();
  }

String The job id (URL) of the created job.

Construct a new new job on the CPF server for a business application that accepts opaque input data using the Create Job With Multiple Requests REST API.

The content of the opaque data for each request is specified using a URL to the data on a publicly accessible HTTP server.

The following code fragment shows an example of using the API.

  String url = "https://apps.gov.bc.ca/pub/cpf";
  String consumerKey = "cpftest";
  String consumerSecret = "cpftest";
  CpfClient client = new CpfClient(url, consumerKey, consumerSecret);
  try {
    Map<String, Object> parameters = new HashMap<String, Object>();
    parameters.put("algorithmName", "MD5");

    <Resource> inputDataUrls = new Array<Resource>();
    inputDataUrls.add("https://apps.gov.bc.ca/pub/cpf/css/cpf.css");

    String jobId = client.createJobWithOpaqueUrlRequests("Digest",
      "1.0.0", parameters, "text/plain", "application/json", inputDataUrls);
    // Download the results of the job
    client.closeJob(jobId);
  } finally {
    client.closeConnection();
  }

String The job id (URL) of the created job.

Construct a new new job on the CPF server for a business application that accepts opaque input data using the Create Job With Multiple Requests REST API.

The content of the opaque data for each request is specified using a URL to the data on a publicly accessible HTTP server.

The following code fragment shows an example of using the API.

  String url = "https://apps.gov.bc.ca/pub/cpf";
  String consumerKey = "cpftest";
  String consumerSecret = "cpftest";
  CpfClient client = new CpfClient(url, consumerKey, consumerSecret);
  try {
    Map<String, Object> parameters = new HashMap<String, Object>();
    parameters.put("algorithmName", "MD5");

    String inputDataUrl = "https://apps.gov.bc.ca/pub/cpf/css/cpf.css";

    String jobId = client.createJobWithOpaqueUrlRequests("Digest",
      "1.0.0", parameters, "text/plain", "application/json", inputDataUrl);
    // Download the results of the job
    client.closeJob(jobId);
  } finally {
    client.closeConnection();
  }

String The job id (URL) of the created job.

Construct a new new job on the CPF server for a business application that accepts structured input data using the Create Job With Multiple Requests REST API.

The content of the structured data is specified as a list of requests. Each request is specified as a map containing the request parameters.

NOTE: There is a limit of 20MB of data for a multipart/form-data HTTP request. For jobs with large volumes of data make the data available on a HTTP server use the URL version of this method instead.

The following code fragment shows an example of using the API.

  String url = "https://apps.gov.bc.ca/pub/cpf";
  String consumerKey = "cpftest";
  String consumerSecret = "cpftest";
  CpfClient client = new CpfClient(url, consumerKey, consumerSecret);
  try {
    Map<String, Object> jobParameters = new HashMap<String, Object>();
    jobParameters.put("mapGridName", "BCGS 1:20 000");

    List<Map<String,?extends Object>> requests = new ArrayList<Map<String,?extends Object>>();
    requests.add(Collections.singletonMap("mapTileId", "92j025"));
    requests.add(Collections.singletonMap("mapTileId", "92j016"));

    String jobId = client.createJobWithStructuredMultipleRequestsList(
      "MapTileByTileId", jobParameters, requests,"application/json");
    try {
      List<Map<String, Object>> results = client.getJobStructuredResults(
        jobId, 5000);
      for (Map<String, Object> result : results) {
        System.out.println(result);
      }
    } finally {
      client.closeJob(jobId);
    }
  } finally {
    client.closeConnection();
  }

String The job id (URL) of the created job.

Construct a new new job on the CPF server for a business application that accepts structured input data using the Create Job With Multiple Requests REST API.

The content of the structured in data for each request is specified using a spring framework Resource object. The resource must be encoded using the file format specified by the inputDataContentType. The resource must contain one record containing the request parameters for each request to be processed by the business application.

NOTE: There is a limit of 20MB of data for a multipart/form-data HTTP request. For jobs with large volumes of data make the data available on a HTTP server use the URL version of this method instead.

The following code fragment shows an example of using the API.

  String url = "https://apps.gov.bc.ca/pub/cpf";
  String consumerKey = "cpftest";
  String consumerSecret = "cpftest";
  CpfClient client = new CpfClient(url, consumerKey, consumerSecret);
  try {
    Map<String, Object> jobParameters = new HashMap<String, Object>();
    jobParameters.put("mapGridName", "NTS 1:500 000");

    int numRequests = 48;
    Resource inputData = new FileSystemResource(
      "../cpf-war-app/src/main/webapp/docs/sample/NTS-500000-by-name.csv");

    String jobId = client.createJobWithStructuredMultipleRequestsResource(
      "MapTileByTileId", jobParameters, numRequests, inputData,
      "text/csv", "application/json");
    try {
      List<Map<String, Object>> results = client.getJobStructuredResults(
        jobId, 30000);
      for (Map<String, Object> result : results) {
        System.out.println(result);
      }
    } finally {
      client.closeJob(jobId);
    }
  } finally {
    client.closeConnection();
  }

String The job id (URL) of the created job.

Construct a new new job on the CPF server for a business application that accepts structured input data using the Create Job With Multiple Requests REST API.

The content of the structured in data for each request is specified using a URL to the data on a publicly accessible HTTP server. The data must be encoded using the file format specified by the inputDataContentType. The data must contain one record containing the request parameters for each request to be processed by the business application.

The following code fragment shows an example of using the API.

  String url = "https://apps.gov.bc.ca/pub/cpf";
  String consumerKey = "cpftest";
  String consumerSecret = "cpftest";
  CpfClient client = new CpfClient(url, consumerKey, consumerSecret);
  try {
    Map<String, Object> jobParameters = new HashMap<String, Object>();
    jobParameters.put("mapGridName", "NTS 1:500 000");

    int numRequests = 48;

    String inputDataUrl = "https://apps.gov.bc.ca/pub/cpf/docs/sample/NTS-500000-by-name.csv";
    String jobId = client.createJobWithStructuredMultipleRequestsUrl(
      "MapTileByTileId", jobParameters, numRequests, inputDataUrl,
      "text/csv", "application/json");
    try {
      List<Map<String, Object>> results = client.getJobStructuredResults(
        jobId, 30000);
      for (Map<String, Object> result : results) {
        System.out.println(result);
      }
    } finally {
      client.closeJob(jobId);
    }
  } finally {
    client.closeConnection();
  }

String The job id (URL) of the created job.

Construct a new new job on the CPF server for a business application that accepts structured input data using the Create Job With Multiple Requests REST API.

The job and request parameters for the single request in the job are specified using a map of parameter values.

The following code fragment shows an example of using the API.

  String url = "https://apps.gov.bc.ca/pub/cpf";
  String consumerKey = "cpftest";
  String consumerSecret = "cpftest";
  CpfClient client = new CpfClient(url, consumerKey, consumerSecret);
  try {
    Map<String, Object> parameters = new HashMap<String, Object>();
    parameters.put("mapGridName", "BCGS 1:20 000");
    parameters.put("mapTileId", "92j025");
    String jobId = client.createJobWithStructuredSingleRequest(
      "MapTileByTileId", parameters, "application/json");
    try {
      List<Map<String, Object>> results = client.getJobStructuredResults(
        jobId, 5000);
      for (Map<String, Object> result : results) {
        System.out.println(result);
      }
    } finally {
      client.closeJob(jobId);
    }
  } finally {
    client.closeConnection();
  }

String The job id (URL) of the created job.

Get the specification of the instant execution service for a business application using the Get Business Applications Instant REST API.

The following code fragment shows an example of using the API.

  String url = "https://apps.gov.bc.ca/pub/cpf";
  String consumerKey = "cpftest";
  String consumerSecret = "cpftest";
  CpfClient client = new CpfClient(url, consumerKey, consumerSecret);
  try {
    Map<String, Object> specification = client.getBusinessApplicationInstantSpecification(
      "MapTileByTileId");
    System.out.println(specification);
   } finally {
    client.closeConnection();
  }

Map<String, Object> The map containing the business application specification.

Get the specification of the create job with multiple requests service for a business application using the Get Business Applications Multiple REST API.

The following code fragment shows an example of using the API.

  String url = "https://apps.gov.bc.ca/pub/cpf";
  String consumerKey = "cpftest";
  String consumerSecret = "cpftest";
  CpfClient client = new CpfClient(url, consumerKey, consumerSecret);
  try {
    Map<String, Object> specification = client.getBusinessApplicationMultipleSpecification(
      "MapTileByTileId");
    System.out.println(specification);
   } finally {
    client.closeConnection();
  }

Map<String, Object> The map containing the business application specification.

Get the list of business application names a user has access to using the Get Business Applications REST API.

The following code fragment shows an example of using the API.

  String url = "https://apps.gov.bc.ca/pub/cpf";
  String consumerKey = "cpftest";
  String consumerSecret = "cpftest";
  CpfClient client = new CpfClient(url, consumerKey, consumerSecret);
  try {
    <Resource> businessApplicationNames = client.getBusinessApplicationNames();
    for (String businessApplicationName : businessApplicationNames) {
      System.out.println(businessApplicationName);
    }
  } finally {
    client.closeConnection();
  }

List<String> The list of business application names.

Get the specification of the create job with a single request service for a business application using the Get Business Applications Single REST API.

The following code fragment shows an example of using the API.

  String url = "https://apps.gov.bc.ca/pub/cpf";
  String consumerKey = "cpftest";
  String consumerSecret = "cpftest";
  CpfClient client = new CpfClient(url, consumerKey, consumerSecret);
  try {
    Map<String, Object> specification = client.getBusinessApplicationSingleSpecification(
      "MapTileByTileId");
    System.out.println(specification);
   } finally {
    client.closeConnection();
  }

Map<String, Object> The map containing the business application specification.

Get the list of error results for a job using the using the Get Users Job Results and Get Users Job Result REST API.

Each error record is a map containing the following fields.

NOTE: This method loads all the error results into memory. If a larger number of errors were generated use the processJobErrorResults method.

The following code fragment shows an example of using the API.

  String url = "https://apps.gov.bc.ca/pub/cpf";
  String consumerKey = "cpftest";
  String consumerSecret = "cpftest";
  CpfClient client = new CpfClient(url, consumerKey, consumerSecret);
  try {
    Map<String, Object> parameters = new HashMap<String, Object>();
    parameters.put("mapGridName", "BCGS 1:20 000");
    parameters.put("mapTileId", "INVALID");
    String jobId = client.createJobWithStructuredSingleRequest(
      "MapTileByTileId", parameters, "application/json");
    try {
      List<Map<String, Object>> results = client.getJobErrorResults(
        jobId, 2000);
      for (Map<String, Object> error : results) {
        System.out.println(error);
      }
    } finally {
      client.closeJob(jobId);
    }
  } finally {
    client.closeConnection();
  }

List<Map<String, Object>> The reader maps containing the result fields.

Get the list of result file descriptions for a job using the using the Get Users Job Results REST API.

Each result file description contains the following fields.

The following code fragment shows an example of using the API.

  String url = "https://apps.gov.bc.ca/pub/cpf";
  String consumerKey = "cpftest";
  String consumerSecret = "cpftest";
  CpfClient client = new CpfClient(url, consumerKey, consumerSecret);
  try {
    Map<String, Object> parameters = new HashMap<String, Object>();
    parameters.put("mapGridName", "BCGS 1:20 000");
    parameters.put("mapTileId", "INVALID");
    String jobId = client.createJobWithStructuredSingleRequest(
      "MapTileByTileId", parameters, "application/json");
    try {
      List<Map<String, Object>> files = client.getJobResultFileList(jobId, 2000);
      for (Map<String, Object> file : files) {
        System.out.println(file);
      }
    } finally {
      client.closeJob(jobId);
    }
  } finally {
    client.closeConnection();
  }

List<Map<String, Object>> The list of maps that describe each of the result files.

Get the job status using the Get Users Jobs Info REST API.

The following code fragment shows an example of using the API.

  String url = "https://apps.gov.bc.ca/pub/cpf";
  String consumerKey = "cpftest";
  String consumerSecret = "cpftest";
  CpfClient client = new CpfClient(url, consumerKey, consumerSecret);
  try {
    Map<String, Object> parameters = new HashMap<String, Object>();
    parameters.put("mapGridName", "BCGS 1:20 000");
    parameters.put("mapTileId", "INVALID");
    String jobId = client.createJobWithStructuredSingleRequest(
      "MapTileByTileId", parameters, "application/json");
    try {
      Map<String, Object> status = client.getJobStatus(jobId);
      System.out.println(status);
    } finally {
      client.closeJob(jobId);
    }
  } finally {
    client.closeConnection();
  }

Map<String, Object> A map containing the job status.

Get the list of structured data results for a job using the using the Get Users Job Results and Get Users Job Result REST API.

Each structured data record is a map containing the following fields.

NOTE: This method loads all the structured data results into memory. If a larger number of results were generated use the processJobErrorResults method.

The following code fragment shows an example of using the API.

  String url = "https://apps.gov.bc.ca/pub/cpf";
  String consumerKey = "cpftest";
  String consumerSecret = "cpftest";
  CpfClient client = new CpfClient(url, consumerKey, consumerSecret);
  try {
    Map<String, Object> parameters = new HashMap<String, Object>();
    parameters.put("mapGridName", "BCGS 1:20 000");
    parameters.put("mapTileId", "92j025");
    String jobId = client.createJobWithStructuredSingleRequest(
      "MapTileByTileId", parameters, "application/json");
    try {
      List<Map<String, Object>> results = client.getJobStructuredResults(jobId, 2000);
      for (Map<String, Object> result : results) {
        System.out.println(result);
      }
    } finally {
      client.closeJob(jobId);
    }
  } finally {
    client.closeConnection();
  }

List<Map<String, Object>> The list of results.

Get the job id URLs for all the user's jobs using the Get Users Jobs REST API.

The following code fragment shows an example of using the API.

  String url = "https://apps.gov.bc.ca/pub/cpf";
  String consumerKey = "cpftest";
  String consumerSecret = "cpftest";
  CpfClient client = new CpfClient(url, consumerKey, consumerSecret);
  try {
    Map<String, Object> parameters = new HashMap<String, Object>();
    parameters.put("mapGridName", "BCGS 1:20 000");
    parameters.put("mapTileId", "INVALID");
    String jobId = client.createJobWithStructuredSingleRequest(
      "MapTileByTileId", parameters, "application/json");
    try {
      <Resource> jobIds = client.getUserJobIdUrls();
      for (String jobIdUrl : jobIds) {
        System.out.println(jobIdUrl);
      }
      if (!jobIds.contains(jobId)) {
        System.err.println("Missing job " + jobId);
      }
    } finally {
      client.closeJob(jobId);
    }
  } finally {
    client.closeConnection();
  }

List<String> The list of job id URLs.

Get the job id URLs to the user's jobs for a business application using the Get Business Applications Users Jobs REST API.

Get the list of all job id URLs the user created.

The following code fragment shows an example of using the API.

  String url = "https://apps.gov.bc.ca/pub/cpf";
  String consumerKey = "cpftest";
  String consumerSecret = "cpftest";
  CpfClient client = new CpfClient(url, consumerKey, consumerSecret);
  try {
    Map<String, Object> parameters = new HashMap<String, Object>();
    parameters.put("mapGridName", "BCGS 1:20 000");
    parameters.put("mapTileId", "INVALID");
    String jobId = client.createJobWithStructuredSingleRequest(
      "MapTileByTileId", parameters, "application/json");
    try {
      <Resource> jobIds = client.getUserJobIdUrls("MapTileByTileId");
      for (String jobIdUrl : jobIds) {
        System.out.println(jobIdUrl);
      }
      if (!jobIds.contains(jobId)) {
        System.err.println("Missing job " + jobId);
      }
    } finally {
      client.closeJob(jobId);
    }
  } finally {
    client.closeConnection();
  }

List<String> The list of job id URLs.

Check the job status to see if it has been completed using the Get Users Jobs Info REST API.

If the job has not been completed within the maxWait number of milliseconds false will be returned.

The following code fragment shows an example of using the API.

  String url = "https://apps.gov.bc.ca/pub/cpf";
  String consumerKey = "cpftest";
  String consumerSecret = "cpftest";
  CpfClient client = new CpfClient(url, consumerKey, consumerSecret);
  try {
    Map<String, Object> parameters = new HashMap<String, Object>();
    parameters.put("mapGridName", "BCGS 1:20 000");
    parameters.put("mapTileId", "INVALID");
    String jobId = client.createJobWithStructuredSingleRequest(
      "MapTileByTileId", parameters, "application/json");
    try {
      boolean completed = client.isJobCompleted(jobId, 2000);
      if (completed) {
        System.out.println("Job Completed");
      }
    } finally {
      client.closeJob(jobId);
    }
  } finally {
    client.closeConnection();
  }

boolean True if the job was completed, false otherwise.

Process the list of error results for a job using the using the Get Users Job Results and Get Users Job Result REST API.

Each error record is a map containing the following fields.

The callback method will be invoked for each record in the error file.

The following code fragment shows an example of using the API.

  String url = "https://apps.gov.bc.ca/pub/cpf";
  String consumerKey = "cpftest";
  String consumerSecret = "cpftest";
  CpfClient client = new CpfClient(url, consumerKey, consumerSecret);
  try {
    Map<String, Object> parameters = new HashMap<String, Object>();
    parameters.put("mapGridName", "BCGS 1:20 000");
    parameters.put("mapTileId", "INVALID");
    String jobId = client.createJobWithStructuredSingleRequest(
      "MapTileByTileId", parameters, "application/json");
    try {
      int numErrors = client.processJobErrorResults(jobId, 10000,
        new Callback<Map<String, Object>>() {
          public void process(Map<String, Object> error) {
            System.out.println(error);
          }
        });
      System.out.println(numErrors);
    } finally {
      client.closeJob(jobId);
    }
  } finally {
    client.closeConnection();
  }

int The number of error results processed.

Process the list of structured data results for a job using the using the Get Users Job Results and Get Users Job Result REST API.

Each structured record is a map with the fields sequenceNumber (to map back to the input request), resultNumber (if multiple results were returned for a single request and the business application specific result fields.

The callback method will be invoked for each record in the structured result data file.

The following code fragment shows an example of using the API.

  String url = "https://apps.gov.bc.ca/pub/cpf";
  String consumerKey = "cpftest";
  String consumerSecret = "cpftest";
  CpfClient client = new CpfClient(url, consumerKey, consumerSecret);
  try {
    Map<String, Object> parameters = new HashMap<String, Object>();
    parameters.put("mapGridName", "BCGS 1:20 000");
    parameters.put("mapTileId", "92j025");
    String jobId = client.createJobWithStructuredSingleRequest(
      "MapTileByTileId", parameters, "application/json");
    try {
      int numResults = client.processJobStructuredResults(jobId, 10000,
        new Callback<Map<String, Object>>() {
          public void process(Map<String, Object> result) {
            System.out.println(result);
          }
        });
      System.out.println(numResults);
    } finally {
      client.closeJob(jobId);
    }
  } finally {
    client.closeConnection();
  }

int The number of results processed.

Process the result file for a job using the Get Users Job Result REST API.

The callback method will be invoked with the input stream to the file. This method ensures that the input stream is closed correctly after being processed.

The following code fragment shows an example of using the API.

  String url = "https://apps.gov.bc.ca/pub/cpf";
  String consumerKey = "cpftest";
  String consumerSecret = "cpftest";
  CpfClient client = new CpfClient(url, consumerKey, consumerSecret);
  try {
    Map<String, Object> parameters = new HashMap<String, Object>();
    parameters.put("mapGridName", "BCGS 1:20 000");
    parameters.put("mapTileId", "92j016");
    String jobId = client.createJobWithStructuredSingleRequest(
      "MapTileByTileId", parameters, "application/json");
    try {
      List<Map<String, Object>> files = client.getJobResultFileList(
        jobId, 5000);
      for (Map<String, Object> file : files) {
       String jobResultUrl = (String)file.get("resourceUri");
      client.processResultFile(jobResultUrl , new Callback<Base64InputStream>() {
        public void process(Base64InputStream in) {
          // Read file from input stream
        }
      });
      }
    } finally {
      client.closeJob(jobId);
    }
  } finally {
    client.closeConnection();
  }