jetbrains.buildServer.serverSide.artifacts
Interface BuildArtifacts


public interface BuildArtifacts

Provides API to access build artifacts with respect to permission checking and artifacts locking

Since:
6.5
Author:
Eugene Petrenko (eugene.petrenko@gmail.com) Date: 14.04.11 17:39

Nested Class Summary
static interface BuildArtifacts.BuildArtifactsProcessor
           
 
Method Summary
 BuildArtifactHolder findArtifact(java.lang.String relativePath)
          Returns artifact holder for requested artifact path.
 BuildArtifact getArtifact(java.lang.String relativePath)
          Returns artifact if is is available and you have enough rights to use it.
 BuildArtifact getRootArtifact()
           
 boolean isAvailable()
          Checks if build contains available artifacts
 void iterateArtifacts(BuildArtifacts.BuildArtifactsProcessor processor)
          Iterates among all build artifacts calling given processor for every new found artifact.
 

Method Detail

getArtifact

@Nullable
BuildArtifact getArtifact(@NotNull
                                   java.lang.String relativePath)
Returns artifact if is is available and you have enough rights to use it.

Parameters:
relativePath - path to artifact
Returns:
artifact info or null
Since:
6.5

findArtifact

@NotNull
BuildArtifactHolder findArtifact(@NotNull
                                         java.lang.String relativePath)
Returns artifact holder for requested artifact path. Use this method if you need detailed information on why you cannot see an artifact by given relative path

Parameters:
relativePath - relative path to find artifact
Returns:
artifact holder object representing an artifact, even if build have no such artifact or you do not have rights to see it
Since:
6.5

getRootArtifact

@NotNull
BuildArtifact getRootArtifact()
Returns:
root artifact directory item

isAvailable

boolean isAvailable()
Checks if build contains available artifacts

Returns:
true if there are some available artifacts
Since:
6.5

iterateArtifacts

void iterateArtifacts(@NotNull
                      BuildArtifacts.BuildArtifactsProcessor processor)
Iterates among all build artifacts calling given processor for every new found artifact. Iteration is done as depth-first search.

Artifacts are read-locked with ArtifactsGuard while processing files

Parameters:
processor - found artifacts processor
Since:
6.5