StateStores.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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 gobblin.runtime.util;

import com.typesafe.config.Config;
import com.typesafe.config.ConfigValueFactory;
import gobblin.configuration.ConfigurationKeys;
import gobblin.metastore.StateStore;
import gobblin.runtime.TaskState;
import gobblin.source.workunit.MultiWorkUnit;
import gobblin.source.workunit.WorkUnit;
import gobblin.util.ClassAliasResolver;
import gobblin.util.ConfigUtils;
import org.apache.hadoop.fs.Path;

/**
 * state stores used for storing work units and task states
 */
public class StateStores {
  public final StateStore<TaskState> taskStateStore;
  public final StateStore<WorkUnit> wuStateStore;
  public final StateStore<MultiWorkUnit> mwuStateStore;

  /**
   * Creates the state stores under storeBase
   * {@link WorkUnit}s will be stored under storeBase/_workunits/subdir/filename.(m)wu
   * {@link TaskState}s will be stored under storeBase/_taskstates/subdir/filename.tst
   * Some state stores such as the MysqlStateStore do not preserve the path prefix of storeRoot.
   * In those cases only the last three components of the path determine the key for the data.
   * @param config config properties
   * @param taskStoreBase the base directory that holds the store root for the task state store
   */
  public StateStores(Config config, Path taskStoreBase, String taskStoreTable, Path workUnitStoreBase,
      String workUnitStoreTable) {
    String stateStoreType = ConfigUtils.getString(config, ConfigurationKeys.STATE_STORE_TYPE_KEY,
        ConfigurationKeys.DEFAULT_STATE_STORE_TYPE);

    ClassAliasResolver<StateStore.Factory> resolver =
        new ClassAliasResolver<>(StateStore.Factory.class);
    StateStore.Factory stateStoreFactory;

    try {
      stateStoreFactory = resolver.resolveClass(stateStoreType).newInstance();
    } catch (ClassNotFoundException cnfe) {
      throw new RuntimeException(cnfe);
    } catch (InstantiationException ie) {
      throw new RuntimeException(ie);
    } catch (IllegalAccessException iae) {
      throw new RuntimeException(iae);
    }

    // Override properties to configure the WorkUnit and MultiWorkUnit StateStores with the appropriate root/db location
    Path inputWorkUnitDir = new Path(workUnitStoreBase, workUnitStoreTable);
    Config wuStateStoreConfig = config
        .withValue(ConfigurationKeys.STATE_STORE_ROOT_DIR_KEY,
            ConfigValueFactory.fromAnyRef(inputWorkUnitDir.toString()))
        .withValue(ConfigurationKeys.STATE_STORE_DB_TABLE_KEY,
            ConfigValueFactory.fromAnyRef(workUnitStoreTable));

    // Override properties to place the TaskState StateStore at the appropriate location
    Path taskStateOutputDir = new Path(taskStoreBase, taskStoreTable);
    Config taskStateStoreConfig = config
        .withValue(ConfigurationKeys.STATE_STORE_ROOT_DIR_KEY,
            ConfigValueFactory.fromAnyRef(taskStateOutputDir.toString()))
        .withValue(ConfigurationKeys.STATE_STORE_DB_TABLE_KEY,
            ConfigValueFactory.fromAnyRef(taskStoreTable));

    taskStateStore = stateStoreFactory.createStateStore(taskStateStoreConfig, TaskState.class);
    wuStateStore = stateStoreFactory.createStateStore(wuStateStoreConfig, WorkUnit.class);
    mwuStateStore = stateStoreFactory.createStateStore(wuStateStoreConfig, MultiWorkUnit.class);
  }
}