Interface PluginsRepository
-
- All Known Implementing Classes:
PluginsRepositoryImpl
public interface PluginsRepository
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static classPluginsRepository.PluginModel
-
Field Summary
Fields Modifier and Type Field Description static StringPLUGINS_REPOSITORY_ENABLEstatic StringPLUGINS_REPOSITORY_UPDATES_CHECK_INTERVALstatic StringPLUGINS_REPOSITORY_URL
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidcheckPluginUpdates(boolean force)booleancheckUpdatesEnabled()PluginsRepository.PluginModelgetPluginInfo(String id, String updateId)StringgetServerBuildNumber()StringgetServerLicensingMode()StringgetServerUrl()StringgetServerUUID()List<PluginsRepository.PluginModel>getUpdatedPlugins()voidinstallPlugin(File pluginArchiveFile, String pluginArchiveName, PluginSignatureVerifier.CertificateType certificateType)Installs a plugin from a plugin archive file with the specified archive name.voidinstallPlugin(String downloadUrl)booleanisEnabled()voidsetCheckUpdates(boolean checkUpdates)
-
-
-
Field Detail
-
PLUGINS_REPOSITORY_ENABLE
static final String PLUGINS_REPOSITORY_ENABLE
- See Also:
- Constant Field Values
-
PLUGINS_REPOSITORY_URL
static final String PLUGINS_REPOSITORY_URL
- See Also:
- Constant Field Values
-
PLUGINS_REPOSITORY_UPDATES_CHECK_INTERVAL
static final String PLUGINS_REPOSITORY_UPDATES_CHECK_INTERVAL
- See Also:
- Constant Field Values
-
-
Method Detail
-
isEnabled
boolean isEnabled()
-
getServerUrl
@NotNull String getServerUrl()
-
getServerUUID
@Nullable String getServerUUID()
-
getServerBuildNumber
@NotNull String getServerBuildNumber()
-
getServerLicensingMode
@NotNull String getServerLicensingMode()
-
getPluginInfo
@NotNull PluginsRepository.PluginModel getPluginInfo(@NotNull String id, @NotNull String updateId) throws Exception
- Throws:
Exception
-
installPlugin
void installPlugin(@NotNull File pluginArchiveFile, @NotNull String pluginArchiveName, @NotNull PluginSignatureVerifier.CertificateType certificateType) throws IOExceptionInstalls a plugin from a plugin archive file with the specified archive name.- Parameters:
pluginArchiveFile- The file object representing the plugin archive file.pluginArchiveName- The name of the plugin archive (this name will be used in TeamCity's plugins/ directory).certificateType-- Throws:
IOException- If an I/O error occurs during the installation process.
-
checkUpdatesEnabled
boolean checkUpdatesEnabled()
-
setCheckUpdates
void setCheckUpdates(boolean checkUpdates)
-
checkPluginUpdates
void checkPluginUpdates(boolean force)
- Parameters:
force- if true, plugin list will be re-checked even if getUpdatedPlugins() returns empty list
-
getUpdatedPlugins
@NotNull List<PluginsRepository.PluginModel> getUpdatedPlugins()
-
-