hudson.plugins.im
Class IMPublisher

java.lang.Object
  hudson.tasks.BuildStepCompatibilityLayer
      hudson.tasks.Publisher
          hudson.tasks.Notifier
              hudson.plugins.im.IMPublisher

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.tasks.Publisher>, hudson.tasks.BuildStep

public abstract class IMPublisher
extends hudson.tasks.Notifier
implements hudson.tasks.BuildStep

The actual Publisher that sends notification-Messages out to the clients.

Author:

Uwe Schaefer

Nested Class Summary

Nested classes/interfaces inherited from class hudson.tasks.Publisher

hudson.tasks.Publisher.DescriptorExtensionListImpl

Nested classes/interfaces inherited from interface hudson.tasks.BuildStep

hudson.tasks.BuildStep.PublisherList

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

protected

IMPublisher(java.lang.String targetsAsString, java.lang.String notificationStrategyString, boolean notifyGroupChatsOnBuildStart, boolean notifySuspects, boolean notifyCulprits, boolean notifyFixers)

Method Summary

protected abstract java.lang.String	getConfiguredIMId(hudson.model.User user)
abstract hudson.tasks.BuildStepDescriptor<hudson.tasks.Publisher>	getDescriptor()
protected abstract IMConnection	getIMConnection()
protected IMMessageTargetConverter	getIMMessageTargetConverter()
protected NotificationStrategy	getNotificationStrategy()
boolean	getNotifyCulprits()
boolean	getNotifyFixers()
boolean	getNotifyOnStart()
boolean	getNotifySuspects()
protected abstract java.lang.String	getPluginName() Returns a short name of the plugin to be used e.g. in log messages.
java.lang.String	getStrategy()
java.lang.String	getTargets()
protected void	log(hudson.model.BuildListener listener, java.lang.String message)
boolean	perform(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.BuildListener buildListener)
boolean	prebuild(hudson.model.AbstractBuild<?,?> build, hudson.model.BuildListener buildListener)

Methods inherited from class hudson.tasks.Publisher

all, getProjectAction, needsToRunAfterFinalized, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

getProjectAction, perform

Methods inherited from class java.lang.Object

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

Methods inherited from interface hudson.tasks.BuildStep

getProjectAction, getRequiredMonitorService

Constructor Detail

IMPublisher

protected IMPublisher(java.lang.String targetsAsString,
                      java.lang.String notificationStrategyString,
                      boolean notifyGroupChatsOnBuildStart,
                      boolean notifySuspects,
                      boolean notifyCulprits,
                      boolean notifyFixers)
               throws IMMessageTargetConversionException

Throws:

IMMessageTargetConversionException

Method Detail

getPluginName

protected abstract java.lang.String getPluginName()

Returns a short name of the plugin to be used e.g. in log messages.

getIMConnection

protected abstract IMConnection getIMConnection()
                                         throws IMException

Throws:

IMException

getIMMessageTargetConverter

protected IMMessageTargetConverter getIMMessageTargetConverter()

getNotificationStrategy

protected NotificationStrategy getNotificationStrategy()

getTargets

public final java.lang.String getTargets()

getStrategy

public final java.lang.String getStrategy()

getNotifyOnStart

public final boolean getNotifyOnStart()

getNotifySuspects

public final boolean getNotifySuspects()

getNotifyCulprits

public final boolean getNotifyCulprits()

getNotifyFixers

public final boolean getNotifyFixers()

log

protected void log(hudson.model.BuildListener listener,
                   java.lang.String message)

perform

public boolean perform(hudson.model.AbstractBuild<?,?> build,
                       hudson.Launcher launcher,
                       hudson.model.BuildListener buildListener)
                throws java.lang.InterruptedException,
                       java.io.IOException

Specified by:

perform in interface hudson.tasks.BuildStep

Overrides:

perform in class hudson.tasks.BuildStepCompatibilityLayer

Throws:

java.lang.InterruptedException

java.io.IOException

prebuild

public boolean prebuild(hudson.model.AbstractBuild<?,?> build,
                        hudson.model.BuildListener buildListener)

Specified by:

prebuild in interface hudson.tasks.BuildStep

Overrides:

prebuild in class hudson.tasks.BuildStepCompatibilityLayer

getDescriptor

public abstract hudson.tasks.BuildStepDescriptor<hudson.tasks.Publisher> getDescriptor()

Specified by:

getDescriptor in interface hudson.model.Describable<hudson.tasks.Publisher>

Overrides:

getDescriptor in class hudson.tasks.Notifier

getConfiguredIMId

protected abstract java.lang.String getConfiguredIMId(hudson.model.User user)