All Downloads are FREE. Search and download functionalities are using the official Maven repository.

au.csiro.pathling.async.JobRegistry Maven / Gradle / Ivy

There is a newer version: 7.0.1
Show newest version
/*
 * Copyright 2023 Commonwealth Scientific and Industrial Research
 * Organisation (CSIRO) ABN 41 687 119 230.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package au.csiro.pathling.async;

import au.csiro.pathling.async.Job.JobTag;
import java.util.HashMap;
import java.util.Map;
import java.util.UUID;
import java.util.function.Function;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import lombok.extern.slf4j.Slf4j;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.context.annotation.Profile;
import org.springframework.stereotype.Component;

/**
 * Used for storing information about running asynchronous tasks.
 *
 * @author John Grimes
 */
@Slf4j
@Component
@Profile("server")
@ConditionalOnProperty(prefix = "pathling", name = "async.enabled", havingValue = "true")
public class JobRegistry {

  private final Map jobsById = new HashMap<>();
  private final Map jobsByTags = new HashMap<>();

  /**
   * Gets the job with the given tag if it exists, or creates a new one using the given factory
   * function that accepts the job id.
   *
   * @param tag the tag of the job.
   * @param jobFactory the factory function that accepts the job id and returns a new job.
   * @return the job.
   */
  @Nonnull
  public synchronized Job getOrCreate(@Nonnull final JobTag tag,
      @Nonnull final Function jobFactory) {

    final Job existingJob = jobsByTags.get(tag);
    if (existingJob != null) {
      log.debug("Returning existing job: {} for tag: {}", existingJob.getId(), tag);
      return existingJob;
    } else {
      final String jobId = UUID.randomUUID().toString();
      final Job newJob = jobFactory.apply(jobId);
      log.debug("Created new job: {} for tag: {}", newJob.getId(), tag);
      assert jobId.equals(newJob.getId());
      final Job replacedJob = jobsById.put(newJob.getId(), newJob);
      assert replacedJob == null;
      jobsByTags.put(tag, newJob);
      return newJob;
    }
  }

  /**
   * Gets the jobs of the given id if exits or returns null otherwise.
   *
   * @param id the id of the job
   * @return the job or null
   */
  @Nullable
  public synchronized Job get(@Nonnull final String id) {
    return jobsById.get(id);
  }
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy