Package com.sun.enterprise.connectors.jms.config

Interface JmsAvailability

All Superinterfaces:

AvailabilityServiceExtension, ConfigBeanProxy, ConfigExtension, Container, PropertyBag

public interface JmsAvailability
extends ConfigExtension, PropertyBag, AvailabilityServiceExtension

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	Description
String	getAvailabilityEnabled()	Gets the value of the availabilityEnabled property.
@Pattern(regexp="(masterbroker|shareddb)") String	getConfigStoreType()	Gets the value of the Config Store type property This attribute specifies whether to use a master broker or a Shared Database for conventional MQ clusters This is a no-op for Enhanced clusters
String	getDbPassword()	Gets the value of the DB Password property.
String	getDbUrl()	Gets the value of the JDBC URL property.
String	getDbUsername()	Gets the value of the DB User Name property.
String	getDbVendor()	Gets the value of the DB Vendor property.
@Pattern(regexp="(file|jdbc)") String	getMessageStoreType()	Gets the value of the Message Store type property This attribute specifies where messages need to be stored by MQ.
String	getMqStorePoolName()	Gets the value of the MQ Store pool name property.
List<Property>	getProperty()	Properties as per PropertyBag
void	setAvailabilityEnabled(String value)	Sets the value of the availabilityEnabled property.
void	setConfigStoreType(String value)	Sets the value of the Config Store type property.
void	setDbPassword(String value)	Sets the value of the DB password property.
void	setDbUrl(String value)	Sets the value of the JDBC URL property.
void	setDbUsername(String value)	Sets the value of the DB UserName property.
void	setDbVendor(String value)	Sets the value of the DB Vendor property.
void	setMessageStoreType(String value)	Sets the value of the Message store type property.
void	setMqStorePoolName(String value)	Sets the value of the MQ store pool name 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

getAvailabilityEnabled

String getAvailabilityEnabled()

Gets the value of the availabilityEnabled property. This boolean flag controls whether the MQ cluster associated with the application server cluster is HA enabled or not. If this attribute is "false", then the MQ cluster pointed to by the jms-service element is considered non-HA (Conventional MQ cluster). JMS Messages are not persisted to a highly availablestore. If this attribute is "true" the MQ cluster pointed to by the jms-service element is a HA (enhanced) cluster and the MQ cluster uses the database pointed to by jdbcurl to save persistent JMS messages and other broker cluster configuration information. Individual applications will not be able to control or override MQ cluster availability levels. They inherit the availability attribute defined in this element. If this attribute is missing, availability is turned off by default [i.e. the MQ cluster associated with the AS cluster would behave as a non-HA cluster]

Returns:

possible object is String

setAvailabilityEnabled

void setAvailabilityEnabled(String value)
                     throws PropertyVetoException

Sets the value of the availabilityEnabled property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getConfigStoreType

@Pattern(regexp="(masterbroker|shareddb)")
@Pattern(regexp="(masterbroker|shareddb)") String getConfigStoreType()

Gets the value of the Config Store type property This attribute specifies whether to use a master broker or a Shared Database for conventional MQ clusters This is a no-op for Enhanced clusters

Returns:

possible object is String

setConfigStoreType

void setConfigStoreType(String value)

Sets the value of the Config Store type property.

Parameters:

value - allowed object is String

getMessageStoreType

@Pattern(regexp="(file|jdbc)")
@Pattern(regexp="(file|jdbc)") String getMessageStoreType()

Gets the value of the Message Store type property This attribute specifies where messages need to be stored by MQ. The options are file based or Database based storage This is only relevent for conventional MQ clusters This is a no-op for enhanced clusters

Returns:

possible object is String

setMessageStoreType

void setMessageStoreType(String value)

Sets the value of the Message store type property.

Parameters:

value - allowed object is String

getDbVendor

String getDbVendor()

Gets the value of the DB Vendor property. This is the DB Vendor Name for the DB used by the MQ broker cluster for use in saving persistent JMS messages and other broker cluster configuration information.

Returns:

possible object is String

setDbVendor

void setDbVendor(String value)
          throws PropertyVetoException

Sets the value of the DB Vendor property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getDbUsername

String getDbUsername()

Gets the value of the DB User Name property. This is the DB user Name for the DB used by the MQ broker cluster for use in saving persistent JMS messages and other broker cluster configuration information.

Returns:

possible object is String

setDbUsername

void setDbUsername(String value)
            throws PropertyVetoException

Sets the value of the DB UserName property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getDbPassword

String getDbPassword()

Gets the value of the DB Password property. This is the DB Password for the DB used by the MQ broker cluster for use in saving persistent JMS messages and other broker cluster configuration information.

Returns:

possible object is String

setDbPassword

void setDbPassword(String value)
            throws PropertyVetoException

Sets the value of the DB password property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getDbUrl

String getDbUrl()

Gets the value of the JDBC URL property. This is the JDBC URL used by the MQ broker cluster for use in saving persistent JMS messages and other broker cluster configuration information.

Returns:

possible object is String

setDbUrl

void setDbUrl(String value)
       throws PropertyVetoException

Sets the value of the JDBC URL property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getMqStorePoolName

String getMqStorePoolName()

Gets the value of the MQ Store pool name property.

Returns:

possible object is String

setMqStorePoolName

void setMqStorePoolName(String value)
                 throws PropertyVetoException

Sets the value of the MQ store pool name property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getProperty

@ToDo(priority=IMPORTANT,
      details="Provide PropertyDesc for legal props")
@PropertiesDesc(props={})
List<Property> getProperty()

Properties as per PropertyBag

Specified by:

getProperty in interface PropertyBag

Returns:

the property list