cz.encircled.jira.reactive

Class ReactiveJiraClientImpl

cz.encircled.jira.reactive.ReactiveJiraClientImpl

All Implemented Interfaces:

ReactiveJiraClient

public class ReactiveJiraClientImpl
implements ReactiveJiraClient

Jira client base class

TODO wiremock testing

Constructor Summary

Constructors

Constructor and Description
ReactiveJiraClientImpl(java.lang.String baseUrl, java.lang.String username, java.lang.String password, java.util.List<java.lang.String> defaultIssueFields) Jira client base class

Method Summary

Modifier and Type	Method and Description
ReactiveJiraClientImpl	customFieldAlias(java.lang.String customFieldName, java.lang.String alias) Add a meaningful alias for issue custom field, which can be used instead of "customfield_123" in all methods (ReactiveJiraClientImpl.getIssue, ReactiveJiraClientImpl.searchIssues etc) and in Issue.fields
reactor.core.publisher.Flux<cz.encircled.jira.reactive.model.SprintReport>	getActiveSprints(int rapidBoardId) Find active sprints which belong to rapid view with given rapidBoardId
java.util.List<java.lang.String>	getDefaultIssueFields()
reactor.core.publisher.Mono<cz.encircled.jira.reactive.model.JiraFilter>	getFilter(int id) Fetch jira filter by id
reactor.core.publisher.Mono<cz.encircled.jira.reactive.model.Issue>	getIssue(java.lang.String key, java.util.List<java.lang.String> includedFields) Fetch jira issue by key
reactor.core.publisher.Flux<cz.encircled.jira.reactive.model.Issue>	getIssues(java.util.List<java.lang.String> keys, java.util.List<java.lang.String> includedFields) Fetch multiple jira issues by keys
reactor.core.publisher.Mono<cz.encircled.jira.reactive.model.SprintReport>	getSprintReport(int rapidBoardId, int sprintId) Fetch particular sprint report for given rapidBoardId and sprintId
reactor.core.publisher.Mono<cz.encircled.jira.reactive.model.SearchResult>	searchIssues(java.lang.String jql, java.util.List<java.lang.String> includedFields, int maxResults) Fetch multiple jira issues by JQL

Methods inherited from interface cz.encircled.jira.reactive.ReactiveJiraClient

getActiveSprints, getDefaultIssueFields, getFilter, getIssue, getIssues, getSprintReport, searchIssues

Constructor Detail

ReactiveJiraClientImpl

public ReactiveJiraClientImpl(java.lang.String baseUrl,
                              java.lang.String username,
                              java.lang.String password,
                              java.util.List<java.lang.String> defaultIssueFields)

Jira client base class

TODO wiremock testing

Method Detail

customFieldAlias

public ReactiveJiraClientImpl customFieldAlias(java.lang.String customFieldName,
                                               java.lang.String alias)

Add a meaningful alias for issue custom field, which can be used instead of "customfield_123" in all methods (ReactiveJiraClientImpl.getIssue, ReactiveJiraClientImpl.searchIssues etc) and in Issue.fields

See Also:

ReactiveJiraClientImpl.getIssue, ReactiveJiraClientImpl.searchIssues

getIssue

public reactor.core.publisher.Mono<cz.encircled.jira.reactive.model.Issue> getIssue(java.lang.String key,
                                                                                    java.util.List<java.lang.String> includedFields)

Fetch jira issue by key

Parameters:

includedFields - issue fields to be fetched, default is all. Default can be overriden during client creation

getIssues

public reactor.core.publisher.Flux<cz.encircled.jira.reactive.model.Issue> getIssues(java.util.List<java.lang.String> keys,
                                                                                     java.util.List<java.lang.String> includedFields)

Fetch multiple jira issues by keys

Parameters:

includedFields - issue fields to be fetched, default is all. Default can be overriden during client creation

getFilter

public reactor.core.publisher.Mono<cz.encircled.jira.reactive.model.JiraFilter> getFilter(int id)

Fetch jira filter by id

searchIssues

public reactor.core.publisher.Mono<cz.encircled.jira.reactive.model.SearchResult> searchIssues(java.lang.String jql,
                                                                                               java.util.List<java.lang.String> includedFields,
                                                                                               int maxResults)

Fetch multiple jira issues by JQL

Parameters:

includedFields - issue fields to be fetched, default is all. Default can be overriden during client creation

maxResults - max result size

getActiveSprints

public reactor.core.publisher.Flux<cz.encircled.jira.reactive.model.SprintReport> getActiveSprints(int rapidBoardId)

Find active sprints which belong to rapid view with given rapidBoardId

Parameters:

rapidBoardId - id of target rapid view

getSprintReport

public reactor.core.publisher.Mono<cz.encircled.jira.reactive.model.SprintReport> getSprintReport(int rapidBoardId,
                                                                                                  int sprintId)

Fetch particular sprint report for given rapidBoardId and sprintId

Parameters:

rapidBoardId - id of target rapid view

sprintId - id of target sprint

getDefaultIssueFields

public java.util.List<java.lang.String> getDefaultIssueFields()