com.sun.enterprise.connectors.jms.config

Interface JmsService

All Superinterfaces:

ConfigBeanProxy, ConfigExtension, Container, PropertyBag

public interface JmsService
extends ConfigExtension, PropertyBag, Container

The jms-service element specifies information about the bundled/built-in JMS service that is managed by Application Server

Nested Class Summary

Nested classes/interfaces inherited from interface org.jvnet.hk2.config.ConfigBeanProxy

ConfigBeanProxy.Duck

Nested classes/interfaces inherited from interface org.jvnet.hk2.config.types.PropertyBag

PropertyBag.Duck

Method Summary

Modifier and Type	Method and Description
@Pattern(regexp="(random|priority)") String	getAddresslistBehavior() Gets the value of the addresslistBehavior property.
@Min(value=-1L) @Max(value=2147483647L) String	getAddresslistIterations() Gets the value of the addresslistIterations property.
String	getDefaultJmsHost() Gets the value of the defaultJmsHost property.
@Min(value=1L) String	getInitTimeoutInSeconds() Gets the value of the initTimeoutInSeconds property.
List<JmsHost>	getJmsHost() Gets the value of the jmsHost property.
String	getMasterBroker()
@Pattern(regexp="(mq||http)") String	getMqScheme() Gets the value of the mqScheme property.
@Pattern(regexp="(ssljms||jms)") String	getMqService() Gets the value of the mqService property.
List<Property>	getProperty() Properties.
String	getReconnectAttempts() Gets the value of the reconnectAttempts property.
String	getReconnectEnabled() Gets the value of the reconnectEnabled property.
@Min(value=1L) String	getReconnectIntervalInSeconds() Gets the value of the reconnectIntervalInSeconds property.
String	getStartArgs() Gets the value of the startArgs property.
@NotNull @Pattern(regexp="(LOCAL|EMBEDDED|REMOTE|DISABLED)") String	getType() Gets the value of the type property.
void	setAddresslistBehavior(String value) Sets the value of the addresslistBehavior property.
void	setAddresslistIterations(String value) Sets the value of the addresslistIterations property.
void	setDefaultJmsHost(String value) Sets the value of the defaultJmsHost property.
void	setInitTimeoutInSeconds(String value) Sets the value of the initTimeoutInSeconds property.
void	setMasterBroker(String value) Sets the value of the MasterBroker property.
void	setMqScheme(String value) Sets the value of the mqScheme property.
void	setMqService(String value) Sets the value of the mqService property.
void	setReconnectAttempts(String value) Sets the value of the reconnectAttempts property.
void	setReconnectEnabled(String value) Sets the value of the reconnectEnabled property.
void	setReconnectIntervalInSeconds(String value) Sets the value of the reconnectIntervalInSeconds property.
void	setStartArgs(String value) Sets the value of the startArgs property.
void	setType(String value) Sets the value of the type property.

Methods inherited from interface org.jvnet.hk2.config.ConfigBeanProxy

createChild, deepCopy, getParent, getParent

Methods inherited from interface org.jvnet.hk2.config.types.PropertyBag

addProperty, getProperty, getPropertyValue, getPropertyValue, lookupProperty, removeProperty, removeProperty

Method Detail

getInitTimeoutInSeconds

@Min(value=1L)
@Min(value=1L) String getInitTimeoutInSeconds()

Gets the value of the initTimeoutInSeconds property. specifies the time server instance will wait at start up, for its corresponding JMS service instance to respond. If there is no response within the specifies timeout period, application server startup is aborted. Default value of 60 seconds

Returns:

possible object is String

setInitTimeoutInSeconds

void setInitTimeoutInSeconds(String value)
                      throws PropertyVetoException

Sets the value of the initTimeoutInSeconds property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getType

@NotNull
 @Pattern(regexp="(LOCAL|EMBEDDED|REMOTE|DISABLED)")
@NotNull @Pattern(regexp="(LOCAL|EMBEDDED|REMOTE|DISABLED)") String getType()

Gets the value of the type property. Type of JMS service

Returns:

possible object is String

setType

void setType(String value)
      throws PropertyVetoException

Sets the value of the type property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getStartArgs

String getStartArgs()

Gets the value of the startArgs property. specifies the arguments that will be supplied to start up corresponding JMS service instance.

Returns:

possible object is String

setStartArgs

void setStartArgs(String value)
           throws PropertyVetoException

Sets the value of the startArgs property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getDefaultJmsHost

String getDefaultJmsHost()

Gets the value of the defaultJmsHost property. Reference to a jms-host that to be started when type of jms-service is LOCAL.

Returns:

possible object is String

setDefaultJmsHost

void setDefaultJmsHost(String value)
                throws PropertyVetoException

Sets the value of the defaultJmsHost property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getMasterBroker

String getMasterBroker()

setMasterBroker

void setMasterBroker(String value)
              throws PropertyVetoException

Sets the value of the MasterBroker property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getReconnectIntervalInSeconds

@Min(value=1L)
@Min(value=1L) String getReconnectIntervalInSeconds()

Gets the value of the reconnectIntervalInSeconds property. Interval between reconnect attempts, in seconds. An integer.

Returns:

possible object is String

setReconnectIntervalInSeconds

void setReconnectIntervalInSeconds(String value)
                            throws PropertyVetoException

Sets the value of the reconnectIntervalInSeconds property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getReconnectAttempts

String getReconnectAttempts()

Gets the value of the reconnectAttempts property. Total number of attempts to reconnect. An integer.

Returns:

possible object is String

setReconnectAttempts

void setReconnectAttempts(String value)
                   throws PropertyVetoException

Sets the value of the reconnectAttempts property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getReconnectEnabled

String getReconnectEnabled()

Gets the value of the reconnectEnabled property. Causes reconnect feature to be enabled (true) or disabled (false).

Returns:

possible object is String

setReconnectEnabled

void setReconnectEnabled(String value)
                  throws PropertyVetoException

Sets the value of the reconnectEnabled property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getAddresslistBehavior

@Pattern(regexp="(random|priority)")
@Pattern(regexp="(random|priority)") String getAddresslistBehavior()

Gets the value of the addresslistBehavior property. Determines broker selection from imqAddressList. random causes selection to be performed randomly priority causes selection to be performed sequentially

Returns:

possible object is String

setAddresslistBehavior

void setAddresslistBehavior(String value)
                     throws PropertyVetoException

Sets the value of the addresslistBehavior property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getAddresslistIterations

@Min(value=-1L)
 @Max(value=2147483647L)
@Min(value=-1L) @Max(value=2147483647L) String getAddresslistIterations()

Gets the value of the addresslistIterations property. Number of times reconnect logic should iterate imqAddressList. This property will not be used if the addresslist-behavior is "random".

Returns:

possible object is String

setAddresslistIterations

void setAddresslistIterations(String value)
                       throws PropertyVetoException

Sets the value of the addresslistIterations property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getMqScheme

@Pattern(regexp="(mq||http)")
@Pattern(regexp="(mq||http)") String getMqScheme()

Gets the value of the mqScheme property. Scheme for establishing connection with broker. For e.g. scheme can be specified as "http" for connecting to MQ broker over http. Default: "mq"

Returns:

possible object is String

setMqScheme

void setMqScheme(String value)
          throws PropertyVetoException

Sets the value of the mqScheme property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getMqService

@Pattern(regexp="(ssljms||jms)")
@Pattern(regexp="(ssljms||jms)") String getMqService()

Gets the value of the mqService property. Type of broker service. If a broker supports ssl, then the type of service can be "ssljms". If nothing is specified, MQ will assume that service is "jms".

Returns:

possible object is String

setMqService

void setMqService(String value)
           throws PropertyVetoException

Sets the value of the mqService property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getJmsHost

List<JmsHost> getJmsHost()

Gets the value of the jmsHost property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the jmsHost property.

For example, to add a new item, do as follows:

    getJmsHost().add(newItem);
 

Objects of the following type(s) are allowed in the list JmsHost

getProperty

@PropertyDesc(name="instance-name",defaultValue="imqbroker",description="The full Sun GlassFish Message Queue broker instance name") @PropertyDesc(name="instance-name-suffix",defaultValue="xxxxxxxxxxxxxxxxxx",description="A suffix to add to the full Message Queue broker instance name. The suffix is separated from the instance name by an underscore character (_). For example, if the instance name is \'imqbroker\', appending the suffix \'xyz\' changes the instance name to \'imqbroker_xyz\'") @PropertyDesc(name="append-version",defaultValue="",description="If true, appends the major and minor version numbers, preceded by underscore characters (_), to the full Message Queue broker instance name. For example, if the instance name is \'imqbroker\', appending the version numbers changes the instance name to imqbroker_8_0") @PropertyDesc(name="user-name",defaultValue="xxxxxxxxxxxxxxxxxx",description="Specifies the user name for creating the JMS connection. Needed only if the default username/password of guest/guest is not available in the broker") @PropertyDesc(name="password",defaultValue="xxxxxxxxxxxxxxxxxx",description="Specifies the password for creating the JMS connection. Needed only if the default username/password of guest/guest is not available in the broker")
List<Property> getProperty()

Properties.

Specified by:

getProperty in interface PropertyBag

Returns:

the property list