Package jetbrains.buildServer.serverSide.impl.persisting.projects

Class ProjectPersistTask

java.lang.Object

jetbrains.buildServer.serverSide.impl.persisting.BasePersistTask

jetbrains.buildServer.serverSide.impl.persisting.projects.ProjectPersistTask

All Implemented Interfaces:

PersistTaskEx, BackgroundPersistTask, PersistTask

public class ProjectPersistTask
extends BasePersistTask
implements BackgroundPersistTask

Method Summary

Modifier and Type	Method	Description
void	addError(Exception error)
boolean	affects(SPersistentEntity entity)
boolean	affectsProject(SProject project)
boolean	canBeInterrupted()
void	cancel()	Marks task as canceled, canceled task will not be executed on configs directory.
void	delete(SPersistentEntity entity)	Marks config files of the specified entity for deletion.
void	delete(SProject project, String path)	Marks a config file of the specified project for deletion.
Collection<SPersistentEntity>	getAffectedEntities()
Set<String>	getAffectedProjectExtIds()
Set<SProject>	getAffectedProjects()
ConfigAction	getCause()
String	getDescription()	Returns task description.
Throwable	getError()	Returns an error thrown by fs operation or null if there was no errors.
List<Throwable>	getErrors()	Returns errors thrown during background task execution.
String	getOriginNodeId()
Set<String>	getSavedPaths()
User	getUser()
boolean	isCanceled()
boolean	isComplete()
void	logChangesToAudit()
void	markAsFinished()
void	onRemoveFromQueue()
void	run()
void	setComplete()	Marks task as complete meaning that all desired changes were provided to the task.
void	setContent(SPersistentEntity entity, byte[] content)	Sets file content to be persisted.
void	setContent(SProject project, String path, byte[] content)	Sets file content to be persisted.

Methods inherited from class jetbrains.buildServer.serverSide.impl.persisting.BasePersistTask

await, await, awaitForStage, compareAndSetStage, equals, getCreationTime, getId, getStage, hashCode, isAddedToQueueInsideAnotherTask, markAsUpdated, rethrowError, setAddedToQueueInsideAnotherTask, setStage, toString, updateStage

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface jetbrains.buildServer.serverSide.PersistTask

await, await, awaitUninterruptibly, getId, getStage

Methods inherited from interface jetbrains.buildServer.serverSide.impl.persisting.PersistTaskEx

getFileWatcher, notifyFileWatcher

Method Detail

setContent

public void setContent(@NotNull
                       SPersistentEntity entity,
                       @NotNull
                       byte[] content)
                throws IOException

Description copied from interface: BackgroundPersistTask

Sets file content to be persisted.

Specified by:

setContent in interface BackgroundPersistTask

Parameters:

entity - entity which content is persisted

content - content to persist

Throws:

IOException - when task failed to save the content in task dir

setContent

public void setContent(@NotNull
                       SProject project,
                       @NotNull
                       String path,
                       @NotNull
                       byte[] content)
                throws IOException

Description copied from interface: BackgroundPersistTask

Sets file content to be persisted. Should be used for paths which don't depend on external ids.

Specified by:

setContent in interface BackgroundPersistTask

Parameters:

project - project within which content should be persisted

path - path relative to project root directory

content - content to persist

Throws:

IOException - when task failed to save the content in task dir

markAsFinished

public void markAsFinished()

Specified by:

markAsFinished in interface PersistTaskEx

delete

public void delete(@NotNull
                   SPersistentEntity entity)
            throws UncheckedIOException

Description copied from interface: BackgroundPersistTask

Marks config files of the specified entity for deletion.

Specified by:

delete in interface BackgroundPersistTask

Parameters:

entity - entity of interest

Throws:

UncheckedIOException

delete

public void delete(@NotNull
                   SProject project,
                   @NotNull
                   String path)
            throws UncheckedIOException,
                   IOException

Description copied from interface: BackgroundPersistTask

Marks a config file of the specified project for deletion.

Specified by:

delete in interface BackgroundPersistTask

Parameters:

project - whose file should be removed

path - path to the file

Throws:

UncheckedIOException

IOException

getUser

public User getUser()

Specified by:

getUser in interface PersistTaskEx

setComplete

public void setComplete()

Description copied from interface: BackgroundPersistTask

Marks task as complete meaning that all desired changes were provided to the task. Changes made after setComplete() call will lead to exception.

Specified by:

setComplete in interface BackgroundPersistTask

isComplete

public boolean isComplete()

cancel

public void cancel()

Description copied from interface: BackgroundPersistTask

Marks task as canceled, canceled task will not be executed on configs directory.

Specified by:

cancel in interface BackgroundPersistTask

isCanceled

public boolean isCanceled()

Specified by:

isCanceled in interface PersistTaskEx

addError

public void addError(@NotNull
                     Exception error)

Specified by:

addError in interface PersistTaskEx

run

public void run()

Specified by:

run in interface PersistTaskEx

onRemoveFromQueue

public void onRemoveFromQueue()

Specified by:

onRemoveFromQueue in interface PersistTaskEx

canBeInterrupted

public boolean canBeInterrupted()

Specified by:

canBeInterrupted in interface PersistTaskEx

getDescription

@NotNull
public String getDescription()

Description copied from interface: PersistTask

Returns task description.

Specified by:

getDescription in interface PersistTask

Returns:

task description

getError

@Nullable
public Throwable getError()

Description copied from interface: PersistTask

Returns an error thrown by fs operation or null if there was no errors.

Specified by:

getError in interface PersistTask

Returns:

an error thrown by fs operation or null if there was no errors

getErrors

@NotNull
public List<Throwable> getErrors()

Description copied from interface: BackgroundPersistTask

Returns errors thrown during background task execution.

Specified by:

getErrors in interface BackgroundPersistTask

Returns:

errors thrown during background task execution

getCause

@NotNull
public ConfigAction getCause()

Specified by:

getCause in interface BackgroundPersistTask

getAffectedEntities

@NotNull
public Collection<SPersistentEntity> getAffectedEntities()

Specified by:

getAffectedEntities in interface BackgroundPersistTask

getAffectedProjects

@NotNull
public Set<SProject> getAffectedProjects()

Specified by:

getAffectedProjects in interface BackgroundPersistTask

getAffectedProjectExtIds

@NotNull
public Set<String> getAffectedProjectExtIds()

Specified by:

getAffectedProjectExtIds in interface BackgroundPersistTask

affects

public boolean affects(@NotNull
                       SPersistentEntity entity)

Specified by:

affects in interface BackgroundPersistTask

affectsProject

public boolean affectsProject(@NotNull
                              SProject project)

Specified by:

affectsProject in interface BackgroundPersistTask

getOriginNodeId

@NotNull
public String getOriginNodeId()

Specified by:

getOriginNodeId in interface BackgroundPersistTask

getSavedPaths

@NotNull
public Set<String> getSavedPaths()

Specified by:

getSavedPaths in interface BackgroundPersistTask

logChangesToAudit

public void logChangesToAudit()