net.nemerosa.ontrack.extension.issues

Interface IssueServiceExtension

All Superinterfaces:

net.nemerosa.ontrack.model.extension.Extension

All Known Implementing Classes:

AbstractIssueServiceExtension

public interface IssueServiceExtension
extends net.nemerosa.ontrack.model.extension.Extension

Defines a generic service used to access issues from a ticketing system like JIRA, GitHub, etc.

Method Summary

Modifier and Type	Method and Description
java.util.List<ExportFormat>	exportFormats(IssueServiceConfiguration issueServiceConfiguration) List of supported export formats for the issues.
ExportedIssues	exportIssues(IssueServiceConfiguration issueServiceConfiguration, java.util.List<? extends Issue> issues, net.nemerosa.ontrack.extension.api.model.IssueChangeLogExportRequest request) Exports a list of issues as text for a given format.
java.util.Set<java.lang.String>	extractIssueKeysFromMessage(IssueServiceConfiguration issueServiceConfiguration, java.lang.String message) Given a message, extracts the issue keys from the message
IssueServiceConfiguration	getConfigurationByName(java.lang.String name) Gets a configuration using its name
java.util.List<? extends IssueServiceConfiguration>	getConfigurationList() Returns the unfiltered list of all configurations for this issue service.
java.lang.String	getId() Gets the ID of this service.
Issue	getIssue(IssueServiceConfiguration issueServiceConfiguration, java.lang.String issueKey) Given a key, tries to find the issue with this key.
java.util.Optional<java.lang.String>	getIssueId(IssueServiceConfiguration issueServiceConfiguration, java.lang.String token) Normalises a string into a valid issue key if possible, in order for it to be useable in a search.
default java.util.Collection<? extends Issue>	getLinkedIssues(net.nemerosa.ontrack.model.structure.Project project, IssueServiceConfiguration issueServiceConfiguration, Issue issue) Gets the list of linked issues that can be used to look for issues references (commits, revisions...) accross severak branches.
java.lang.String	getLinkForAllIssues(IssueServiceConfiguration issueServiceConfiguration, java.util.List<Issue> issues) Given a list of issues, returns a link that allows the user to display the list of all those issues in a browser.
java.util.Optional<net.nemerosa.ontrack.model.support.MessageAnnotator>	getMessageAnnotator(IssueServiceConfiguration issueServiceConfiguration) Returns a message annotator that can be used to extract information from a commit message.
java.lang.String	getMessageRegex(IssueServiceConfiguration issueServiceConfiguration, Issue issue) Creates a regular expression to use when looking for this issue in a message.
java.lang.String	getName() Gets the display name for this service.
boolean	validIssueToken(java.lang.String token) Checks if a token may represent a valid issue token.

Methods inherited from interface net.nemerosa.ontrack.model.extension.Extension

getFeature

Method Detail

getId

java.lang.String getId()

Gets the ID of this service. It must be unique among all the available issue services. This must be mapped to the associated extension since this ID can be used to identify web resources using the /extension/<id> URI.

getName

java.lang.String getName()

Gets the display name for this service.

getConfigurationList

java.util.List<? extends IssueServiceConfiguration> getConfigurationList()

Returns the unfiltered list of all configurations for this issue service.

getConfigurationByName

IssueServiceConfiguration getConfigurationByName(java.lang.String name)

Gets a configuration using its name

Parameters:

name - Name of the configuration

Returns:

Configuration or null if not found

validIssueToken

boolean validIssueToken(java.lang.String token)

Checks if a token may represent a valid issue token.

Parameters:

token - Token to test

Returns:

true if the token may represent an issue

extractIssueKeysFromMessage

java.util.Set<java.lang.String> extractIssueKeysFromMessage(IssueServiceConfiguration issueServiceConfiguration,
                                                            java.lang.String message)

Given a message, extracts the issue keys from the message

Parameters:

issueServiceConfiguration - Configuration for the service

message - Message to scan

Returns:

List of keys (can be empty, never null)

getMessageAnnotator

java.util.Optional<net.nemerosa.ontrack.model.support.MessageAnnotator> getMessageAnnotator(IssueServiceConfiguration issueServiceConfiguration)

Returns a message annotator that can be used to extract information from a commit message. According to the service type and its configuration, they could be or not a possible annotator.

getLinkForAllIssues

java.lang.String getLinkForAllIssues(IssueServiceConfiguration issueServiceConfiguration,
                                     java.util.List<Issue> issues)

Given a list of issues, returns a link that allows the user to display the list of all those issues in a browser.

Parameters:

issueServiceConfiguration - Configuration for the service

issues - List of issues to display. Can be empty, but not null.

Returns:

Link

getIssue

Issue getIssue(IssueServiceConfiguration issueServiceConfiguration,
               java.lang.String issueKey)

Given a key, tries to find the issue with this key.

Parameters:

issueServiceConfiguration - Configuration for the service

issueKey - Issue key

Returns:

Issue if found, null otherwise

exportFormats

java.util.List<ExportFormat> exportFormats(IssueServiceConfiguration issueServiceConfiguration)

List of supported export formats for the issues.

Parameters:

issueServiceConfiguration - Configuration for the service

exportIssues

ExportedIssues exportIssues(IssueServiceConfiguration issueServiceConfiguration,
                            java.util.List<? extends Issue> issues,
                            net.nemerosa.ontrack.extension.api.model.IssueChangeLogExportRequest request)

Exports a list of issues as text for a given format.

Parameters:

issueServiceConfiguration - Configuration for the service

issues - List of issues to export

request - Specification for the export

Throws:

IssueExportFormatNotFoundException - If the format is not supported.

getIssueId

java.util.Optional<java.lang.String> getIssueId(IssueServiceConfiguration issueServiceConfiguration,
                                                java.lang.String token)

Normalises a string into a valid issue key if possible, in order for it to be useable in a search. This allows for services to adjust the token for cases where the representation of an issue might be different from its actual indexed value. For example, in GitHub, the representation might #12 while the value to search on is 12.

Parameters:

issueServiceConfiguration - Configuration for the service

token - Token to transform into a key

Returns:

Valid token or Optional.empty().

getLinkedIssues

default java.util.Collection<? extends Issue> getLinkedIssues(net.nemerosa.ontrack.model.structure.Project project,
                                                              IssueServiceConfiguration issueServiceConfiguration,
                                                              Issue issue)

Gets the list of linked issues that can be used to look for issues references (commits, revisions...) accross severak branches.

By default, returns a collection that contains only issue.

Parameters:

project - Project to use for any additional configuration

issueServiceConfiguration - Configuration for the service

issue - Root or seeding issue

Returns:

List of issues linked to issue. It must include the initial issue.

getMessageRegex

java.lang.String getMessageRegex(IssueServiceConfiguration issueServiceConfiguration,
                                 Issue issue)

Creates a regular expression to use when looking for this issue in a message.

Parameters:

issueServiceConfiguration - Configuration for the service

issue - Issue to look for

Returns:

Regular expression