com.sonymobile.jenkins.plugins.mq.mqnotifier

Class MQNotifierConfig

java.lang.Object

hudson.Plugin

com.sonymobile.jenkins.plugins.mq.mqnotifier.MQNotifierConfig

All Implemented Interfaces:

Describable<MQNotifierConfig>, Saveable, org.kohsuke.stapler.StaplerProxy

@Extension
public final class MQNotifierConfig
extends Plugin
implements Describable<MQNotifierConfig>

Adds the MQ notifier plugin configuration to the system config page.

Author:

Örjan Percy <orjan.percy@sonymobile.com>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MQNotifierConfig.DescriptorImpl Implementation of the Descriptor interface.

Nested classes/interfaces inherited from class hudson.Plugin

Plugin.DummyImpl

Field Summary

Fields inherited from class hudson.Plugin

SKIP_PERMISSION_CHECK

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor and Description
MQNotifierConfig() Load configuration on invoke.
MQNotifierConfig(boolean enableNotifier, String serverUri, String userName, Secret userPassword, String exchangeName, String virtualHost, String routingKey, boolean persistentDelivery, String appId, boolean enableVerboseLogging) Creates an instance with specified parameters.

Method Summary

Modifier and Type	Method and Description
void	configure(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject formData)
String	getAppId() Returns application id.
Descriptor<MQNotifierConfig>	getDescriptor() Returns the descriptor instance.
String	getExchangeName() Gets the exchange name.
static MQNotifierConfig	getInstance() Gets this extension's instance.
boolean	getPersistentDelivery() Returns true if persistentDelivery is to be used.
String	getRoutingKey() Gets the routing key.
String	getServerUri() Gets URI for MQ server.
String	getUserName() Gets user name.
Secret	getUserPassword() Gets user password.
String	getVirtualHost() Gets the virtual host name.
boolean	isNotifierEnabled() Gets whether this plugin is enabled or not.
boolean	isVerboseLoggingEnabled() Gets whether verbose logging is enabled or not.
void	setAppId(String appId) Sets application id.
void	setEnableNotifier(boolean enableNotifier) Sets flag whether this plugin is enabled or not.
void	setEnableVerboseLogging(boolean enableVerboseLogging) Sets flag whether verbose logging is enabled or not.
void	setExchangeName(String exchangeName) Sets the exchange name.
void	setPersistentDelivery(boolean pd) Sets persistent delivery mode.
void	setRoutingKey(String routingKey) Sets the routing key.
void	setServerUri(String serverUri) Sets URI for MQ server.
void	setUserName(String userName) Sets user name.
void	setUserPassword(Secret userPassword) Sets user password.
void	setVirtualHost(String virtualHost) Sets the virtual host name.
void	start()

Methods inherited from class hudson.Plugin

configure, doDynamic, getConfigXml, getTarget, getWrapper, load, postInitialize, save, setServletContext, stop

Methods inherited from class java.lang.Object

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

Constructor Detail

MQNotifierConfig

@DataBoundConstructor
public MQNotifierConfig(boolean enableNotifier,
                                              String serverUri,
                                              String userName,
                                              Secret userPassword,
                                              String exchangeName,
                                              String virtualHost,
                                              String routingKey,
                                              boolean persistentDelivery,
                                              String appId,
                                              boolean enableVerboseLogging)

Creates an instance with specified parameters.

Parameters:

enableNotifier - if this plugin is enabled

serverUri - the server uri

userName - the user name

userPassword - the user password

exchangeName - the name of the exchange

virtualHost - the name of the virtual host

routingKey - the routing key

persistentDelivery - if using persistent delivery mode

appId - the application id

enableVerboseLogging - if verbose logging is enabled

MQNotifierConfig

public MQNotifierConfig()

Load configuration on invoke.

Method Detail

start

public void start()
           throws Exception

Overrides:

start in class Plugin

Throws:

Exception

configure

public void configure(org.kohsuke.stapler.StaplerRequest req,
                      net.sf.json.JSONObject formData)
               throws IOException,
                      javax.servlet.ServletException,
                      Descriptor.FormException

Overrides:

configure in class Plugin

Throws:

IOException

javax.servlet.ServletException

Descriptor.FormException

isNotifierEnabled

public boolean isNotifierEnabled()

Gets whether this plugin is enabled or not.

Returns:

true if this plugin is enabled.

setEnableNotifier

public void setEnableNotifier(boolean enableNotifier)

Sets flag whether this plugin is enabled or not.

Parameters:

enableNotifier - true if this plugin is enabled.

isVerboseLoggingEnabled

public boolean isVerboseLoggingEnabled()

Gets whether verbose logging is enabled or not.

Returns:

true if verbose logging is enabled.

setEnableVerboseLogging

public void setEnableVerboseLogging(boolean enableVerboseLogging)

Sets flag whether verbose logging is enabled or not.

Parameters:

enableVerboseLogging - true if this verbose logging is enabled.

getServerUri

public String getServerUri()

Gets URI for MQ server.

Returns:

the URI.

setServerUri

public void setServerUri(String serverUri)

Sets URI for MQ server.

Parameters:

serverUri - the URI.

getUserName

public String getUserName()

Gets user name.

Returns:

the user name.

setUserName

public void setUserName(String userName)

Sets user name.

Parameters:

userName - the user name.

getUserPassword

public Secret getUserPassword()

Gets user password.

Returns:

the user password.

setUserPassword

public void setUserPassword(Secret userPassword)

Sets user password.

Parameters:

userPassword - the user password.

getInstance

public static MQNotifierConfig getInstance()

Gets this extension's instance.

If Jenkins.getInstance() isn't available or the plugin class isn't registered null will be returned.

Returns:

the instance of this extension.

getExchangeName

public String getExchangeName()

Gets the exchange name.

Returns:

the exchange name.

setExchangeName

public void setExchangeName(String exchangeName)

Sets the exchange name.

Parameters:

exchangeName - the exchange name.

getVirtualHost

public String getVirtualHost()

Gets the virtual host name.

Returns:

the virtual host name.

setVirtualHost

public void setVirtualHost(String virtualHost)

Sets the virtual host name.

Parameters:

virtualHost - the exchange name.

getRoutingKey

public String getRoutingKey()

Gets the routing key.

Returns:

the routing key.

setRoutingKey

public void setRoutingKey(String routingKey)

Sets the routing key.

Parameters:

routingKey - the routing key.

getPersistentDelivery

public boolean getPersistentDelivery()

Returns true if persistentDelivery is to be used.

Returns:

if persistentDelivery is to be used.

setPersistentDelivery

public void setPersistentDelivery(boolean pd)

Sets persistent delivery mode.

Parameters:

pd - if persistentDelivery is to be used.

getAppId

public String getAppId()

Returns application id.

Returns:

application id.

setAppId

public void setAppId(String appId)

Sets application id.

Parameters:

appId - Application id to use

getDescriptor

public Descriptor<MQNotifierConfig> getDescriptor()

Returns the descriptor instance.

Specified by:

getDescriptor in interface Describable<MQNotifierConfig>

Returns:

descriptor instance.