hudson.plugins.im
Interface IMPublisherDescriptor

public interface IMPublisherDescriptor

Method Summary

java.lang.String	getCommandPrefix()
java.lang.String	getDefaultIdSuffix()
java.util.List<IMMessageTarget>	getDefaultTargets() Returns the default targets which should be used for build notification.
java.lang.String	getHost() Returns the hostname of the IM network.
java.lang.String	getHostname() Deprecated. Should be replaced by getHost
java.lang.String	getHudsonPassword() Returns the password needed to login into Hudson.
java.lang.String	getHudsonUserName() Returns the user name needed to login into Hudson.
IMMessageTargetConverter	getIMMessageTargetConverter()
java.lang.String	getPassword() Returns the password needed to login into the IM network.
java.lang.String	getPluginDescription() Returns an informal, short description of the concrete plugin.
int	getPort() Returns the port of the IM network..
java.lang.String	getUserName() Returns the user name needed to login into the IM network.
boolean	isEnabled() Returns true iff the plugin is globally enabled.
boolean	isExposePresence() Returns if the plugin should expose its presence on the IM network.

Method Detail

isEnabled

boolean isEnabled()

Returns true iff the plugin is globally enabled.

getPluginDescription

java.lang.String getPluginDescription()

Returns an informal, short description of the concrete plugin.

isExposePresence

boolean isExposePresence()

Returns if the plugin should expose its presence on the IM network. I.e. if it should report as 'available' or that like.

getHost

java.lang.String getHost()

Returns the hostname of the IM network. I.e. the host to which the plugin should connect.

getHostname

@Deprecated
java.lang.String getHostname()

Deprecated. Should be replaced by getHost

Returns the hostname. May be null in which case the host must be determined from the Jabber 'service name'.

getPort

int getPort()

Returns the port of the IM network..

getUserName

java.lang.String getUserName()

Returns the user name needed to login into the IM network.

getPassword

java.lang.String getPassword()

Returns the password needed to login into the IM network.

getCommandPrefix

java.lang.String getCommandPrefix()

getDefaultIdSuffix

java.lang.String getDefaultIdSuffix()

getHudsonUserName

java.lang.String getHudsonUserName()

Returns the user name needed to login into Hudson.

getHudsonPassword

java.lang.String getHudsonPassword()

Returns the password needed to login into Hudson.

getDefaultTargets

java.util.List<IMMessageTarget> getDefaultTargets()

Returns the default targets which should be used for build notification. This can be overwritten on a per job basis.

getIMMessageTargetConverter

IMMessageTargetConverter getIMMessageTargetConverter()