hudson.plugins.ircbot

Class IrcPublisher.DescriptorImpl

java.lang.Object

hudson.model.Descriptor<T>

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

hudson.plugins.ircbot.IrcPublisher.DescriptorImpl

All Implemented Interfaces:

hudson.model.Saveable, hudson.plugins.im.IMPublisherDescriptor

Enclosing class:

IrcPublisher

public static final class IrcPublisher.DescriptorImpl
extends hudson.tasks.BuildStepDescriptor<hudson.tasks.Publisher>
implements hudson.plugins.im.IMPublisherDescriptor

Descriptor for IrcPublisher

Nested Class Summary

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 String[]	CHARSETS
static String	PARAMETERNAME_NICKSERV_PASSWORD
static String	PARAMETERNAME_USE_COLORS
static String	PARAMETERNAME_USE_NOTICE

Fields inherited from class hudson.model.Descriptor

clazz

Fields inherited from interface hudson.plugins.im.IMPublisherDescriptor

PARAMETERVALUE_STRATEGY_DEFAULT, PARAMETERVALUE_STRATEGY_VALUES

Fields inherited from interface hudson.model.Saveable

NOOP

Method Summary

Modifier and Type	Method and Description
boolean	configure(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject formData)
String	getCharset()
String	getCommandPrefix()
String	getDefaultIdSuffix()
List<hudson.plugins.im.IMMessageTarget>	getDefaultTargets()
String	getDisplayName()
String	getHelpFile()
String	getHost()
String	getHostname()
String	getHudsonUserName()
hudson.plugins.im.IMMessageTargetConverter	getIMMessageTargetConverter()
String	getLogin()
Integer	getMessageRate()
protected Integer	getMessageRateFromSystemProperty() Fetches message rate, defaults to 0.5 second if none are set or invalid value.
String	getNick() Returns the nickname that should be used to identify against the IRC server.
String	getNickServPassword() Returns the password that should be used to try and identify with NickServ.
hudson.plugins.im.config.ParameterNames	getParamNames()
String	getPassword()
String	getPluginDescription()
int	getPort()
String	getSocksHost()
int	getSocksPort()
String	getUserName()
boolean	isApplicable(Class<? extends hudson.model.AbstractProject> jobType)
boolean	isDisallowPrivateChat()
boolean	isEnabled()
boolean	isExposePresence()
boolean	isSsl()
boolean	isTrustAllCertificates()
boolean	isUseColors() Specifies if the bot should send message with colors.
boolean	isUseNotice() Specifies if the bot should use the /notice command instead of the /msg command to notify.
hudson.tasks.Publisher	newInstance(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject formData)

Methods inherited from class hudson.tasks.BuildStepDescriptor

filter

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, calcAutoCompleteSettings, calcFillSettings, configure, doHelp, find, find, getCheckMethod, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getGlobalConfigPage, getGlobalPropertyType, 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

PARAMETERNAME_USE_NOTICE

public static final String PARAMETERNAME_USE_NOTICE

See Also:

Constant Field Values

PARAMETERNAME_USE_COLORS

public static final String PARAMETERNAME_USE_COLORS

See Also:

Constant Field Values

PARAMETERNAME_NICKSERV_PASSWORD

public static final String PARAMETERNAME_NICKSERV_PASSWORD

See Also:

Constant Field Values

CHARSETS

public static final String[] CHARSETS

Method Detail

configure

public boolean configure(org.kohsuke.stapler.StaplerRequest req,
                         net.sf.json.JSONObject formData)
                  throws hudson.model.Descriptor.FormException

Overrides:

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

Throws:

hudson.model.Descriptor.FormException

See Also:

Descriptor.configure(org.kohsuke.stapler.StaplerRequest)

getDisplayName

public String getDisplayName()

Specified by:

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

See Also:

Descriptor.getDisplayName()

getHelpFile

public String getHelpFile()

Overrides:

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

See Also:

Descriptor.getHelpFile()

newInstance

public hudson.tasks.Publisher newInstance(org.kohsuke.stapler.StaplerRequest req,
                                          net.sf.json.JSONObject formData)
                                   throws hudson.model.Descriptor.FormException

Overrides:

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

Throws:

hudson.model.Descriptor.FormException

See Also:

Descriptor.newInstance(org.kohsuke.stapler.StaplerRequest)

isApplicable

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

Specified by:

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

getCommandPrefix

public String getCommandPrefix()

Specified by:

getCommandPrefix in interface hudson.plugins.im.IMPublisherDescriptor

Returns:

the commandPrefix

getHostname

public String getHostname()

Specified by:

getHostname in interface hudson.plugins.im.IMPublisherDescriptor

Returns:

the hostname

getNick

public String getNick()

Returns the nickname that should be used to identify against the IRC server.

Returns:

the nick

getNickServPassword

public String getNickServPassword()

Returns the password that should be used to try and identify with NickServ.

getLogin

public String getLogin()

getPassword

public String getPassword()

Specified by:

getPassword in interface hudson.plugins.im.IMPublisherDescriptor

getPort

public int getPort()

Specified by:

getPort in interface hudson.plugins.im.IMPublisherDescriptor

getSocksHost

public String getSocksHost()

getSocksPort

public int getSocksPort()

isSsl

public boolean isSsl()

isTrustAllCertificates

public boolean isTrustAllCertificates()

isDisallowPrivateChat

public boolean isDisallowPrivateChat()

getMessageRate

public Integer getMessageRate()

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface hudson.plugins.im.IMPublisherDescriptor

getDefaultIdSuffix

public String getDefaultIdSuffix()

Specified by:

getDefaultIdSuffix in interface hudson.plugins.im.IMPublisherDescriptor

getHost

public String getHost()

Specified by:

getHost in interface hudson.plugins.im.IMPublisherDescriptor

getHudsonUserName

public String getHudsonUserName()

Specified by:

getHudsonUserName in interface hudson.plugins.im.IMPublisherDescriptor

getPluginDescription

public String getPluginDescription()

Specified by:

getPluginDescription in interface hudson.plugins.im.IMPublisherDescriptor

getUserName

public String getUserName()

Specified by:

getUserName in interface hudson.plugins.im.IMPublisherDescriptor

isExposePresence

public boolean isExposePresence()

Specified by:

isExposePresence in interface hudson.plugins.im.IMPublisherDescriptor

getDefaultTargets

public List<hudson.plugins.im.IMMessageTarget> getDefaultTargets()

Specified by:

getDefaultTargets in interface hudson.plugins.im.IMPublisherDescriptor

getIMMessageTargetConverter

public hudson.plugins.im.IMMessageTargetConverter getIMMessageTargetConverter()

Specified by:

getIMMessageTargetConverter in interface hudson.plugins.im.IMPublisherDescriptor

isUseNotice

public boolean isUseNotice()

Specifies if the bot should use the /notice command instead of the /msg command to notify.

isUseColors

public boolean isUseColors()

Specifies if the bot should send message with colors.

getCharset

public String getCharset()

getParamNames

public hudson.plugins.im.config.ParameterNames getParamNames()

Specified by:

getParamNames in interface hudson.plugins.im.IMPublisherDescriptor

getMessageRateFromSystemProperty

protected Integer getMessageRateFromSystemProperty()

Fetches message rate, defaults to 0.5 second if none are set or invalid value.

Returns:

message rate in milliseconds