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.ce.ComputeEngineSide; 027import org.sonar.api.server.ServerSide; 028 029/** 030 * @since 2.2 031 */ 032@BatchSide 033@ServerSide 034@ComputeEngineSide 035public abstract class Server { 036 037 public abstract String getId(); 038 039 public abstract String getVersion(); 040 041 public abstract Date getStartedAt(); 042 043 public abstract File getRootDir(); 044 045 @CheckForNull 046 public abstract File getDeployDir(); 047 048 public abstract String getContextPath(); 049 050 /** 051 * Return the public root url, for instance : https://nemo.sonarqube.org. 052 * Default value is {@link org.sonar.api.CoreProperties#SERVER_BASE_URL_DEFAULT_VALUE} 053 * 054 * @since 5.4 055 */ 056 public abstract String getPublicRootUrl(); 057 058 /** 059 * The dev mode is enabled when the property sonar.web.dev is true. 060 * 061 * @since 5.4 062 */ 063 public abstract boolean isDev(); 064 065 /** 066 * Return whether or not the {#getPublicRootUrl} is started with https. 067 * 068 * @since 5.4 069 */ 070 public abstract boolean isSecured(); 071 072 /** 073 * @return the server URL 074 * @since since 2.4 on batch side only, since 5.6 on both batch side and server side (WebServer and Compute Engine) 075 */ 076 public abstract String getURL(); 077 078 /** 079 * @since 2.10 080 */ 081 public abstract String getPermanentServerId(); 082}