io.cdap.plugin.common.IdUtils Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of hydrator-common Show documentation

There is a newer version: 2.12.3

/*
 * Copyright © 2016-2019 Cask Data, Inc.
 *
 * 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 io.cdap.plugin.common;

import io.cdap.cdap.etl.api.FailureCollector;

import java.util.regex.Pattern;

/**
 * Utility class for Id related operations.
 */
public final class IdUtils {

  private IdUtils() {
  }

  private static final Pattern datasetIdPattern = Pattern.compile("[$\\.a-zA-Z0-9_-]+");

  /**
   * Validates provided id. Valid id contains letters, numbers, '_' , '-' , '.' or '$'.
   *
   * @param id id to be validated
   * @throws IllegalArgumentException if id is invalid
   */
  public static void validateId(String id) throws IllegalArgumentException {
    if (!datasetIdPattern.matcher(id).matches()) {
      throw new IllegalArgumentException(
        String.format("Invalid id '%s'. Supported characters are: letters, numbers, and '_', '-', '.', or '$'.", id));
    }
  }

  /**
   * Validates provided reference name. If the reference name is not valid,
   * adds the validation failure to the failure collector.
   * Valid reference name contains letters, numbers, '_' , '-' , '.' or '$'.
   *
   * @param referenceName reference name to be validated
   * @param collector failure collector
   */
  public static void validateReferenceName(String referenceName, FailureCollector collector) {
    if (!datasetIdPattern.matcher(referenceName).matches()) {
      collector.addFailure(String.format("Invalid reference name '%s'.", referenceName),
                           "Supported characters are: letters, numbers, and '_', '-', '.', or '$'.")
        .withConfigProperty(Constants.Reference.REFERENCE_NAME);
    }
  }
}