jetbrains.buildServer.serverSide

Interface SPersistentEntity

All Known Subinterfaces:

BuildTypeIdentity, BuildTypeTemplate, RemoteBuildType, SBuildType, SProject, SVcsRoot

public interface SPersistentEntity

Represents an entity which configuration can be write to a configuration file.

Since:

8.0

Author:

Leonid Bushuev from JetBrains

Method Summary

Modifier and Type	Method and Description
java.lang.String	getConfigId() Returns the entity's config identifier.
java.io.File	getConfigurationFile() Returns the configuration file where this entity instance is persisted (or will be persisted to).
java.io.File	getConfigurationFile(java.io.File projectsDir) Returns the configuration file where this entity is persisted in custom projects directory
java.lang.String	getExternalId() Returns the external identifier.
java.lang.String	getName() Returns the name of the entity.
SPersistentEntity	getParent() The parent entity.
PersistentEntityVersion	getVersion() Returns version of this entity which can be used to check if the entity was edited or persisted.
void	markPersisted(long expectedEditId) Marks entity as persisted
void	persist() Persists this entity instance onto disk.
void	persist(ConfigAction cause) Persists this entity on disk.
void	remove() Removes this entity.
PersistTask	schedulePersisting(ConfigAction cause) Schedules background persisting of this project settings.
PersistTask	schedulePersisting(java.lang.String reason) Schedules background persisting of this entity settings.

Method Detail

getConfigId

@NotNull
java.lang.String getConfigId()

Returns the entity's config identifier. Config identifier uniquely identifies the entity across different TeamCity servers and can't be modified in contrast to external identifier.

Since:

9.0

getExternalId

@NotNull
java.lang.String getExternalId()

Returns the external identifier.

Returns:

the external identifier.

getName

java.lang.String getName()

Returns the name of the entity.

Returns:

see above.

persist

void persist()
      throws PersistFailedException

Persists this entity instance onto disk. Should be called each time when settings are changed, otherwise the changes will be lost after the server restart.

Throws:

PersistFailedException - if persisting failed

persist

void persist(@NotNull
             ConfigAction cause)
      throws PersistFailedException

Persists this entity on disk.

Parameters:

cause - an action which caused persisting

Throws:

PersistFailedException - if persisting failed

Since:

9.0

schedulePersisting

@NotNull
PersistTask schedulePersisting(@NotNull
                                        ConfigAction cause)
                                 throws PersistFailedException

Schedules background persisting of this project settings.

Parameters:

cause - an action which caused persisting

Returns:

a task which can be used to track the operation progress or wait for the operation to complete

Throws:

PersistFailedException - if failed to schedule the operation

Since:

2020.1

See Also:

schedulePersisting(String)

schedulePersisting

@NotNull
PersistTask schedulePersisting(@NotNull
                                        java.lang.String reason)
                                 throws PersistFailedException

Schedules background persisting of this entity settings.

Parameters:

reason - provides a reason why persist operation was called

Returns:

a task which can be used to track the operation progress or wait for the operation to complete

Throws:

PersistFailedException - if failed to schedule the operation

Since:

2020.1

See Also:

schedulePersisting(ConfigAction)

remove

void remove()

Removes this entity.

This method also makes all changes (related to removing the entity) on the disk and in the database. There is no need to call the persist() after this method.

Since:

8.0

getConfigurationFile

@NotNull
java.io.File getConfigurationFile()

Returns the configuration file where this entity instance is persisted (or will be persisted to).

Returns:

see above.

getConfigurationFile

@NotNull
java.io.File getConfigurationFile(@NotNull
                                           java.io.File projectsDir)

Returns the configuration file where this entity is persisted in custom projects directory

Parameters:

projectsDir - path to teamcity projects directory

Returns:

see above

getParent

@Nullable
SPersistentEntity getParent()

The parent entity.

Returns:

see above.

getVersion

@NotNull
PersistentEntityVersion getVersion()

Returns version of this entity which can be used to check if the entity was edited or persisted.

Returns:

see above

markPersisted

void markPersisted(long expectedEditId)

Marks entity as persisted

Parameters:

expectedEditId - expected editId in the end of persist. The entity will be marked as unedited if expected editId is the same as actual, ie. the entity wasn't edited while persist was running