Package com.atlassian.bamboo.author
Interface ExtendedAuthorManager
- All Superinterfaces:
AuthorManager
- All Known Implementing Classes:
HibernateAuthorManagerImpl
-
Method Summary
Modifier and TypeMethodDescriptionvoidcreateAndSaveAuthor(@NotNull Author author) Creates and saves author given author, if bamboo user with the same username exists the new author will be linked to that user.findAuthorsByName(@NotNull String authorSearchString) Performs a case insensitive search for authors by their author name.findAuthorsByUser(@NotNull String userSearchString) Performs a case insensitive search for authors by their linkedUserName.findAuthorsThatStartWith(@NotNull String authorSearchString, boolean unlinkedOnly) Performs a case insensitive search for authors by their author name.@NotNull List<ResultsSummary> findBuildResultsBrokenByAuthor(ExtendedAuthor author, int maxResultCount) @NotNull List<ResultsSummary> findBuildResultsFailedByAuthor(ExtendedAuthor author, int maxResultCount) @NotNull List<ResultsSummary> findBuildResultsFixedByAuthor(ExtendedAuthor author, int maxResultCount) @NotNull List<ResultsSummary> findBuildResultsSuccessfulByAuthor(ExtendedAuthor author, int maxResultCount) @NotNull List<ResultsSummary> findBuildResultsTriggeredByAuthor(ExtendedAuthor author, int maxResultCount) @NotNull Collection<ResultsSummary> Retrieves the last build broken by author for all the plans.intintintintintfindRecentResultsTriggeredByAuthors(List<ExtendedAuthor> author, int maxDays) Retrieve all build results triggered by the author in the last X days@NotNull Set<ExtendedAuthor> getAuthorById(long id) getAuthorsByResultSummary(@NotNull ResultsSummary resultsSummary) Retrieve unique set of authors that contributed to commits related to a given ResultsSummary@NotNull List<ExtendedAuthor> getAvailableAuthors(@Nullable com.atlassian.user.User user) Get authors available for a user.Get Author information by author name.@NotNull List<ExtendedAuthor> getLinkedAuthorForUser(com.atlassian.user.User user) voidAttempt to link any authors that currently aren't linked with a user.voidremoveAuthor(ExtendedAuthor extendedAuthor) removes an authorvoidsaveAuthor(ExtendedAuthor author) Save the authorvoidRemove all author links.Methods inherited from interface com.atlassian.bamboo.author.AuthorManager
getAllAuthors, getAuthorByName
-
Method Details
-
getAllUnlinkedAuthors
- Returns:
SetofExtendedAuthorobjects not linked to users
-
unlinkAllAuthors
void unlinkAllAuthors()Remove all author links. Useful if you have changed user management systems -
relinkUnlinkedAuthors
void relinkUnlinkedAuthors()Attempt to link any authors that currently aren't linked with a user. Currently only checks for direct author/username matches -
getExtendedAuthorByName
Get Author information by author name. Author names in DB are kept trimmed, make sure that name param is trimmed as well- Parameters:
name- trimmed author name- Returns:
ExtendedAuthorwith given name (assuming unique)
-
saveAuthor
Save the author- Parameters:
author-
-
findBuildResultsTriggeredByAuthor
@NotNull @NotNull List<ResultsSummary> findBuildResultsTriggeredByAuthor(ExtendedAuthor author, int maxResultCount) - Parameters:
author-maxResultCount- if <= 0 all the results are returned- Returns:
ListofBuildResultsSummarytriggered by author
-
findRecentResultsTriggeredByAuthors
Retrieve all build results triggered by the author in the last X days- Parameters:
author- the builds will be triggered bymaxDays- number of days to look back in history- Returns:
- all build results triggered by the author in the last X days
-
findBuildResultsFailedByAuthor
@NotNull @NotNull List<ResultsSummary> findBuildResultsFailedByAuthor(ExtendedAuthor author, int maxResultCount) - Parameters:
author-maxResultCount- if <= 0 all the results are returned- Returns:
ListofBuildResultsSummarytriggered by author and failed
-
findBuildResultsSuccessfulByAuthor
@NotNull @NotNull List<ResultsSummary> findBuildResultsSuccessfulByAuthor(ExtendedAuthor author, int maxResultCount) - Parameters:
author-maxResultCount- if <= 0 all the results are returned- Returns:
ListofBuildResultsSummarytriggered by author and successful
-
findBuildResultsBrokenByAuthor
@NotNull @NotNull List<ResultsSummary> findBuildResultsBrokenByAuthor(ExtendedAuthor author, int maxResultCount) - Parameters:
author-maxResultCount- if <= 0 all the results are returned- Returns:
ListofBuildResultsSummarybroken by author
-
findLatestBuildBrokenByAuthorInEachPlan
@NotNull @NotNull Collection<ResultsSummary> findLatestBuildBrokenByAuthorInEachPlan(ExtendedAuthor author) Retrieves the last build broken by author for all the plans.- Parameters:
author-- Returns:
ListofBuildResultsSummarybroken by author
-
findBuildResultsFixedByAuthor
@NotNull @NotNull List<ResultsSummary> findBuildResultsFixedByAuthor(ExtendedAuthor author, int maxResultCount) - Parameters:
author-maxResultCount- if <= 0 all the results are returned- Returns:
ListofBuildResultsSummaryfixed by author
-
findNumberOfBuildsTriggeredByAuthor
- Parameters:
author-- Returns:
- int
-
findNumberOfFailedBuildsByAuthor
- Parameters:
author-- Returns:
- int
-
findNumberOfSuccessfulBuildsByAuthor
- Parameters:
author-- Returns:
- int
-
findNumberOfBuildFixedByAuthor
- Parameters:
author-- Returns:
- int
-
findNumberOfBuildBrokenByAuthor
- Parameters:
author-- Returns:
- int
-
getAuthorById
- Parameters:
id-- Returns:
Authorgiven id
-
getLinkedAuthorForUser
- Parameters:
user-- Returns:
ListofExtendedAuthorlinked to the user.
-
getAvailableAuthors
@NotNull @NotNull List<ExtendedAuthor> getAvailableAuthors(@Nullable @Nullable com.atlassian.user.User user) Get authors available for a user. That includes all authors user is linked to and all unlinked authors.- Parameters:
user- user- Returns:
- List of
ExtendedAuthor
-
removeAuthor
removes an author- Parameters:
extendedAuthor-
-
createAndSaveAuthor
Creates and saves author given author, if bamboo user with the same username exists the new author will be linked to that user.- Parameters:
author-
-
findAuthorsByName
Performs a case insensitive search for authors by their author name. AuthorSearchString can appear anywhere in the authors name.- Parameters:
authorSearchString- string to search for- Returns:
- any authors who's author name match the given string.
-
findAuthorsThatStartWith
@NotNull @NotNull List<Author> findAuthorsThatStartWith(@NotNull @NotNull String authorSearchString, boolean unlinkedOnly) Performs a case insensitive search for authors by their author name.- Parameters:
authorSearchString- string to search forunlinkedOnly- if true will only return users which have not been linked with an user already- Returns:
- any authors who's author name match the given string.
-
findAuthorsByUser
Performs a case insensitive search for authors by their linkedUserName. userSearchString can appear anywhere in the linked user name.- Parameters:
userSearchString- string to search for- Returns:
- any authors who's linkedusername match the given string.
-
getAuthorsByResultSummary
@NotNull @NotNull Set<Author> getAuthorsByResultSummary(@NotNull @NotNull ResultsSummary resultsSummary) Retrieve unique set of authors that contributed to commits related to a given ResultsSummary- Parameters:
resultsSummary- ResultsSummary- Returns:
- list of authors
-