net.nemerosa.ontrack.extension.issues.support

Class AbstractIssueServiceExtension

java.lang.Object

net.nemerosa.ontrack.extension.support.AbstractExtension

net.nemerosa.ontrack.extension.issues.support.AbstractIssueServiceExtension

All Implemented Interfaces:

IssueServiceExtension, net.nemerosa.ontrack.model.extension.Extension

public abstract class AbstractIssueServiceExtension
extends net.nemerosa.ontrack.extension.support.AbstractExtension
implements IssueServiceExtension

Convenient implementation for most of the issue services.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractIssueServiceExtension(net.nemerosa.ontrack.model.extension.ExtensionFeature extensionFeature, java.lang.String id, java.lang.String name, IssueExportServiceFactory issueExportServiceFactory) Constructor.

Method Summary

Modifier and Type	Method and Description
java.util.List<ExportFormat>	exportFormats(IssueServiceConfiguration issueServiceConfiguration) Export of both text and HTML by default.
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.lang.String	getId() Gets the ID of this service.
protected abstract java.util.Set<java.lang.String>	getIssueTypes(IssueServiceConfiguration issueServiceConfiguration, Issue issue)
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.

Methods inherited from class net.nemerosa.ontrack.extension.support.AbstractExtension

getFeature

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.nemerosa.ontrack.extension.issues.IssueServiceExtension

extractIssueKeysFromMessage, getConfigurationByName, getConfigurationList, getIssue, getIssueId, getLinkedIssues, getLinkForAllIssues, getMessageAnnotator, validIssueToken

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

getFeature

Constructor Detail

AbstractIssueServiceExtension

protected AbstractIssueServiceExtension(net.nemerosa.ontrack.model.extension.ExtensionFeature extensionFeature,
                                        java.lang.String id,
                                        java.lang.String name,
                                        IssueExportServiceFactory issueExportServiceFactory)

Constructor.

Parameters:

id - The unique ID for this service.

name - The display name for this service.

issueExportServiceFactory - Factory to get export services

Method Detail

getId

public java.lang.String getId()

Description copied from interface: IssueServiceExtension

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.

Specified by:

getId in interface IssueServiceExtension

getName

public java.lang.String getName()

Description copied from interface: IssueServiceExtension

Gets the display name for this service.

Specified by:

getName in interface IssueServiceExtension

exportFormats

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

Export of both text and HTML by default.

Specified by:

exportFormats in interface IssueServiceExtension

Parameters:

issueServiceConfiguration - Configuration for the service

exportIssues

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

Description copied from interface: IssueServiceExtension

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

Specified by:

exportIssues in interface IssueServiceExtension

Parameters:

issueServiceConfiguration - Configuration for the service

issues - List of issues to export

request - Specification for the export

getMessageRegex

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

Description copied from interface: IssueServiceExtension

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

Specified by:

getMessageRegex in interface IssueServiceExtension

Parameters:

issueServiceConfiguration - Configuration for the service

issue - Issue to look for

Returns:

Regular expression

getIssueTypes

protected abstract java.util.Set<java.lang.String> getIssueTypes(IssueServiceConfiguration issueServiceConfiguration,
                                                                 Issue issue)