com.itemis.maven.plugins.unleash.scm.ScmProviderInitialization Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of unleash-scm-provider-api Show documentation

The API used by the Unleash Maven Plugin to talk to different SCM providers.

There is a newer version: 2.10.0

Show newest version

package com.itemis.maven.plugins.unleash.scm;

import java.io.File;
import java.util.logging.Logger;

import com.google.common.base.Optional;

/**
 * A wrapper for initialization parameters for {@link ScmProvider ScmProviders}.
 *
 * @author Stanley Hillner
 * @since 2.0.0
 */
public interface ScmProviderInitialization {
  /**
   * @return The working directory of the provider instance. This directory can either exist or not and is the point
   *         where the provider shall checkout things and work on.
   */
  File getWorkingDirectory();

  /**
   * @return an optional username for user/password authentication.
   */
  Optional getUsername();

  /**
   * @return an optional password for user/password authentication.
   */
  Optional getPassword();

  /**
   * @return an optional passphrase that can be used for public key authentication when using SSH.
   */
  Optional getSshPrivateKeyPassphrase();

  /**
   * @return an optional private key to use for SSH-based SCM access.
   */
  Optional getSshPrivateKey();

  /**
   * @return an optional logger for the provider.
   */
  Optional getLogger();
}