Package jetbrains.buildServer.serverSide.deploymentDashboards.translators

Class AbstractDeploymentInstanceMessageTranslator

java.lang.Object

jetbrains.buildServer.serverSide.deploymentDashboards.translators.AbstractDeploymentInstanceMessageTranslator

All Implemented Interfaces:

ServiceMessageTranslator, ServerExtension, TeamCityExtension

Direct Known Subclasses:

DeploymentInstanceArgumentMessageTranslator, DeploymentInstanceStateMessageTranslator, RemoveDeploymentInstanceMessageTranslator

public abstract class AbstractDeploymentInstanceMessageTranslator
extends Object
implements ServiceMessageTranslator

Field Summary

Fields

Modifier and Type	Field	Description
protected DeploymentDashboardManager	myDeploymentDashboardManager

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractDeploymentInstanceMessageTranslator(DeploymentDashboardManager deploymentDashboardManager)

Method Summary

Modifier and Type	Method	Description
abstract List<BuildMessage1>	doTranslate(SRunningBuild runningBuild, BuildMessage1 originalMessage, ServiceMessage serviceMessage)
protected DeploymentDashboard	getDashboard(ServiceMessage serviceMessage)
protected String	getDashboardId(ServiceMessage serviceMessage)
protected String	getInstanceId(ServiceMessage serviceMessage)
protected SProject	getProject(SRunningBuild runningBuild)
protected String	getServiceMessageArgument(ServiceMessage serviceMessage, String argumentKey)
List<BuildMessage1>	translate(SRunningBuild runningBuild, BuildMessage1 originalMessage, ServiceMessage serviceMessage)	Called to translate service message to a number of usual messages.

Methods inherited from class java.lang.Object

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

Methods inherited from interface jetbrains.buildServer.messages.serviceMessages.ServiceMessageTranslator

getServiceMessageName

Field Detail

myDeploymentDashboardManager

@NotNull
protected DeploymentDashboardManager myDeploymentDashboardManager

Constructor Detail

AbstractDeploymentInstanceMessageTranslator

protected AbstractDeploymentInstanceMessageTranslator(@NotNull
                                                      DeploymentDashboardManager deploymentDashboardManager)

Method Detail

getProject

protected SProject getProject(SRunningBuild runningBuild)

getServiceMessageArgument

protected String getServiceMessageArgument(ServiceMessage serviceMessage,
                                           String argumentKey)
                                    throws TranslateMessageException

Throws:

TranslateMessageException

getInstanceId

protected String getInstanceId(ServiceMessage serviceMessage)

getDashboardId

protected String getDashboardId(ServiceMessage serviceMessage)

getDashboard

protected DeploymentDashboard getDashboard(ServiceMessage serviceMessage)

translate

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

Description copied from interface: ServiceMessageTranslator

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.

Specified by:

translate in interface ServiceMessageTranslator

Parameters:

runningBuild - running build

originalMessage - original message from which service message was created

serviceMessage - service message

Returns:

a list of translated messages

doTranslate

public abstract List<BuildMessage1> doTranslate(SRunningBuild runningBuild,
                                                BuildMessage1 originalMessage,
                                                ServiceMessage serviceMessage)