com.atlassian.bamboo.configuration.external

Interface RepositoryStoredSpecsLogService

All Known Implementing Classes:

RepositoryStoredSpecsLogServiceImpl

public interface RepositoryStoredSpecsLogService

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	RepositoryStoredSpecsLogService.RepositoryStoredSpecsLogAccessor

Method Summary

Modifier and Type	Method and Description
Path	createBambooSpecLogFile(long repositoryId, String logFilename) Create log file for Bamboo Specs execution.
String	generateFileName(List<? extends CommitContext> commits) Generate log file name
String	generateSpecsLogsUrl(long repositoryId, String logFilename, String referrer)
RepositoryStoredSpecsLogService.RepositoryStoredSpecsLogAccessor	getBambooSpecsExecutionLogAccessor(PlanResultKey planResultKey) Provides log file accessor for build result.
Path	getBambooSpecsExecutionLogFile(long repositoryId, String changesetId)
Path	getBambooSpecsExecutionLogFile(PlanResultKey planResultKey)
Path	getBambooSpecsExecutionLogFile(VcsLocationBambooSpecsState bambooSpecsState)
String	getChangeSetForFilename(List<? extends CommitContext> commits)

Method Detail

generateFileName

String generateFileName(@NotNull
                        List<? extends CommitContext> commits)

Generate log file name

Parameters:

commits - associated with Bamboo Specs processing

Returns:

createBambooSpecLogFile

Path createBambooSpecLogFile(long repositoryId,
                             @NotNull
                             String logFilename)
                      throws IOException

Create log file for Bamboo Specs execution.

Parameters:

repositoryId - root repository id

logFilename - log file name

Throws:

IOException - if can't create Bamboo Specs log folder

getBambooSpecsExecutionLogAccessor

@Nullable
RepositoryStoredSpecsLogService.RepositoryStoredSpecsLogAccessor getBambooSpecsExecutionLogAccessor(@NotNull
                                                                                                              PlanResultKey planResultKey)

Provides log file accessor for build result.

Parameters:

planResultKey - result key

Returns:

file accessor if result key is linked to Bamboo Specs execution.

getBambooSpecsExecutionLogFile

@Nullable
Path getBambooSpecsExecutionLogFile(@NotNull
                                              PlanResultKey planResultKey)
                                       throws IllegalStateException

Parameters:

planResultKey - result key

Returns:

log file if result key is linked to Bamboo Specs execution

Throws:

IllegalStateException - if plan result doesn't have associated commits

getBambooSpecsExecutionLogFile

@Nullable
Path getBambooSpecsExecutionLogFile(long repositoryId,
                                              @NotNull
                                              String changesetId)

Parameters:

repositoryId - id of Bamboo repository

changesetId - changeset id

Returns:

log file if the changeset in the repository is linked to Bamboo Specs execution failure

getBambooSpecsExecutionLogFile

@Nullable
Path getBambooSpecsExecutionLogFile(@NotNull
                                              VcsLocationBambooSpecsState bambooSpecsState)

Returns:

log file

getChangeSetForFilename

@NotNull
String getChangeSetForFilename(@NotNull
                                        List<? extends CommitContext> commits)

Returns:

commit which might be used for log filename.

generateSpecsLogsUrl

String generateSpecsLogsUrl(long repositoryId,
                            @NotNull
                            String logFilename,
                            @Nullable
                            String referrer)

Returns:

relative URL for Bamboo Specs execution log file