hudson.plugins.ircbot

Class IrcPublisher.DescriptorImpl

java.lang.Object

hudson.model.Descriptor<T>

hudson.tasks.BuildStepDescriptor<Publisher>

hudson.plugins.ircbot.IrcPublisher.DescriptorImpl

All Implemented Interfaces:

Saveable, hudson.plugins.im.IMPublisherDescriptor, OnMaster

Enclosing class:

IrcPublisher

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

Descriptor for IrcPublisher

Nested Class Summary

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

Descriptor.FormException, Descriptor.PropertyType, Descriptor.Self

Field Summary

Fields

Modifier and Type	Field and Description
static String[]	CHARSETS

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	getJenkinsLogin()
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() Deprecated. use getSecretNickServPassword()
hudson.plugins.im.config.ParameterNames	getParamNames()
String	getPluginDescription()
int	getPort()
Secret	getSecretNickServPassword()
Secret	getSecretPassword()
String	getSocksHost()
int	getSocksPort()
String	getUserName()
boolean	isApplicable(Class<? extends AbstractProject> jobType)
boolean	isDisallowPrivateChat()
boolean	isEnabled()
boolean	isExposePresence()
boolean	isSasl()
boolean	isSsl()
boolean	isSslTrustAllCertificates()
boolean	isTrustAllCertificates()
boolean	isUseColors()
boolean	isUseNotice()
Publisher	newInstance(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject formData)
protected Object	readResolve() Deserialize old descriptors.
void	setCharset(String charset)
void	setCommandPrefix(String commandPrefix)
void	setDefaultTargets(List<hudson.plugins.im.IMMessageTarget> defaultTargets)
void	setDisallowPrivateChat(boolean disallowPrivateChat)
void	setEnabled(boolean enabled)
void	setHostname(String hostname)
void	setJenkinsLogin(String jenkinsLogin)
void	setLogin(String login)
void	setMessageRate(Integer messageRate)
void	setNick(String nick)
void	setPort(int port)
void	setSasl(boolean sasl)
void	setSecretNickServPassword(Secret secretNickServPassword)
void	setSecretPassword(Secret secretPassword)
void	setSocksHost(String socksHost)
void	setSocksPort(Integer socksPort)
void	setSsl(boolean ssl)
void	setSslTrustAllCertificates(boolean sslTrustAllCertificates)
void	setUseColors(boolean useColors)
void	setUseNotice(boolean useNotice)

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, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, getRequiredGlobalConfigPagePermission, 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

Methods inherited from interface hudson.plugins.im.IMPublisherDescriptor

getPassword

Field Detail

CHARSETS

public static final String[] CHARSETS

Method Detail

configure

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

Overrides:

configure in class Descriptor<Publisher>

Throws:

Descriptor.FormException

See Also:

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

getDisplayName

public String getDisplayName()

Overrides:

getDisplayName in class Descriptor<Publisher>

See Also:

Descriptor.getDisplayName()

getHelpFile

public String getHelpFile()

Overrides:

getHelpFile in class Descriptor<Publisher>

See Also:

Descriptor.getHelpFile()

newInstance

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

Overrides:

newInstance in class Descriptor<Publisher>

Throws:

Descriptor.FormException

isApplicable

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

Specified by:

isApplicable in class BuildStepDescriptor<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

getJenkinsLogin

public String getJenkinsLogin()

setJenkinsLogin

public void setJenkinsLogin(String jenkinsLogin)

getNick

public String getNick()

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

Returns:

the nick

getNickServPassword

@Deprecated
public String getNickServPassword()

Deprecated. use getSecretNickServPassword()

Returns:

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

getSecretNickServPassword

public Secret getSecretNickServPassword()

getLogin

public String getLogin()

getSecretPassword

public Secret getSecretPassword()

Specified by:

getSecretPassword in interface hudson.plugins.im.IMPublisherDescriptor

isSasl

public boolean isSasl()

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

setEnabled

public void setEnabled(boolean enabled)

setHostname

public void setHostname(String hostname)

setPort

public void setPort(int port)

setSsl

public void setSsl(boolean ssl)

setDisallowPrivateChat

public void setDisallowPrivateChat(boolean disallowPrivateChat)

setLogin

public void setLogin(String login)

isSslTrustAllCertificates

public boolean isSslTrustAllCertificates()

setSslTrustAllCertificates

public void setSslTrustAllCertificates(boolean sslTrustAllCertificates)

setSecretPassword

public void setSecretPassword(Secret secretPassword)

setSasl

public void setSasl(boolean sasl)

setNick

public void setNick(String nick)

setSecretNickServPassword

public void setSecretNickServPassword(Secret secretNickServPassword)

setSocksHost

public void setSocksHost(String socksHost)

setSocksPort

public void setSocksPort(Integer socksPort)

setMessageRate

public void setMessageRate(Integer messageRate)

setDefaultTargets

public void setDefaultTargets(List<hudson.plugins.im.IMMessageTarget> defaultTargets)

setCommandPrefix

public void setCommandPrefix(String commandPrefix)

setUseNotice

public void setUseNotice(boolean useNotice)

setCharset

public void setCharset(String charset)

setUseColors

public void setUseColors(boolean useColors)

getIMMessageTargetConverter

public hudson.plugins.im.IMMessageTargetConverter getIMMessageTargetConverter()

Specified by:

getIMMessageTargetConverter in interface hudson.plugins.im.IMPublisherDescriptor

isUseNotice

public boolean isUseNotice()

Returns:

Boolean flag which specifies if the bot should use the /notice command instead of the /msg command to notify.

isUseColors

public boolean isUseColors()

Returns:

Boolean flag which 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

readResolve

protected Object readResolve()

Deserialize old descriptors.