DatasetUrnStateStoreNameParser.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.metastore.nameParser;

import java.io.IOException;
import java.util.Collection;


/**
 * Parses datasetUrns to dataset state store name. This is useful for systems that have limit on the length of the state
 * store name.
 */
public interface DatasetUrnStateStoreNameParser {

  /**
   * Get state store name from the given datasetUrn.
   */
  String getStateStoreNameFromDatasetUrn(String datasetUrn)
      throws IOException;

  /**
   * Get datasetUrn from the given state store name.
   */
  String getDatasetUrnFromStateStoreName(String stateStoreName)
      throws IOException;

  /**
   * Persist {@link Collection} of datasteUrns.
   */
  void persistDatasetUrns(Collection<String> datasetUrns)
      throws IOException;
}