PackageManagerProperties

/*
 * #%L
 * wcm.io
 * %%
 * Copyright (C) 2017 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.tooling.commons.packmgr;

import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.regex.Pattern;
import java.util.stream.Collectors;

/**
 * Configuration properties for {@link PackageManagerHelper}.
 */
public final class PackageManagerProperties {

  private String packageManagerUrl;
  private String userId;
  private String password;
  private String oauth2AccessToken;
  private String consoleUserId;
  private String consolePassword;
  private String consoleOauth2AccessToken;
  private int retryCount = 24;
  private int retryDelaySec = 5;
  private String bundleStatusUrl;
  private int bundleStatusWaitLimitSec = 360;
  private List<Pattern> bundleStatusBlacklistBundleNames = Collections.emptyList();
  private List<Pattern> bundleStatusWhitelistBundleNames = Collections.emptyList();
  private String packageManagerInstallStatusURL;
  private int packageManagerInstallStatusWaitLimitSec = 360;
  private boolean relaxedSSLCheck;
  private int httpConnectTimeoutSec = 10;
  private int httpSocketTimeoutSec = 60;
  private List<Proxy> proxies;
  private String packageManagerOutputLogLevel = "INFO";

  /**
   * The URL of the HTTP service API of the CRX package manager.
   * See <a href=
   * "https://docs.adobe.com/content/docs/en/crx/2-3/how_to/package_manager.html#Managing%20Packages%20on%20the%20Command%20Line">CRX
   * HTTP service Interface</a> for details on this interface.
   * @return URL
   */
  public String getPackageManagerUrl() {
    return this.packageManagerUrl;
  }

  /**
   * @param packageManagerUrl The URL of the HTTP service API of the CRX package manager.
   */
  public void setPackageManagerUrl(String packageManagerUrl) {
    this.packageManagerUrl = packageManagerUrl;
  }

  /**
   * The user name to authenticate as against the remote CRX system (package manager).
   * @return User ID
   */
  public String getUserId() {
    return this.userId;
  }

  /**
   * @param userId The user name to authenticate as against the remote CRX system (package manager).
   */
  public void setUserId(String userId) {
    this.userId = userId;
  }

  /**
   * The password to authenticate against the remote CRX system (package manager).
   * @return Password
   */
  public String getPassword() {
    return this.password;
  }

  /**
   * @param password The password to authenticate against the remote CRX system (package manager).
   */
  public void setPassword(String password) {
    this.password = password;
  }

  /**
   * OAuth 2 access token to authenticate against the remote CRX system (package manager).
   * If this is configured, username and password are ignored.
   * @return OAuth 2 access token.
   */
  public String getOAuth2AccessToken() {
    return this.oauth2AccessToken;
  }

  /**
   * @param value OAuth 2 access token to authenticate against the remote CRX system (package manager).
   */
  public void setOAuth2AccessToken(String value) {
    this.oauth2AccessToken = value;
  }

  /**
   * The user name to authenticate as against the remote CRX system (Felix console).
   * Fallback to {@link #getUserId()} if not set.
   * @return User ID
   */
  public String getConsoleUserId() {
    return Objects.toString(this.consoleUserId, this.userId);
  }

  /**
   * @param consoleUserId The user name to authenticate as against the remote CRX system (Felix console).
   */
  public void setConsoleUserId(String consoleUserId) {
    this.consoleUserId = consoleUserId;
  }

  /**
   * The password to authenticate against the remote CRX system (Felix console).
   * Fallback to {@link #getPassword()} if not set.
   * @return Password
   */
  public String getConsolePassword() {
    return Objects.toString(this.consolePassword, this.password);
  }

  /**
   * @param consolePassword The password to authenticate against the remote CRX system (Felix console).
   */
  public void setConsolePassword(String consolePassword) {
    this.consolePassword = consolePassword;
  }

  /**
   * OAuth 2 access token to authenticate against the remote CRX system (Felix console).
   * If this is configured, username and password are ignored.
   * Fallback to {@link #getOAuth2AccessToken()} if not set.
   * @return OAuth 2 access token.
   */
  public String getConsoleOAuth2AccessToken() {
    return Objects.toString(this.consoleOauth2AccessToken, this.oauth2AccessToken);
  }

  /**
   * @param value OAuth 2 access token to authenticate against the remote CRX system (Felix console).
   */
  public void setConsoleOAuth2AccessToken(String value) {
    this.consoleOauth2AccessToken = value;
  }

  /**
   * Number of times to retry upload and install via CRX HTTP interface if it fails.
   * @return Retry count
   */
  public int getRetryCount() {
    return this.retryCount;
  }

  /**
   * @param retryCount Number of times to retry upload and install via CRX HTTP interface if it fails.
   */
  public void setRetryCount(int retryCount) {
    this.retryCount = retryCount;
  }

  /**
   * Number of seconds between retry attempts.
   * @return Retry delay
   */
  public int getRetryDelaySec() {
    return this.retryDelaySec;
  }

  /**
   * @param retryDelaySec Number of seconds between retry attempts.
   */
  public void setRetryDelaySec(int retryDelaySec) {
    this.retryDelaySec = retryDelaySec;
  }

  /**
   * Bundle status JSON URL. If an URL is configured the activation status of all bundles in the system is checked
   * before it is tried to upload and install a new package and after each upload.
   * If not all bundles are activated the upload is delayed up to {link #getBundleStatusWaitLimitSec()} seconds, every 5
   * seconds the activation status is checked anew.
   * Expected is an URL like: http://localhost:4502/system/console/bundles/.json
   * @return URL
   */
  public String getBundleStatusUrl() {
    return this.bundleStatusUrl;
  }

  /**
   * @param bundleStatusUrl Bundle status JSON URL
   */
  public void setBundleStatusUrl(String bundleStatusUrl) {
    this.bundleStatusUrl = bundleStatusUrl;
  }

  /**
   * Number of seconds to wait as maximum for a positive bundle status check.
   * If this limit is reached and the bundle status is still not positive the install of the package proceeds anyway.
   * @return Limit in seconds
   */
  public int getBundleStatusWaitLimitSec() {
    return this.bundleStatusWaitLimitSec;
  }

  /**
   * @param bundleStatusWaitLimitSec Number of seconds to wait as maximum for a positive bundle status
   */
  public void setBundleStatusWaitLimitSec(int bundleStatusWaitLimitSec) {
    this.bundleStatusWaitLimitSec = bundleStatusWaitLimitSec;
  }

  /**
   * Patterns for symbolic names of bundles that are expected to be not present in bundle list.
   * If any of these bundles are found in the bundle list, this system is assumed as not ready for installing further
   * packages because a previous installation (e.g. of AEM service pack) is still in progress.
   * @return List of regular expressions for symbolic bundle names.
   */
  public List<Pattern> getBundleStatusBlacklistBundleNames() {
    return this.bundleStatusBlacklistBundleNames;
  }

  /**
   * @param bundleStatusBlacklistBundleNames Patterns for symbolic names of bundles that are expected to be not present
   *          in bundle list
   */
  public void setBundleStatusBlacklistBundleNames(List<String> bundleStatusBlacklistBundleNames) {
    this.bundleStatusBlacklistBundleNames = bundleStatusBlacklistBundleNames.stream()
        .map(Pattern::compile)
        .collect(Collectors.toList());
  }

  /**
   * Patterns for symbolic names of bundles that are ignored in bundle list.
   * The state of these bundles has no effect on the bundle status check.
   * @return List of regular expressions for symbolic bundle names.
   */
  public List<Pattern> getBundleStatusWhitelistBundleNames() {
    return this.bundleStatusWhitelistBundleNames;
  }

  /**
   * @param bundleStatusWhitelistBundleNames Patterns for symbolic names of bundles that are ignored in bundle list
   */
  public void setBundleStatusWhitelistBundleNames(List<String> bundleStatusWhitelistBundleNames) {
    this.bundleStatusWhitelistBundleNames = bundleStatusWhitelistBundleNames.stream()
        .map(Pattern::compile)
        .collect(Collectors.toList());
  }

  /**
   * Package Manager installation status JSON URL. If an URL is configured the installation status of packages and
   * embedded packages is checked before it is tried to upload and install a new package and after each upload.
   * If not all packages are installed the upload is delayed up to {link #getPackageManagerInstallStatusWaitLimit()}
   * seconds, every 5 seconds the activation status is checked anew.
   * Expected is an URL like: http://localhost:4502/crx/packmgr/installstatus.jsp
   * @return URL
   */
  public String getPackageManagerInstallStatusURL() {
    return this.packageManagerInstallStatusURL;
  }

  /**
   * @param packageManagerInstallStatusURL Package Manager installation status JSON URL
   */
  public void setPackageManagerInstallStatusURL(String packageManagerInstallStatusURL) {
    this.packageManagerInstallStatusURL = packageManagerInstallStatusURL;
  }

  /**
   * Number of seconds to wait as maximum for a positive package manager install status check.
   * If this limit is reached and the packager manager install status is still not positive the install of the package
   * proceeds anyway.
   * @return Limit in seconds
   */
  public int getPackageManagerInstallStatusWaitLimitSec() {
    return this.packageManagerInstallStatusWaitLimitSec;
  }

  /**
   * @param packageManagerInstallStatusWaitLimitSec Number of seconds to wait as maximum for a positive package manager
   *          install status check
   */
  public void setPackageManagerInstallStatusWaitLimitSec(int packageManagerInstallStatusWaitLimitSec) {
    this.packageManagerInstallStatusWaitLimitSec = packageManagerInstallStatusWaitLimitSec;
  }

  /**
   * If set to true also self-signed certificates are accepted.
   * @return Relaced SSL check
   */
  public boolean isRelaxedSSLCheck() {
    return this.relaxedSSLCheck;
  }

  /**
   * @param relaxedSSLCheck If set to true also self-signed certificates are accepted
   */
  public void setRelaxedSSLCheck(boolean relaxedSSLCheck) {
    this.relaxedSSLCheck = relaxedSSLCheck;
  }

  /**
   * HTTP connection timeout (in seconds).
   * @return Timeout
   */
  public int getHttpConnectTimeoutSec() {
    return this.httpConnectTimeoutSec;
  }

  /**
   * @param httpConnectTimeoutSec HTTP connection timeout (in seconds)
   */
  public void setHttpConnectTimeoutSec(int httpConnectTimeoutSec) {
    this.httpConnectTimeoutSec = httpConnectTimeoutSec;
  }

  /**
   * HTTP socket timeout (in seconds).
   * @return Timeout
   */
  public int getHttpSocketTimeoutSec() {
    return this.httpSocketTimeoutSec;
  }

  /**
   * @param httpSocketTimeoutSec HTTP socket timeout (in seconds)
   */
  public void setHttpSocketTimeoutSec(int httpSocketTimeoutSec) {
    this.httpSocketTimeoutSec = httpSocketTimeoutSec;
  }

  /**
   * HTTP proxies from maven settings
   * @return List of proxies
   */
  public List<Proxy> getProxies() {
    return this.proxies;
  }

  /**
   * @param proxies HTTP proxies from maven settings
   */
  public void setProxies(List<Proxy> proxies) {
    this.proxies = proxies;
  }

  /**
   * Log level to be used to log responses from package manager (which may get huge for large packages).
   * @return Log level (DEBUG or INFO). Default is INFO.
   */
  public String getPackageManagerOutputLogLevel() {
    return this.packageManagerOutputLogLevel;
  }

  /**
   * @param packageManagerOutputLogLevel Log level to be used to log responses from package manager
   */
  public void setPackageManagerOutputLogLevel(String packageManagerOutputLogLevel) {
    this.packageManagerOutputLogLevel = packageManagerOutputLogLevel;
  }

}