001/*
002 * SonarQube
003 * Copyright (C) 2009-2016 SonarSource SA
004 * mailto:contact AT sonarsource DOT com
005 *
006 * This program is free software; you can redistribute it and/or
007 * modify it under the terms of the GNU Lesser General Public
008 * License as published by the Free Software Foundation; either
009 * version 3 of the License, or (at your option) any later version.
010 *
011 * This program is distributed in the hope that it will be useful,
012 * but WITHOUT ANY WARRANTY; without even the implied warranty of
013 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014 * Lesser General Public License for more details.
015 *
016 * You should have received a copy of the GNU Lesser General Public License
017 * along with this program; if not, write to the Free Software Foundation,
018 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
019 */
020package org.sonar.api.platform;
021
022import java.io.File;
023import java.util.Date;
024import javax.annotation.CheckForNull;
025import org.sonar.api.batch.BatchSide;
026import org.sonar.api.server.ServerSide;
027
028/**
029 * @since 2.2
030  */
031@BatchSide
032@ServerSide
033public abstract class Server {
034
035  public abstract String getId();
036
037  public abstract String getVersion();
038
039  public abstract Date getStartedAt();
040
041  public abstract File getRootDir();
042
043  @CheckForNull
044  public abstract File getDeployDir();
045
046  /**
047   * @deprecated in 5.4. Web context path can not be configured. It's always {@code ""}. See https://jira.sonarsource.com/browse/SONAR-7122
048   */
049  @Deprecated
050  public abstract String getContextPath();
051
052  /**
053   * Return the public root url, for instance : https://nemo.sonarqube.org.
054   * Default value is {@link org.sonar.api.CoreProperties#SERVER_BASE_URL_DEFAULT_VALUE}
055   *
056   * @since 5.4
057   */
058  public abstract String getPublicRootUrl();
059
060  /**
061   * The dev mode is enabled when the property sonar.web.dev is true.
062   *
063   * @since 5.4
064   */
065  public abstract boolean isDev();
066
067  /**
068   * Return whether or not the {#getPublicRootUrl} is started with https.
069   *
070   * @since 5.4
071   */
072  public abstract boolean isSecured();
073
074  /**
075   * @return the server URL when executed from batch, else null.
076   * @since 2.4
077   */
078  public abstract String getURL();
079
080  /**
081   * @since 2.10
082   */
083  public abstract String getPermanentServerId();
084}