org.infrastructurebuilder.data.IBDataSource Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ibdata-api Show documentation
APIs for dealing with data streams
The newest version!
/**
 * Copyright © 2019 admin ([email protected])
 *
 * 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 org.infrastructurebuilder.data;

import java.util.List;
import java.util.Optional;
import java.util.function.Supplier;

import org.infrastructurebuilder.util.BasicCredentials;
import org.infrastructurebuilder.util.IBLoggerEnabled;
import org.infrastructurebuilder.util.artifacts.Checksum;
import org.infrastructurebuilder.util.config.ConfigMap;
import org.infrastructurebuilder.util.files.IBChecksumPathType;
import org.w3c.dom.Document;

/**
 * An IBDataSource understands where a data stream originates and how to acquire
 * it. Furthermore, it actually acquires that datastream.
 *
 * An IBDataSource always returns `IBChecksumPathType` which is a path to an
 * acquired file with type and a checksum. The contract for IBDataSource: 1. An
 * IBDataSource should produce the same value for a get() call every time. This
 * means cacheing the results 1. the Path supplied is to the same file every
 * time. 1. The list of IBChecksumPathTypes is called for getMimeType(). This
 * should probably be removed.
 *
 *
 *
 * @author mykel.alvis
 *
 */
public interface IBDataSource extends Supplier>, IBLoggerEnabled {
//  public static final String TARGET_PATH = "Source-Target-Path";

  String getSourceURL();

  Optional getCredentials();

  Optional getChecksum();

  Optional getMetadata();

  Optional getName();

  Optional getDescription();

  Optional getAdditionalConfig();

  default boolean isExpandArchives() {
    return false;
  }

  /**
   * This is really a descriptive value, although it needs to be unique as well
   *
   * @return
   */
  String getId();

  Optional getMimeType();

  IBDataSource withAdditionalConfig(ConfigMap config);

}