org.jenkinsci.plugins.rabbitmqconsumer

クラス GlobalRabbitmqConfiguration

java.lang.Object

hudson.model.Descriptor<jenkins.model.GlobalConfiguration>

jenkins.model.GlobalConfiguration

org.jenkinsci.plugins.rabbitmqconsumer.GlobalRabbitmqConfiguration

すべての実装されたインタフェース:

hudson.ExtensionPoint, hudson.model.Describable<jenkins.model.GlobalConfiguration>, hudson.model.Saveable

@Extension
public final class GlobalRabbitmqConfiguration
extends jenkins.model.GlobalConfiguration

Descriptor for global configuration.

作成者:

rinrinne a.k.a. rin_ne

ネストされたクラスのサマリー

クラスから継承されたネストされたクラス/インタフェース hudson.model.Descriptor

hudson.model.Descriptor.FormException, hudson.model.Descriptor.PropertyType, hudson.model.Descriptor.Self

インタフェースから継承されたネストされたクラス/インタフェース hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
static String	CONTENT_NONE The string in global configuration that indicates content is empty.

クラスから継承されたフィールド hudson.model.Descriptor

clazz

インタフェースから継承されたフィールド hudson.model.Saveable

NOOP

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
GlobalRabbitmqConfiguration() Create GlobalRabbitmqConfiguration from disk.
GlobalRabbitmqConfiguration(boolean enableConsumer, String serviceUri, String userName, hudson.util.Secret userPassword, long watchdogPeriod, List<RabbitmqConsumeItem> consumeItems, boolean enableDebug) Creates GlobalRabbitmqConfiguration instance with specified parameters.

メソッドのサマリー

修飾子とタイプ	メソッドと説明
boolean	configure(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject json)
hudson.util.FormValidation	doCheckServiceUri(String value) Checks given URI is valid.
hudson.util.FormValidation	doTestConnection(String serviceUri, String userName, hudson.util.Secret userPassword) Tests connection to given URI.
static GlobalRabbitmqConfiguration	get() Gets this extension's instance.
List<RabbitmqConsumeItem>	getConsumeItems() Gets the list of RabbitmqConsumeItem.
String	getDisplayName()
String	getServiceUri() Gets URI for RabbitMQ service.
String	getUserName() Gets username.
hudson.util.Secret	getUserPassword() Gets password.
long	getWatchdogPeriod() Gets the period for watchdog.
boolean	isConsume(String queueName) Gets specified queue is consumed or not.
boolean	isEnableConsumer() Gets whether this plugin is enabled or not.
boolean	isEnableDebug() Gets whether debug is enabled or not.
boolean	isOpen() Gets connection to service is established.
void	setConsumeItems(List<RabbitmqConsumeItem> consumeItems) Sets the list of RabbitmqConsumeItem.
void	setEnableConsumer(boolean enableConsumer) Sets flag whether this plugin is enabled or not.
void	setEnableDebug(boolean enableDebug) Sets flag whether debug is enabled or not.
void	setServiceUri(String serviceUri) Sets URI for RabbitMQ service.
void	setUserName(String userName) Sets username.
void	setUserPassword(hudson.util.Secret userPassword) Sets password.
void	setUserPassword(String userPassword) Sets password.
void	setWatchdogPeriod(long watchdogPeriod) Sets the period for watchdog.

クラスから継承されたメソッド jenkins.model.GlobalConfiguration

all, getDescriptor, getGlobalConfigPage

クラスから継承されたメソッド hudson.model.Descriptor

addHelpFileRedirect, calcAutoCompleteSettings, calcFillSettings, configure, doHelp, find, find, findByDescribableClassName, findById, getCategory, getCheckMethod, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, getT, getViewPage, isInstance, isSubTypeOf, load, newInstance, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, save, self, toArray, toList, toMap

クラスから継承されたメソッド java.lang.Object

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

フィールドの詳細

CONTENT_NONE

public static final String CONTENT_NONE

The string in global configuration that indicates content is empty.

関連項目:

定数フィールド値

コンストラクタの詳細

GlobalRabbitmqConfiguration

@DataBoundConstructor
public GlobalRabbitmqConfiguration(boolean enableConsumer,
                                                         String serviceUri,
                                                         String userName,
                                                         hudson.util.Secret userPassword,
                                                         long watchdogPeriod,
                                                         List<RabbitmqConsumeItem> consumeItems,
                                                         boolean enableDebug)

Creates GlobalRabbitmqConfiguration instance with specified parameters.

パラメータ:

enableConsumer - if this feature is enabled.

serviceUri - the service URI.

userName - the username.

userPassword - the password.

watchdogPeriod - the period for watchdog in milliseconds.

consumeItems - the list of consumer items.

enableDebug - true if debug is enabled.

GlobalRabbitmqConfiguration

public GlobalRabbitmqConfiguration()

Create GlobalRabbitmqConfiguration from disk.

メソッドの詳細

getDisplayName

public String getDisplayName()

オーバーライド:

getDisplayName クラス内 hudson.model.Descriptor<jenkins.model.GlobalConfiguration>

configure

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

オーバーライド:

configure クラス内 hudson.model.Descriptor<jenkins.model.GlobalConfiguration>

例外:

hudson.model.Descriptor.FormException

isEnableDebug

public boolean isEnableDebug()

Gets whether debug is enabled or not.

戻り値:

true if debug is enabled.

setEnableDebug

public void setEnableDebug(boolean enableDebug)

Sets flag whether debug is enabled or not.

パラメータ:

enableDebug - true if debug is enabled.

isEnableConsumer

public boolean isEnableConsumer()

Gets whether this plugin is enabled or not.

戻り値:

true if this plugin is enabled.

setEnableConsumer

public void setEnableConsumer(boolean enableConsumer)

Sets flag whether this plugin is enabled or not.

パラメータ:

enableConsumer - true if this plugin is enabled.

getServiceUri

public String getServiceUri()

Gets URI for RabbitMQ service.

戻り値:

the URI.

setServiceUri

public void setServiceUri(String serviceUri)

Sets URI for RabbitMQ service.

パラメータ:

serviceUri - the URI.

getUserName

public String getUserName()

Gets username.

戻り値:

the username.

setUserName

public void setUserName(String userName)

Sets username.

パラメータ:

userName - the username.

getUserPassword

public hudson.util.Secret getUserPassword()

Gets password.

戻り値:

the password.

setUserPassword

public void setUserPassword(hudson.util.Secret userPassword)

Sets password.

パラメータ:

userPassword - the password.

setUserPassword

public void setUserPassword(String userPassword)

Sets password.

パラメータ:

userPassword - the password.

getWatchdogPeriod

public long getWatchdogPeriod()

Gets the period for watchdog.

戻り値:

the period in milliseconds.

setWatchdogPeriod

public void setWatchdogPeriod(long watchdogPeriod)

Sets the period for watchdog.

パラメータ:

watchdogPeriod - the period in milliseconds.

doCheckServiceUri

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

Checks given URI is valid.

パラメータ:

value - the URI.

戻り値:

FormValidation object that indicates ok or error.

doTestConnection

public hudson.util.FormValidation doTestConnection(@QueryParameter(value="serviceUri")
                                                   String serviceUri,
                                                   @QueryParameter(value="userName")
                                                   String userName,
                                                   @QueryParameter(value="userPassword")
                                                   hudson.util.Secret userPassword)
                                            throws javax.servlet.ServletException

Tests connection to given URI.

パラメータ:

serviceUri - the URI.

userName - the username.

userPassword - the password.

戻り値:

FormValidation object that indicates ok or error.

例外:

javax.servlet.ServletException - exception for servlet.

getConsumeItems

public List<RabbitmqConsumeItem> getConsumeItems()

Gets the list of RabbitmqConsumeItem.

戻り値:

the list of RabbitmqConsumeItem

setConsumeItems

public void setConsumeItems(List<RabbitmqConsumeItem> consumeItems)

Sets the list of RabbitmqConsumeItem.

パラメータ:

consumeItems - the list of RabbitmqConsumeItem

isOpen

@JavaScriptMethod
public boolean isOpen()

Gets connection to service is established. Note that this is called by Ajax.

戻り値:

true if connection is established.

isConsume

@JavaScriptMethod
public boolean isConsume(String queueName)

Gets specified queue is consumed or not. Note that this is called by Ajax.

パラメータ:

queueName - the queue name.

戻り値:

true if specified queue is already consumed.

get

public static GlobalRabbitmqConfiguration get()

Gets this extension's instance.

戻り値:

the instance of this extension.