com.github.rodm.teamcity

Class ServerPluginConfiguration

java.lang.Object

com.github.rodm.teamcity.PluginConfiguration

com.github.rodm.teamcity.ServerPluginConfiguration

All Implemented Interfaces:

TeamCityEnvironments

public class ServerPluginConfiguration
extends PluginConfiguration
implements TeamCityEnvironments

Server-side plugin configuration

Field Summary

Fields inherited from interface com.github.rodm.teamcity.TeamCityEnvironments

Docker, Local

Constructor Summary

Constructors

Constructor and Description
ServerPluginConfiguration(org.gradle.api.Project project, TeamCityEnvironments environments)

Method Summary

Modifier and Type	Method and Description
LocalTeamCityEnvironment	create(java.lang.String name, org.gradle.api.Action<LocalTeamCityEnvironment> action)
<T extends TeamCityEnvironment> T	create(java.lang.String name, java.lang.Class<T> type, org.gradle.api.Action<? super T> action)
void	descriptor(org.gradle.api.Action<ServerPluginDescriptor> configuration) Configures the server-side plugin descriptor for the TeamCity plugin.
void	environments(org.gradle.api.Action<TeamCityEnvironments> configuration)
java.lang.String	getBaseDataDir() The base data directory used to store TeamCity configurations.
java.lang.String	getBaseDownloadUrl() The base download URL used to download TeamCity distributions.
java.lang.String	getBaseHomeDir() The base home directory used to install TeamCity distributions.
TeamCityEnvironment	getByName(java.lang.String name)
java.lang.String	getDownloadsDir() The downloads directory that TeamCity distributions are saved to by the download task.
PublishConfiguration	getPublish()
SignConfiguration	getSign()
org.gradle.api.file.ConfigurableFileCollection	getWeb()
org.gradle.api.NamedDomainObjectProvider<TeamCityEnvironment>	named(java.lang.String name)
void	publish(org.gradle.api.Action<PublishConfiguration> configuration) Configures the credentials to publish the plugin to the JetBrains Plugin Repository.
org.gradle.api.NamedDomainObjectProvider<LocalTeamCityEnvironment>	register(java.lang.String name, org.gradle.api.Action<LocalTeamCityEnvironment> action)
<T extends TeamCityEnvironment> org.gradle.api.NamedDomainObjectProvider<T>	register(java.lang.String name, java.lang.Class<T> type, org.gradle.api.Action<? super T> action)
<T extends TeamCityEnvironment> void	registerFactory(java.lang.Class<T> type, org.gradle.api.NamedDomainObjectFactory<T> factory)
void	setBaseDataDir(java.io.File baseDataDir)
void	setBaseDataDir(java.lang.String baseDataDir)
void	setBaseDownloadUrl(java.lang.String baseDownloadUrl)
void	setBaseHomeDir(java.io.File baseHomeDir)
void	setBaseHomeDir(java.lang.String baseHomeDir)
void	setDownloadsDir(java.lang.String downloadsDir)
void	setWeb(java.lang.Object web)
void	sign(org.gradle.api.Action<SignConfiguration> configuration)
void	web(java.lang.Object web)

Methods inherited from class com.github.rodm.teamcity.PluginConfiguration

files, getArchiveName, getDescriptor, getDescriptorFile, getFiles, getTokens, setArchiveName, setDescriptor, setTokens, tokens

Methods inherited from class java.lang.Object

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

Constructor Detail

ServerPluginConfiguration

public ServerPluginConfiguration(org.gradle.api.Project project,
                                 TeamCityEnvironments environments)

Method Detail

descriptor

public void descriptor(org.gradle.api.Action<ServerPluginDescriptor> configuration)

Configures the server-side plugin descriptor for the TeamCity plugin.

The given action is executed to configure the server-side plugin descriptor.

Parameters:

configuration - The action.

getWeb

public org.gradle.api.file.ConfigurableFileCollection getWeb()

setWeb

public void setWeb(java.lang.Object web)

web

public void web(java.lang.Object web)

publish

public void publish(org.gradle.api.Action<PublishConfiguration> configuration)

Configures the credentials to publish the plugin to the JetBrains Plugin Repository.

The given action is executed to configure the publishing credentials.

Parameters:

configuration - The action.

getPublish

public PublishConfiguration getPublish()

sign

public void sign(org.gradle.api.Action<SignConfiguration> configuration)

getSign

public SignConfiguration getSign()

setDownloadsDir

public void setDownloadsDir(java.lang.String downloadsDir)

Specified by:

setDownloadsDir in interface TeamCityEnvironments

getDownloadsDir

public java.lang.String getDownloadsDir()

Description copied from interface: TeamCityEnvironments

The downloads directory that TeamCity distributions are saved to by the download task. Defaults to "downloads".

Specified by:

getDownloadsDir in interface TeamCityEnvironments

Returns:

the downloads directory

setBaseDownloadUrl

public void setBaseDownloadUrl(java.lang.String baseDownloadUrl)

Specified by:

setBaseDownloadUrl in interface TeamCityEnvironments

getBaseDownloadUrl

public java.lang.String getBaseDownloadUrl()

Description copied from interface: TeamCityEnvironments

The base download URL used to download TeamCity distributions. Defaults to "https://download.jetbrains.com/teamcity"

Specified by:

getBaseDownloadUrl in interface TeamCityEnvironments

Returns:

the base download URL

setBaseHomeDir

public void setBaseHomeDir(java.lang.String baseHomeDir)

Specified by:

setBaseHomeDir in interface TeamCityEnvironments

setBaseHomeDir

public void setBaseHomeDir(java.io.File baseHomeDir)

Specified by:

setBaseHomeDir in interface TeamCityEnvironments

getBaseHomeDir

public java.lang.String getBaseHomeDir()

Description copied from interface: TeamCityEnvironments

The base home directory used to install TeamCity distributions. Defaults to "servers"

Specified by:

getBaseHomeDir in interface TeamCityEnvironments

Returns:

the base directory

setBaseDataDir

public void setBaseDataDir(java.lang.String baseDataDir)

Specified by:

setBaseDataDir in interface TeamCityEnvironments

setBaseDataDir

public void setBaseDataDir(java.io.File baseDataDir)

Specified by:

setBaseDataDir in interface TeamCityEnvironments

getBaseDataDir

public java.lang.String getBaseDataDir()

Description copied from interface: TeamCityEnvironments

The base data directory used to store TeamCity configurations. Defaults to "data"

Specified by:

getBaseDataDir in interface TeamCityEnvironments

Returns:

the base data directory

environments

public void environments(org.gradle.api.Action<TeamCityEnvironments> configuration)

getByName

public TeamCityEnvironment getByName(java.lang.String name)

Specified by:

getByName in interface TeamCityEnvironments

named

public org.gradle.api.NamedDomainObjectProvider<TeamCityEnvironment> named(java.lang.String name)

Specified by:

named in interface TeamCityEnvironments

create

public LocalTeamCityEnvironment create(java.lang.String name,
                                       org.gradle.api.Action<LocalTeamCityEnvironment> action)

Specified by:

create in interface TeamCityEnvironments

register

public org.gradle.api.NamedDomainObjectProvider<LocalTeamCityEnvironment> register(java.lang.String name,
                                                                                   org.gradle.api.Action<LocalTeamCityEnvironment> action)

Specified by:

register in interface TeamCityEnvironments

create

public <T extends TeamCityEnvironment> T create(java.lang.String name,
                                                java.lang.Class<T> type,
                                                org.gradle.api.Action<? super T> action)
                                         throws org.gradle.api.InvalidUserDataException

Specified by:

create in interface TeamCityEnvironments

Throws:

org.gradle.api.InvalidUserDataException

register

public <T extends TeamCityEnvironment> org.gradle.api.NamedDomainObjectProvider<T> register(java.lang.String name,
                                                                                            java.lang.Class<T> type,
                                                                                            org.gradle.api.Action<? super T> action)
                                                                                     throws org.gradle.api.InvalidUserDataException

Specified by:

register in interface TeamCityEnvironments

Throws:

org.gradle.api.InvalidUserDataException

registerFactory

public <T extends TeamCityEnvironment> void registerFactory(java.lang.Class<T> type,
                                                            org.gradle.api.NamedDomainObjectFactory<T> factory)

Specified by:

registerFactory in interface TeamCityEnvironments