de.smartics.maven.plugin.buildmetadata.data.MavenMetaDataSelection Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2006-2019 smartics, Kronseder & Reiner GmbH
 *
 * 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 de.smartics.maven.plugin.buildmetadata.data;

import de.smartics.maven.plugin.buildmetadata.common.Property;

import java.util.List;

/**
 * Defines the Maven information to be included in the build meta data.
 */
public final class MavenMetaDataSelection {
  // ********************************* Fields *********************************

  // --- constants ------------------------------------------------------------

  // --- members --------------------------------------------------------------

  /**
   * Add environment variables if set to true, skip it, if set to
   * false. If you are not interested in the environment variables
   * of the host (e.g. for security reasons, set this to false).
   */
  private boolean addEnvInfo;

  /**
   * Add information about the Java runtime running the build if set to
   * true, skip it, if set to false.
   */
  private boolean addJavaRuntimeInfo;

  /**
   * Add information about the operating system the build is run in if set to
   * true, skip it, if set to false.
   */
  private boolean addOsInfo;

  /**
   * Add Maven execution information (commandline, goals, profiles, etc.) if set
   * to true, skip it, if set to false. If you are not
   * interested in execution information, set this to false.
   */
  private boolean addMavenExecutionInfo;

  /**
   * Add project information (homepage URL, categories, tags, etc.) if set to
   * true, skip it, if set to false. If you are not
   * interested in execution information, set this to false.
   */
  private boolean addProjectInfo;

  /**
   * While the command line may be useful to refer to for a couple of reasons,
   * displaying it with the build properties is a security issue. Some plugins
   * allow to read passwords as properties from the command line and this
   * sensible data will be shown.
   */
  private boolean hideCommandLineInfo;

  /**
   * While the MAVEN_OPTS may be useful to refer to for a couple of reasons,
   * displaying them with the build properties is a security issue. Some plugins
   * allow to read passwords as properties from the command line and this
   * sensible data will be shown.
   */
  private boolean hideMavenOptsInfo;

  /**
   * While the JAVA_OPTS may be useful to refer to for a couple of reasons,
   * displaying them with the build properties is a security issue. Some plugins
   * allow to read passwords as properties from the command line and this
   * sensible data will be shown.
   * 
   * Therefore the JAVA_OPTS are hidden by default (true). To
   * include this information, use a value of false.
   * 
   */
  private boolean hideJavaOptsInfo;

  /**
   * The list of a system properties or environment variables to be selected by
   * the user to include into the build meta data properties.
   * 
   * The name is the name of the property, the section is relevant for placing
   * the property in one of the following sections:
   * 
   * 
   * build.scm
   * build.dateAndVersion
   * build.runtime
   * build.java
   * build.maven
   * build.misc
   * 
   * 
   * If no valid section is given, the property is silently rendered in the
   * build.misc section.
   * 
   */
  private List selectedSystemProperties;

  // ****************************** Initializer *******************************

  // ****************************** Constructors ******************************

  // ****************************** Inner Classes *****************************

  // ********************************* Methods ********************************

  // --- init -----------------------------------------------------------------

  // --- get&set --------------------------------------------------------------

  /**
   * Returns the value for addMavenExecutionInfo.
   * 
   * Add Maven execution information (commandline, goals, profiles, etc. ) if
   * set to true, skip it, if set to false. If you are
   * not interested in execution information, set this to false.
   * 
   *
   * @return the value for addMavenExecutionInfo.
   */
  public boolean isAddMavenExecutionInfo() {
    return addMavenExecutionInfo;
  }

  /**
   * Sets the value for addMavenExecutionInfo.
   * 
   * Add Maven execution information (commandline, goals, profiles, etc. ) if
   * set to true, skip it, if set to false. If you are
   * not interested in execution information, set this to false.
   * 
   *
   * @param addMavenExecutionInfo the value for addMavenExecutionInfo.
   */
  public void setAddMavenExecutionInfo(final boolean addMavenExecutionInfo) {
    this.addMavenExecutionInfo = addMavenExecutionInfo;
  }

  /**
   * Returns the value for hideCommandLineInfo.
   * 
   * While the command line may be useful to refer to for a couple of reasons,
   * displaying it with the build properties is a security issue. Some plugins
   * allow to read passwords as properties from the command line and this
   * sensible data will be shown.
   * 
   *
   * @return the value for hideCommandLineInfo.
   */
  public boolean isHideCommandLineInfo() {
    return hideCommandLineInfo;
  }

  /**
   * Sets the value for hideCommandLineInfo.
   * 
   * While the command line may be useful to refer to for a couple of reasons,
   * displaying it with the build properties is a security issue. Some plugins
   * allow to read passwords as properties from the command line and this
   * sensible data will be shown.
   * 
   *
   * @param hideCommandLineInfo the value for hideCommandLineInfo.
   */
  public void setHideCommandLineInfo(final boolean hideCommandLineInfo) {
    this.hideCommandLineInfo = hideCommandLineInfo;
  }

  /**
   * Returns the value for hideMavenOptsInfo.
   * 
   * While the MAVEN_OPTS may be useful to refer to for a couple of reasons,
   * displaying them with the build properties is a security issue. Some plugins
   * allow to read passwords as properties from the command line and this
   * sensible data will be shown.
   * 
   *
   * @return the value for hideMavenOptsInfo.
   */
  public boolean isHideMavenOptsInfo() {
    return hideMavenOptsInfo;
  }

  /**
   * Sets the value for hideMavenOptsInfo.
   * 
   * While the MAVEN_OPTS may be useful to refer to for a couple of reasons,
   * displaying them with the build properties is a security issue. Some plugins
   * allow to read passwords as properties from the command line and this
   * sensible data will be shown.
   * 
   *
   * @param hideMavenOptsInfo the value for hideMavenOptsInfo.
   */
  public void setHideMavenOptsInfo(final boolean hideMavenOptsInfo) {
    this.hideMavenOptsInfo = hideMavenOptsInfo;
  }

  /**
   * Returns the value for hideJavaOptsInfo.
   * 
   * While the JAVA_OPTS may be useful to refer to for a couple of reasons,
   * displaying them with the build properties is a security issue. Some plugins
   * allow to read passwords as properties from the command line and this
   * sensible data will be shown.
   * 
   * 
   * Therefore the JAVA_OPTS are hidden by default (true). To
   * include this information, use a value of false.
   * 
   *
   * @return the value for hideJavaOptsInfo.
   */
  public boolean isHideJavaOptsInfo() {
    return hideJavaOptsInfo;
  }

  /**
   * Sets the value for hideJavaOptsInfo.
   * 
   * While the JAVA_OPTS may be useful to refer to for a couple of reasons,
   * displaying them with the build properties is a security issue. Some plugins
   * allow to read passwords as properties from the command line and this
   * sensible data will be shown.
   * 
   * 
   * Therefore the JAVA_OPTS are hidden by default (true). To
   * include this information, use a value of false.
   * 
   *
   * @param hideJavaOptsInfo the value for hideJavaOptsInfo.
   */
  public void setHideJavaOptsInfo(final boolean hideJavaOptsInfo) {
    this.hideJavaOptsInfo = hideJavaOptsInfo;
  }

  /**
   * Sets the value for addEnvInfo.
   * 
   * Add environment variables if set to true, skip it, if set to
   * false. If you are not interested in the environment variables
   * of the host (e.g. for security reasons, set this to false).
   * 
   *
   * @param addEnvInfo the value for addEnvInfo.
   */
  public void setAddEnvInfo(final boolean addEnvInfo) {
    this.addEnvInfo = addEnvInfo;
  }

  /**
   * Returns the value for addEnvInfo.
   * 
   * Add environment variables if set to true, skip it, if set to
   * false. If you are not interested in the environment variables
   * of the host (e.g. for security reasons, set this to false).
   * 
   *
   * @return the value for addEnvInfo.
   */
  public boolean isAddEnvInfo() {
    return addEnvInfo;
  }

  /**
   * Returns the value for addJavaRuntimeInfo.
   * 
   * Add information about the Java runtime running the build if set to
   * true, skip it, if set to false.
   * 
   *
   * @return the value for addJavaRuntimeInfo.
   */
  public boolean isAddJavaRuntimeInfo() {
    return addJavaRuntimeInfo;
  }

  /**
   * Sets the value for addJavaRuntimeInfo.
   * 
   * Add information about the Java runtime running the build if set to
   * true, skip it, if set to false.
   * 
   *
   * @param addJavaRuntimeInfo the value for addJavaRuntimeInfo.
   */
  public void setAddJavaRuntimeInfo(final boolean addJavaRuntimeInfo) {
    this.addJavaRuntimeInfo = addJavaRuntimeInfo;
  }

  /**
   * Sets the value for addProjectInfo.
   * 
   * Add project information (homepage URL, categories, tags, etc.) if set to
   * true, skip it, if set to false. If you are not
   * interested in execution information, set this to false.
   * 
   *
   * @param addProjectInfo the value for addProjectInfo.
   */
  public void setAddProjectInfo(final boolean addProjectInfo) {
    this.addProjectInfo = addProjectInfo;
  }

  /**
   * Returns the value for addProjectInfo.
   * 
   * Add project information (homepage URL, categories, tags, etc.) if set to
   * true, skip it, if set to false. If you are not
   * interested in execution information, set this to false.
   * 
   *
   * @return the value for addProjectInfo.
   */
  public boolean isAddProjectInfo() {
    return addProjectInfo;
  }

  /**
   * Returns the value for addOsInfo.
   * 
   * Add information about the operating system the build is run in if set to
   * true, skip it, if set to false.
   * 
   *
   * @return the value for addOsInfo.
   */
  public boolean isAddOsInfo() {
    return addOsInfo;
  }

  /**
   * Sets the value for addOsInfo.
   * 
   * Add information about the operating system the build is run in if set to
   * true, skip it, if set to false.
   * 
   *
   * @param addOsInfo the value for addOsInfo.
   */
  public void setAddOsInfo(final boolean addOsInfo) {
    this.addOsInfo = addOsInfo;
  }

  /**
   * Returns the list of a system properties or environment variables to be
   * selected by the user to include into the build meta data properties.
   * 
   * The name is the name of the property, the section is relevant for placing
   * the property in one of the following sections:
   * 
   * 
   * build.scm
   * build.dateAndVersion
   * build.runtime
   * build.java
   * build.maven
   * build.misc
   * 
   * 
   * If no valid section is given, the property is silently rendered in the
   * build.misc section.
   * 
   *
   * @return the list of a system properties to be selected by the user to
   *         include into the build meta data properties.
   */
  public List getSelectedSystemProperties() {
    return selectedSystemProperties;
  }

  /**
   * Sets the list of a system properties or environment variables to be
   * selected by the user to include into the build meta data properties.
   * 
   * The name is the name of the property, the section is relevant for placing
   * the property in one of the following sections:
   * 
   * 
   * build.scm
   * build.dateAndVersion
   * build.runtime
   * build.java
   * build.maven
   * build.misc
   * 
   * 
   * If no valid section is given, the property is silently rendered in the
   * build.misc section.
   * 
   *
   * @param selectedSystemProperties the list of a system properties to be
   *        selected by the user to include into the build meta data properties.
   */
  public void setSelectedSystemProperties(
      final List selectedSystemProperties) {
    this.selectedSystemProperties = selectedSystemProperties;
  }

  // --- business -------------------------------------------------------------

  // --- object basics --------------------------------------------------------

}