Package jetbrains.buildServer.agent.impl.directories

Interface DirectoryMap

All Known Implementing Classes:

DirectoryMapImpl

public interface DirectoryMap

Since:

6.5

Author:

Eugene Petrenko (eugene.petrenko@gmail.com)

Method Summary

Modifier and Type	Method	Description
Map<File,Date>	getRegisteredRemovableItems()	This method returns map of all allocated checkout directories with last use time.
Map<File,Date>	getRegisteredRemovableItems(AgentRunningBuild runningBuild)	This method returns map of all allocated checkout directories with last use time.
boolean	removeCheckoutDirectory(File checkoutDirectory)	This method is called to request DirectoryMap to remove specified checkout folder.
boolean	removeCheckoutDirectory(AgentRunningBuild runningBuild, File checkoutDirectory)	This method is called to request DirectoryMap to remove specified checkout folder.
void	updateDirectoryMapOnBuild(AgentRunningBuild runningBuild)	Updates information for the running build.

Method Detail

updateDirectoryMapOnBuild

void updateDirectoryMapOnBuild(@NotNull
                               AgentRunningBuild runningBuild)

Updates information for the running build.

Parameters:

runningBuild -

getRegisteredRemovableItems

@NotNull
Map<File,Date> getRegisteredRemovableItems(@NotNull
                                                 AgentRunningBuild runningBuild)

This method returns map of all allocated checkout directories with last use time. The map should not contain any directories associated with currently running build.

Parameters:

runningBuild - current running build to filter results

Returns:

map of all registered folders to remove to last use time

Since:

7.1

removeCheckoutDirectory

boolean removeCheckoutDirectory(@NotNull
                                AgentRunningBuild runningBuild,
                                @NotNull
                                File checkoutDirectory)

This method is called to request DirectoryMap to remove specified checkout folder. The folder may not be removed if it used by currently running build or DirectoryLifetime denies it.

Parameters:

runningBuild - currently running build

checkoutDirectory - checkout directory to remove

Returns:

true iff checkout directory was removed

Since:

7.1

removeCheckoutDirectory

boolean removeCheckoutDirectory(@NotNull
                                File checkoutDirectory)

This method is called to request DirectoryMap to remove specified checkout folder. The folder may not be removed if DirectoryLifeTime denies it.

Parameters:

checkoutDirectory - checkout directory to remove

Returns:

true if checkout directory was removed

Since:

2018.2

getRegisteredRemovableItems

@NotNull
Map<File,Date> getRegisteredRemovableItems()

This method returns map of all allocated checkout directories with last use time.

Returns:

map of all registered folders to remove to last use time

Since:

2018.2