Package jetbrains.buildServer.messages.serviceMessages

Interface ServiceMessageTranslator

All Superinterfaces:

ServerExtension, TeamCityExtension

All Known Implementing Classes:

AbstractDeploymentInstanceMessageTranslator, BuildCachePublishedTranslator, BuildNumberTranslator, BuildStatisticValueTranslator, BuildStatusTranslator, DeploymentInstanceArgumentMessageTranslator, DeploymentInstanceStateMessageTranslator, DetachedFromAgentMessageTranslator, FlowFinishedMessageTranslator, FlowStartedMessageTranslator, MessageTranslator, NotificationTranslator, RemoteArtifactTranslator, RemoveDeploymentInstanceMessageTranslator

public interface ServiceMessageTranslator
extends ServerExtension

Translator for specific type of service messages.

Method Summary

Modifier and Type	Method	Description
String	getServiceMessageName()	Returns name of the service message supported by this translator.
static void	requireAttributes(ServiceMessage serviceMessage, String... attributes)
List<BuildMessage1>	translate(SRunningBuild runningBuild, BuildMessage1 originalMessage, ServiceMessage serviceMessage)	Called to translate service message to a number of usual messages.

Method Detail

translate

@NotNull
List<BuildMessage1> translate(@NotNull
                              SRunningBuild runningBuild,
                              @NotNull
                              BuildMessage1 originalMessage,
                              @NotNull
                              ServiceMessage serviceMessage)
                       throws TranslateMessageException

Called to translate service message to a number of usual messages.

Note: no attempts should be made to use the build log from the running build to log some messages SBuild.getBuildLog(), instead the translator should return all the messages which should be inserted into the build log instead of the processed service message.

Parameters:

runningBuild - running build

originalMessage - original message from which service message was created

serviceMessage - service message

Returns:

a list of translated messages

Throws:

TranslateMessageException - since 2018.2, when there is a error translating the message or the message has an incorrect format

getServiceMessageName

@NotNull
String getServiceMessageName()

Returns name of the service message supported by this translator. Only service messages with such name will be passed to the translator.

Returns:

see above.

requireAttributes

static void requireAttributes(@NotNull
                              ServiceMessage serviceMessage,
                              String... attributes)
                       throws TranslateMessageException

Parameters:

serviceMessage - service messages

attributes - list of attributes which must be present in the service message

Throws:

TranslateMessageException

Since:

2019.1