org.sonar.api.platform

Class Server

java.lang.Object

org.sonar.api.platform.Server

@ScannerSide
 @ServerSide
 @ComputeEngineSide
public abstract class Server
extends Object

Runtime information about server

Since:

2.2

Constructor Summary

Constructors

Constructor and Description
Server()

Method Summary

Modifier and Type	Method and Description
abstract String	getContextPath() Context path of web server.
abstract File	getDeployDir() Deprecated. always null since version 6.0. No alternatives, as plugins do not have to touch this directory.
abstract String	getId() Name is misleading, this is an UUID generated at each startup, so it changes if server is restarted.
abstract String	getPermanentServerId() UUID generated on demand by system administrators.
abstract String	getPublicRootUrl() Return the public root url, for instance : https://nemo.sonarqube.org.
abstract File	getRootDir() Deprecated. in 6.0. Replaced by ServerFileSystem.getHomeDir()
abstract Date	getStartedAt() Date when server started.
abstract String	getURL()
abstract String	getVersion() Non-null version of SonarQube at runtime
abstract boolean	isDev() The dev mode is enabled when the property sonar.web.dev is true.
abstract boolean	isSecured() Deprecated. since 5.6, use instead HttpServletRequest.getHeader(String) and check that X-Forwarded-Proto header is set to "https".

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Server

public Server()

Method Detail

getId

public abstract String getId()

Name is misleading, this is an UUID generated at each startup, so it changes if server is restarted. In the context of cluster, the value is shared by all the nodes.

Returns:

a non-null UUID. Format can change over versions.

getPermanentServerId

@CheckForNull
public abstract String getPermanentServerId()

UUID generated on demand by system administrators. It is null by default on fresh installations. When defined, value does not change when server is restarted. In the context of cluster, value is the same on all nodes.

Since:

2.10

getVersion

public abstract String getVersion()

Non-null version of SonarQube at runtime

getStartedAt

public abstract Date getStartedAt()

Date when server started. In the context of cluster, this is the date of the startup of the first node. Value is the same on all cluster nodes.

getRootDir

@Deprecated
public abstract File getRootDir()

Deprecated. in 6.0. Replaced by ServerFileSystem.getHomeDir()

Returns:

an existing directory in server and CE environments, null in scanner.

getDeployDir

@Deprecated
 @CheckForNull
public abstract File getDeployDir()

Deprecated. always null since version 6.0. No alternatives, as plugins do not have to touch this directory.

getContextPath

public abstract String getContextPath()

Context path of web server. Value is blank "" by default. When defined by the property sonar.web.context of conf/sonar.properties, then value starts but does not end with slash '/', for instance "/sonarqube".

Returns:

non-null but possibly blank path

getPublicRootUrl

public abstract String getPublicRootUrl()

Return the public root url, for instance : https://nemo.sonarqube.org. Default value is CoreProperties.SERVER_BASE_URL_DEFAULT_VALUE

Since:

5.4

isDev

public abstract boolean isDev()

The dev mode is enabled when the property sonar.web.dev is true.

Since:

5.4

isSecured

@Deprecated
public abstract boolean isSecured()

Deprecated. since 5.6, use instead HttpServletRequest.getHeader(String) and check that X-Forwarded-Proto header is set to "https".

Return whether or not the {#getPublicRootUrl} is started with https.

Since:

5.4

getURL

public abstract String getURL()

Returns:

the server URL

Since:

since 2.4 on batch side only, since 5.6 on both batch side and server side (WebServer and Compute Engine)