jenkins.plugins.hipchat

Class CardProvider

java.lang.Object

hudson.model.AbstractDescribableImpl<CardProvider>

jenkins.plugins.hipchat.CardProvider

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<CardProvider>

Direct Known Subclasses:

DefaultCardProvider, NoopCardProvider

public abstract class CardProvider
extends hudson.model.AbstractDescribableImpl<CardProvider>
implements hudson.ExtensionPoint

An extension point that can be used to allow full control over HipChat notification cards for individual notifications. The provider itself is globally configured, so any job-specific behavior would be the responsibility of the plugin itself.

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
CardProvider()

Method Summary

Modifier and Type	Method and Description
protected Attribute	attribute(String label, String value, Value.Style style, String url) A simple factory method to easily create attribute for the Card.
abstract Card	getCard(hudson.model.Run<?,?> run, hudson.model.TaskListener taskListener, Icon icon, String message) Returns a card corresponding to the build notification.
Card	getCard(hudson.model.Run<?,?> run, hudson.model.TaskListener taskListener, String message) Deprecated. Implement getCard(hudson.model.Run, hudson.model.TaskListener, jenkins.plugins.hipchat.model.notifications.Icon, java.lang.String) instead.
CardProviderDescriptor	getDescriptor()

Methods inherited from class java.lang.Object

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

Constructor Detail

CardProvider

public CardProvider()

Method Detail

getDescriptor

public CardProviderDescriptor getDescriptor()

Specified by:

getDescriptor in interface hudson.model.Describable<CardProvider>

Overrides:

getDescriptor in class hudson.model.AbstractDescribableImpl<CardProvider>

getCard

@Deprecated
public Card getCard(hudson.model.Run<?,?> run,
                                hudson.model.TaskListener taskListener,
                                String message)

Deprecated. Implement getCard(hudson.model.Run, hudson.model.TaskListener, jenkins.plugins.hipchat.model.notifications.Icon, java.lang.String) instead.

Returns a card corresponding to the build notification.

Parameters:

run - The build run.

taskListener - The taskListener associated with the current build.

message - The fully resolved notification message.

Returns:

The card that has been constructed for this notification. May be null if no card should be displayed.

getCard

public abstract Card getCard(hudson.model.Run<?,?> run,
                             hudson.model.TaskListener taskListener,
                             Icon icon,
                             String message)

Returns a card corresponding to the build notification.

Parameters:

run - The build run.

taskListener - The taskListener associated with the current build.

icon - The icon to include in the message. May be null.

message - The fully resolved notification message.

Returns:

The card that has been constructed for this notification. May be null if no card should be displayed.

attribute

protected Attribute attribute(String label,
                              String value,
                              Value.Style style,
                              String url)

A simple factory method to easily create attribute for the Card. Attributes are individual information fields that can be displayed on the card. See HipChat API reference for more details.

Parameters:

label - The label for the data.

value - The data value corresponding to the label.

style - The style that determines the color of the background for the value.

url - Used as the href of a link that will be generated (the link's title will be the 'value') on the card.

Returns:

The Attribute representation of the provided details.