jetbrains.buildServer.messages.serviceMessages

Class ServiceMessage

java.lang.Object

jetbrains.buildServer.messages.serviceMessages.ServiceMessage

Direct Known Subclasses:

BuildNumber, MessageWithAttributes, ProgressMessage, PublishArtifacts, TestNavigationInfo

public class ServiceMessage
extends java.lang.Object

Utility class to parse messages like ##teamcity[<message name> <param name>='<param value>' <param name>='<param value>'...] or ##teamcity[<message name> '< argument>'] Argument is optional.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ServiceMessage.Timestamp

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ARG_ATTRIBUTE
static java.lang.String	DISABLE
static java.lang.String	ENABLE
static java.lang.String	PARSE_SERVICE_MESSAGES_INSIDE_TAG This tag can be used to inform that service message can have other service messages inside its attributes.
static @NotNull java.lang.String	SERVICE_MESSAGE_END
static @NotNull java.lang.String	SERVICE_MESSAGE_START
static java.lang.String	TAGS_ATRRIBUTE
static java.lang.String	TAGS_SEPARATOR

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ServiceMessage(@NotNull java.lang.String messageName)
protected	ServiceMessage(@NotNull java.lang.String messageName, @NotNull java.util.Map<java.lang.String,java.lang.String> attributes)
protected	ServiceMessage(@NotNull java.lang.String messageName, @Nullable java.lang.String argument)

Method Summary

Modifier and Type	Method and Description
void	addTag(@NotNull java.lang.String tag) Adds a new tag to service message.
@NotNull java.lang.String	asString() Converts this service message to service message string
static @NotNull java.lang.String	asString(@NotNull java.lang.String messageName, @NotNull java.util.Map<java.lang.String,java.lang.String> attributes) Returns a string representation of a service message with attribute map.
static @NotNull java.lang.String	asString(@NotNull java.lang.String messageName, @NotNull java.lang.String argument) Returns a string representation of a service message with a single argument.
@Nullable java.lang.String	getArgument()
@NotNull java.util.Map<java.lang.String,java.lang.String>	getAttributes() Returns map of parameters of the message in format ##teamcity[<message name> <param name>='<param value>' <param name>='<param value>'...] if parameters were specified, and empty map otherwise
protected @Nullable java.lang.String	getAttributeValue(@NotNull java.lang.String attrName)
@Nullable ServiceMessage.Timestamp	getCreationTimestamp() Returns service message creation timestamp in case it was specified with attribute "timestamp".
@Nullable java.lang.String	getFlowId() Returns service message flow id in case it was specified and null otherwise
@NotNull java.lang.String	getMessageName()
@NotNull java.util.Collection<java.lang.String>	getTags()
static @Nullable ServiceMessage	parse(@NotNull java.lang.String text) If message is text message according to the pattern ##teamcity[key...], return parsed message.
static void	parse(@NotNull java.lang.String text, @NotNull ServiceMessageParserCallback parserCallback) Accepts mixed text (text that can contain service messages inside) and parser callback.
static @NotNull ServiceMessage	parseSimple(@NotNull java.lang.String text, boolean shouldValidate) Creates a ServiceMessage instance out of the specified text.
void	setFlowId(@NotNull java.lang.String flowId)
void	setTimestamp(@NotNull java.util.Date timestamp)
java.lang.String	toString()
protected void	validate() Service message validator checks that all methods which marked with RequiredAttribute annotation return not-null value after initialization.
void	visit(@NotNull ServiceMessageVisitor visitor) Depending on this service message type calls corresponding method in the supplied visitor.

Methods inherited from class java.lang.Object

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

Field Detail

SERVICE_MESSAGE_START

@NotNull
public static final @NotNull java.lang.String SERVICE_MESSAGE_START

See Also:

Constant Field Values

SERVICE_MESSAGE_END

@NotNull
public static final @NotNull java.lang.String SERVICE_MESSAGE_END

See Also:

Constant Field Values

TAGS_SEPARATOR

public static final java.lang.String TAGS_SEPARATOR

See Also:

Constant Field Values

ENABLE

@NonNls
public static final java.lang.String ENABLE

See Also:

Constant Field Values

DISABLE

@NonNls
public static final java.lang.String DISABLE

See Also:

Constant Field Values

ARG_ATTRIBUTE

public static final java.lang.String ARG_ATTRIBUTE

See Also:

Constant Field Values

TAGS_ATRRIBUTE

public static final java.lang.String TAGS_ATRRIBUTE

See Also:

Constant Field Values

PARSE_SERVICE_MESSAGES_INSIDE_TAG

public static final java.lang.String PARSE_SERVICE_MESSAGES_INSIDE_TAG

This tag can be used to inform that service message can have other service messages inside its attributes.

Since:

10.0

See Also:

Constant Field Values

Constructor Detail

ServiceMessage

protected ServiceMessage(@NotNull
                         @NotNull java.lang.String messageName)

ServiceMessage

protected ServiceMessage(@NotNull
                         @NotNull java.lang.String messageName,
                         @Nullable
                         @Nullable java.lang.String argument)

ServiceMessage

protected ServiceMessage(@NotNull
                         @NotNull java.lang.String messageName,
                         @NotNull
                         @NotNull java.util.Map<java.lang.String,java.lang.String> attributes)

Method Detail

parse

@Nullable
public static @Nullable ServiceMessage parse(@NotNull
                                                       @NotNull java.lang.String text)
                                                throws java.text.ParseException

If message is text message according to the pattern ##teamcity[key...], return parsed message. Otherwise, return null Throws ParseException if message is a service message but its arguments cannot be parsed.

Parameters:

text - text to parse

Returns:

see above

Throws:

java.text.ParseException - if parsing failed

parse

public static void parse(@NotNull
                         @NotNull java.lang.String text,
                         @NotNull
                         @NotNull ServiceMessageParserCallback parserCallback)

Accepts mixed text (text that can contain service messages inside) and parser callback. Notifies parser callback on any occurrence of the service message or regular text.

Parameters:

text - text with service messages

parserCallback - callback

Since:

6.0

getMessageName

@NotNull
public @NotNull java.lang.String getMessageName()

Returns:

name part of the service message

getArgument

@Nullable
public @Nullable java.lang.String getArgument()

Returns:

argument text for message ##teamcity[<message name> '< argument>'] or null

getCreationTimestamp

@Nullable
public @Nullable ServiceMessage.Timestamp getCreationTimestamp()

Returns service message creation timestamp in case it was specified with attribute "timestamp". If it was not returns null. The format of timestamp has to be "yyyy-MM-dd'T'HH:mm:ss.SSSZ" or "yyyy-MM-dd'T'HH:mm:ss.SSS". Returns null if attribute value does not match the format.

Returns:

service message creation timestamp in case it was correctly specified with attribute "timestamp", null otherwise.

getFlowId

@Nullable
public @Nullable java.lang.String getFlowId()

Returns service message flow id in case it was specified and null otherwise

Returns:

service message flow id in case it was specified and null otherwise

getTags

@NotNull
public @NotNull java.util.Collection<java.lang.String> getTags()

getAttributes

@NotNull
public @NotNull java.util.Map<java.lang.String,java.lang.String> getAttributes()

Returns map of parameters of the message in format ##teamcity[<message name> <param name>='<param value>' <param name>='<param value>'...] if parameters were specified, and empty map otherwise

Returns:

see above

visit

public void visit(@NotNull
                  @NotNull ServiceMessageVisitor visitor)

Depending on this service message type calls corresponding method in the supplied visitor.

Parameters:

visitor - visitor

setTimestamp

public void setTimestamp(@NotNull
                         @NotNull java.util.Date timestamp)

setFlowId

public void setFlowId(@NotNull
                      @NotNull java.lang.String flowId)

addTag

public void addTag(@NotNull
                   @NotNull java.lang.String tag)

Adds a new tag to service message.

Parameters:

tag - a tag to add

Since:

10.0

getAttributeValue

@Nullable
protected @Nullable java.lang.String getAttributeValue(@NotNull
                                                                 @NotNull java.lang.String attrName)

parseSimple

@NotNull
public static @NotNull ServiceMessage parseSimple(@NotNull
                                                           @NotNull java.lang.String text,
                                                           boolean shouldValidate)
                                                    throws java.text.ParseException

Creates a ServiceMessage instance out of the specified text. Currently the ServiceMessage class doesn't have any RequiredAttribute so validation is not performed

Parameters:

text - text to parse

shouldValidate - whether to validate required attributes or not (currently ignored)

Returns:

parsed service message

Throws:

java.text.ParseException - if parsing fails

validate

protected void validate()
                 throws java.text.ParseException

Service message validator checks that all methods which marked with RequiredAttribute annotation return not-null value after initialization.

Throws:

java.text.ParseException

asString

@NotNull
public @NotNull java.lang.String asString()

Converts this service message to service message string

Returns:

serialized service message object with ##teamcity[ prefix

Since:

6.0

asString

@NotNull
public static @NotNull java.lang.String asString(@NotNull
                                                          @NotNull java.lang.String messageName,
                                                          @NotNull
                                                          @NotNull java.util.Map<java.lang.String,java.lang.String> attributes)

Returns a string representation of a service message with attribute map. This method is useful when there is a need of outputting service text without creating a ServiceMessage instance.

Parameters:

messageName - name of the message

attributes - attribute map

Returns:

service message string

Since:

6.0

asString

@NotNull
public static @NotNull java.lang.String asString(@NotNull
                                                          @NotNull java.lang.String messageName,
                                                          @NotNull
                                                          @NotNull java.lang.String argument)

Returns a string representation of a service message with a single argument. This method is useful when there is a need of outputting service text without creating a ServiceMessage instance.

Parameters:

messageName - name of the message

argument - the argument

Returns:

service message string

Since:

6.0

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object