net.hurstfrost.hudson.sounds

Class HudsonSoundsNotifier.HudsonSoundsDescriptor

java.lang.Object

hudson.model.Descriptor<T>

hudson.tasks.BuildStepDescriptor<hudson.tasks.Publisher>

net.hurstfrost.hudson.sounds.HudsonSoundsNotifier.HudsonSoundsDescriptor

All Implemented Interfaces:

hudson.model.Saveable, jenkins.util.io.OnMaster

Enclosing class:

HudsonSoundsNotifier

@Extension
public static final class HudsonSoundsNotifier.HudsonSoundsDescriptor
extends hudson.tasks.BuildStepDescriptor<hudson.tasks.Publisher>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HudsonSoundsNotifier.HudsonSoundsDescriptor.SoundBite

Nested classes/interfaces inherited from class hudson.model.Descriptor

hudson.model.Descriptor.FormException, hudson.model.Descriptor.PropertyType, hudson.model.Descriptor.Self

Field Summary

Fields

Modifier and Type	Field and Description
static hudson.util.VersionNumber	STAPLER_JSON_BREAKING_CHANGE_VERSION_NUMBER

Fields inherited from class hudson.model.Descriptor

clazz

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor and Description
HudsonSoundsDescriptor()

Method Summary

Modifier and Type	Method and Description
boolean	configure(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject json)
hudson.util.FormValidation	doCheckPipeTimeout(int value)
hudson.util.FormValidation	doCheckSoundArchive(String value) Checks that a resource can be found at the specified location.
hudson.util.FormValidation	doCheckSystemCommand(String systemCommand)
hudson.util.FormValidation	doTestSound(String selectedSound)
protected static String	getBiteName(String path)
static HudsonSoundsNotifier.HudsonSoundsDescriptor	getDescriptor()
String	getDisplayName()
int	getPipeTimeoutSecs()
HudsonSoundsNotifier.PLAY_METHOD	getPlayMethod()
HudsonSoundsNotifier.HudsonSoundsDescriptor.SoundBite	getSound(String soundId)
String	getSoundArchive()
protected InputStream	getSoundBiteInputStream(HudsonSoundsNotifier.HudsonSoundsDescriptor.SoundBite soundBite)
List<HudsonSoundsNotifier.HudsonSoundsDescriptor.SoundBite>	getSounds()
String	getSystemCommand()
boolean	isApplicable(Class<? extends hudson.model.AbstractProject> jobType)
HudsonSoundsNotifier	newInstance(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject formData)
protected void	playSound(String id)
protected void	playSound(String id, hudson.EnvVars vars)
protected void	playSound(String id, Integer afterDelayMs, hudson.EnvVars vars)
protected void	playSoundFromUrl(URL url, Integer afterDelayMs, hudson.EnvVars vars)
protected static TreeMap<String,HudsonSoundsNotifier.HudsonSoundsDescriptor.SoundBite>	rebuildSoundsIndex(String urlString)
void	setPipeTimeoutSecs(int pipeTimeout)
void	setPlayMethod(HudsonSoundsNotifier.PLAY_METHOD playMethod)
void	setSoundArchive(String archive)
void	setSystemCommand(String systemCommand)

Methods inherited from class hudson.tasks.BuildStepDescriptor

filter

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, calcAutoCompleteSettings, calcFillSettings, configure, doHelp, find, find, findByDescribableClassName, findById, getCategory, getCheckMethod, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getGlobalConfigPage, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, getT, getViewPage, isInstance, isSubTypeOf, load, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, save, self, toArray, toList, toMap

Methods inherited from class java.lang.Object

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

Field Detail

STAPLER_JSON_BREAKING_CHANGE_VERSION_NUMBER

public static final hudson.util.VersionNumber STAPLER_JSON_BREAKING_CHANGE_VERSION_NUMBER

Constructor Detail

HudsonSoundsDescriptor

public HudsonSoundsDescriptor()

Method Detail

getDescriptor

public static HudsonSoundsNotifier.HudsonSoundsDescriptor getDescriptor()

getSounds

public List<HudsonSoundsNotifier.HudsonSoundsDescriptor.SoundBite> getSounds()

getSound

public HudsonSoundsNotifier.HudsonSoundsDescriptor.SoundBite getSound(String soundId)

rebuildSoundsIndex

protected static TreeMap<String,HudsonSoundsNotifier.HudsonSoundsDescriptor.SoundBite> rebuildSoundsIndex(String urlString)

getBiteName

protected static String getBiteName(String path)

getSoundArchive

public String getSoundArchive()

setSoundArchive

public void setSoundArchive(String archive)

getPlayMethod

public HudsonSoundsNotifier.PLAY_METHOD getPlayMethod()

setPlayMethod

public void setPlayMethod(HudsonSoundsNotifier.PLAY_METHOD playMethod)

getSystemCommand

public String getSystemCommand()

setSystemCommand

public void setSystemCommand(String systemCommand)

getPipeTimeoutSecs

public int getPipeTimeoutSecs()

setPipeTimeoutSecs

public void setPipeTimeoutSecs(int pipeTimeout)

isApplicable

public boolean isApplicable(Class<? extends hudson.model.AbstractProject> jobType)

Specified by:

isApplicable in class hudson.tasks.BuildStepDescriptor<hudson.tasks.Publisher>

configure

public boolean configure(org.kohsuke.stapler.StaplerRequest req,
                         net.sf.json.JSONObject json)

Overrides:

configure in class hudson.model.Descriptor<hudson.tasks.Publisher>

getDisplayName

public String getDisplayName()

Overrides:

getDisplayName in class hudson.model.Descriptor<hudson.tasks.Publisher>

newInstance

public HudsonSoundsNotifier newInstance(@Nullable
                                        org.kohsuke.stapler.StaplerRequest req,
                                        @Nonnull
                                        net.sf.json.JSONObject formData)

Overrides:

newInstance in class hudson.model.Descriptor<hudson.tasks.Publisher>

doTestSound

public hudson.util.FormValidation doTestSound(@QueryParameter
                                              String selectedSound)

doCheckPipeTimeout

public hudson.util.FormValidation doCheckPipeTimeout(@QueryParameter
                                                     int value)

doCheckSystemCommand

public hudson.util.FormValidation doCheckSystemCommand(@QueryParameter
                                                       String systemCommand)

doCheckSoundArchive

public hudson.util.FormValidation doCheckSoundArchive(@QueryParameter
                                                      String value)

Checks that a resource can be found at the specified location.

Parameters:

value - the value parameter from the request

Returns:

a FormValidation

playSoundFromUrl

protected void playSoundFromUrl(URL url,
                                Integer afterDelayMs,
                                hudson.EnvVars vars)
                         throws UnplayableSoundBiteException

Throws:

UnplayableSoundBiteException

playSound

protected void playSound(String id)
                  throws UnplayableSoundBiteException

Throws:

UnplayableSoundBiteException

playSound

protected void playSound(String id,
                         hudson.EnvVars vars)
                  throws UnplayableSoundBiteException

Throws:

UnplayableSoundBiteException

playSound

protected void playSound(String id,
                         Integer afterDelayMs,
                         hudson.EnvVars vars)
                  throws UnplayableSoundBiteException

Throws:

UnplayableSoundBiteException

getSoundBiteInputStream

protected InputStream getSoundBiteInputStream(HudsonSoundsNotifier.HudsonSoundsDescriptor.SoundBite soundBite)
                                       throws IOException,
                                              URISyntaxException

Throws:

IOException

URISyntaxException