PackageFile.java

/*
 * #%L
 * wcm.io
 * %%
 * Copyright (C) 2014 wcm.io
 * %%
 * 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.
 * #L%
 */
package io.wcm.maven.plugins.contentpackage;

import java.io.File;

/**
 * References a content package file for uploading.
 */
public final class PackageFile {

  /**
   * Content package file.
   */
  @SuppressWarnings("java:S1700")
  private File packageFile;

  /**
   * The groupId of the artifact to install.
   */
  private String groupId;

  /**
   * The artifactId of the artifact to install.
   */
  private String artifactId;

  /**
   * The packaging of the artifact to install.
   */
  @SuppressWarnings("PMD.ImmutableField")
  private String type = "zip";

  /**
   * The version of the artifact to install.
   */
  private String version;

  /**
   * The classifier of the artifact to install.
   */
  private String classifier;

  /**
   * A string of the form <code>groupId:artifactId[:packaging][:classifier]:version</code>.
   */
  private String artifact;

  /**
   * Whether to install (unpack) the uploaded package automatically or not.
   */
  private Boolean install;

  /**
   * Force upload and install of content package. If set to false a package is not uploaded or installed
   * if it was already uploaded before.
   */
  private Boolean force;

  /**
   * If set to true nested packages get installed as well.
   */
  private Boolean recursive;

  /**
   * Delay further steps after package installation by this amount of seconds.
   */
  private Integer delayAfterInstallSec;

  /**
   * HTTP socket timeout (in seconds) for this package.
   */
  private Integer httpSocketTimeoutSec;

  File getPackageFile() {
    return this.packageFile;
  }

  String getGroupId() {
    return this.groupId;
  }

  String getArtifactId() {
    return this.artifactId;
  }

  String getType() {
    return this.type;
  }

  String getVersion() {
    return this.version;
  }

  String getClassifier() {
    return classifier;
  }

  String getArtifact() {
    return this.artifact;
  }

  Boolean getInstall() {
    return this.install;
  }

  Boolean getForce() {
    return this.force;
  }

  Boolean getRecursive() {
    return this.recursive;
  }

  Integer getDelayAfterInstallSec() {
    return this.delayAfterInstallSec;
  }

  Integer getHttpSocketTimeoutSec() {
    return this.httpSocketTimeoutSec;
  }

}