hudson.plugins.sametime.im.transport

Class SametimePublisherDescriptor

java.lang.Object

hudson.model.Descriptor<T>

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

hudson.plugins.sametime.im.transport.SametimePublisherDescriptor

All Implemented Interfaces:

hudson.model.Saveable

public class SametimePublisherDescriptor
extends hudson.tasks.BuildStepDescriptor<hudson.tasks.Publisher>

Descriptor for the SametimePublisher. A Descriptor is an object that has metadata about a Describable object, and also serves as a factory.

Since:

18 Jan 2008

Author:

Jamie Burrell

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	DEFAULT_COMMAND_PREFIX DEFAULT_COMMAND_PREFIX
static String	PARAMETERNAME_COMMAND_PREFIX Name for the COMMAND_PREFIX parameter, as it appears in the jelly scripts
static String	PARAMETERNAME_HOSTNAME Name for the HOSTNAME parameter, as it appears in the jelly scripts
static String	PARAMETERNAME_INITIAL_GROUPCHATS Name for the INITIAL_GROUPCHATS parameter, as it appears in the jelly scripts
static String	PARAMETERNAME_NICKNAME Name for the NICKNAME parameter, as it appears in the jelly scripts
static String	PARAMETERNAME_NOTIFY_FIXERS Name for the NOTIFY_FIXERS parameter, as it appears in the jelly scripts
static String	PARAMETERNAME_NOTIFY_START Name for the NOTIFY_START parameter, as it appears in the jelly scripts
static String	PARAMETERNAME_NOTIFY_SUSPECTS Name for the NOTIFY_SUSPECTS parameter, as it appears in the jelly scripts
static String	PARAMETERNAME_PASSWORD Name for the PASSWORD parameter, as it appears in the jelly scripts
static String	PARAMETERNAME_PORT Name for the PORT parameter, as it appears in the jelly scripts
static String	PARAMETERNAME_PRESENCE Name for the PRESENCE parameter, as it appears in the jelly scripts
static String	PARAMETERNAME_STRATEGY Name for the STRATEGY parameter, as it appears in the jelly scripts
static String	PARAMETERNAME_TARGETS Name for the TARGETS parameter, as it appears in the jelly scripts
static String	PARAMETERVALUE_STRATEGY_ALL Default value for the STRATEGY_ALL parameter
static String	PARAMETERVALUE_STRATEGY_DEFAULT Default value for the STRATEGY_DEFAULT parameter
static String	PARAMETERVALUE_STRATEGY_FAILURE Default value for the STRATEGY_FAILURE parameter
static String	PARAMETERVALUE_STRATEGY_STATE_CHANGE Default value for the STRATEGY_STATE_CHANGE parameter
static String[]	PARAMETERVALUE_STRATEGY_VALUES Default value for the STRATEGY_VALUES parameter

Fields inherited from class hudson.model.Descriptor

clazz

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor and Description
SametimePublisherDescriptor() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	configure(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject formData)
hudson.util.FormValidation	doServerCheck(String value) Validates the server name.
String	getCommandPrefix() Accessor for the prefix used in sending commands.
String	getDisplayName() This human readable name is used in the configuration screen.
String	getHostname() Getter method for the hostname field.
String	getHudsonNickname() Getter method for the hudsonNickname field.
String	getHudsonPassword() Getter method for the hudsonPassword field.
String	getInitialGroupChats() Gets the whitespace separated list of group chats to join, or null if nothing is configured.
int	getPort() Getter method for the port field.
String	getPortString() Returns the text to be put into the form field.
boolean	isApplicable(Class<? extends hudson.model.AbstractProject> jobType)
boolean	isExposePresence() Whether to show up on Sametime as accessible.
SametimePublisher	newInstance(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject formData) Creates a new instance of SametimePublisher from a submitted form.
void	shutdown() Shuts down the connection etc.

Methods inherited from class hudson.tasks.BuildStepDescriptor

filter

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, calcAutoCompleteSettings, calcFillSettings, configure, doHelp, find, find, getCheckUrl, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getGlobalConfigPage, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, 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_PORT

public static final String PARAMETERNAME_PORT

Name for the PORT parameter, as it appears in the jelly scripts

See Also:

Constant Field Values

PARAMETERNAME_HOSTNAME

public static final String PARAMETERNAME_HOSTNAME

Name for the HOSTNAME parameter, as it appears in the jelly scripts

See Also:

Constant Field Values

PARAMETERNAME_PRESENCE

public static final String PARAMETERNAME_PRESENCE

Name for the PRESENCE parameter, as it appears in the jelly scripts

See Also:

Constant Field Values

PARAMETERNAME_PASSWORD

public static final String PARAMETERNAME_PASSWORD

Name for the PASSWORD parameter, as it appears in the jelly scripts

See Also:

Constant Field Values

PARAMETERNAME_NICKNAME

public static final String PARAMETERNAME_NICKNAME

Name for the NICKNAME parameter, as it appears in the jelly scripts

See Also:

Constant Field Values

PARAMETERNAME_TARGETS

public static final String PARAMETERNAME_TARGETS

Name for the TARGETS parameter, as it appears in the jelly scripts

See Also:

Constant Field Values

PARAMETERNAME_STRATEGY

public static final String PARAMETERNAME_STRATEGY

Name for the STRATEGY parameter, as it appears in the jelly scripts

See Also:

Constant Field Values

PARAMETERNAME_NOTIFY_START

public static final String PARAMETERNAME_NOTIFY_START

Name for the NOTIFY_START parameter, as it appears in the jelly scripts

See Also:

Constant Field Values

PARAMETERNAME_NOTIFY_SUSPECTS

public static final String PARAMETERNAME_NOTIFY_SUSPECTS

Name for the NOTIFY_SUSPECTS parameter, as it appears in the jelly scripts

See Also:

Constant Field Values

PARAMETERNAME_NOTIFY_FIXERS

public static final String PARAMETERNAME_NOTIFY_FIXERS

Name for the NOTIFY_FIXERS parameter, as it appears in the jelly scripts

See Also:

Constant Field Values

PARAMETERNAME_INITIAL_GROUPCHATS

public static final String PARAMETERNAME_INITIAL_GROUPCHATS

Name for the INITIAL_GROUPCHATS parameter, as it appears in the jelly scripts

See Also:

Constant Field Values

PARAMETERNAME_COMMAND_PREFIX

public static final String PARAMETERNAME_COMMAND_PREFIX

Name for the COMMAND_PREFIX parameter, as it appears in the jelly scripts

See Also:

Constant Field Values

PARAMETERVALUE_STRATEGY_ALL

public static final String PARAMETERVALUE_STRATEGY_ALL

Default value for the STRATEGY_ALL parameter

See Also:

Constant Field Values

PARAMETERVALUE_STRATEGY_FAILURE

public static final String PARAMETERVALUE_STRATEGY_FAILURE

Default value for the STRATEGY_FAILURE parameter

See Also:

Constant Field Values

PARAMETERVALUE_STRATEGY_STATE_CHANGE

public static final String PARAMETERVALUE_STRATEGY_STATE_CHANGE

Default value for the STRATEGY_STATE_CHANGE parameter

See Also:

Constant Field Values

PARAMETERVALUE_STRATEGY_VALUES

public static final String[] PARAMETERVALUE_STRATEGY_VALUES

Default value for the STRATEGY_VALUES parameter

PARAMETERVALUE_STRATEGY_DEFAULT

public static final String PARAMETERVALUE_STRATEGY_DEFAULT

Default value for the STRATEGY_DEFAULT parameter

See Also:

Constant Field Values

DEFAULT_COMMAND_PREFIX

public static final String DEFAULT_COMMAND_PREFIX

DEFAULT_COMMAND_PREFIX

See Also:

Constant Field Values

Constructor Detail

SametimePublisherDescriptor

public SametimePublisherDescriptor()

Constructor.

Method Detail

getDisplayName

public String getDisplayName()

This human readable name is used in the configuration screen.

Specified by:

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

getPortString

public String getPortString()

Returns the text to be put into the form field. If the port is default, leave it empty.

Returns:

The text.

isExposePresence

public boolean isExposePresence()

Whether to show up on Sametime as accessible.

Returns:

true or false

getInitialGroupChats

public String getInitialGroupChats()

Gets the whitespace separated list of group chats to join, or null if nothing is configured.

Returns:

The list.

getCommandPrefix

public String getCommandPrefix()

Accessor for the prefix used in sending commands.

Returns:

The prefix.

isApplicable

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

Specified by:

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

newInstance

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

Creates a new instance of SametimePublisher from a submitted form.

Overrides:

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

Throws:

hudson.model.Descriptor.FormException

shutdown

public void shutdown()

Shuts down the connection etc.

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

doServerCheck

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

Validates the server name.

Parameters:

req - The Stapler request

rsp - The response

Throws:

IOException

javax.servlet.ServletException

getPort

public int getPort()

Getter method for the port field.

Returns:

The port property.

getHostname

public String getHostname()

Getter method for the hostname field.

Returns:

The hostname property.

getHudsonNickname

public String getHudsonNickname()

Getter method for the hudsonNickname field.

Returns:

The hudsonNickname property.

getHudsonPassword

public String getHudsonPassword()

Getter method for the hudsonPassword field.

Returns:

The hudsonPassword property.