You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@servicemix.apache.org by ff...@apache.org on 2008/09/20 04:34:02 UTC
svn commit: r697314 - in
/servicemix/components/bindings/servicemix-jms/trunk/src/main/java/org/apache/servicemix/jms:
./ endpoints/
Author: ffang
Date: Fri Sep 19 19:34:02 2008
New Revision: 697314
URL: http://svn.apache.org/viewvc?rev=697314&view=rev
Log:
[SM-1587]Improve the generated schema documentation for the JMS component
Modified:
servicemix/components/bindings/servicemix-jms/trunk/src/main/java/org/apache/servicemix/jms/JmsComponent.java
servicemix/components/bindings/servicemix-jms/trunk/src/main/java/org/apache/servicemix/jms/JmsConfiguration.java
servicemix/components/bindings/servicemix-jms/trunk/src/main/java/org/apache/servicemix/jms/JmsEndpoint.java
servicemix/components/bindings/servicemix-jms/trunk/src/main/java/org/apache/servicemix/jms/endpoints/AbstractConsumerEndpoint.java
servicemix/components/bindings/servicemix-jms/trunk/src/main/java/org/apache/servicemix/jms/endpoints/JmsConsumerEndpoint.java
servicemix/components/bindings/servicemix-jms/trunk/src/main/java/org/apache/servicemix/jms/endpoints/JmsJcaConsumerEndpoint.java
servicemix/components/bindings/servicemix-jms/trunk/src/main/java/org/apache/servicemix/jms/endpoints/JmsProviderEndpoint.java
servicemix/components/bindings/servicemix-jms/trunk/src/main/java/org/apache/servicemix/jms/endpoints/JmsSoapConsumerEndpoint.java
servicemix/components/bindings/servicemix-jms/trunk/src/main/java/org/apache/servicemix/jms/endpoints/JmsSoapProviderEndpoint.java
Modified: servicemix/components/bindings/servicemix-jms/trunk/src/main/java/org/apache/servicemix/jms/JmsComponent.java
URL: http://svn.apache.org/viewvc/servicemix/components/bindings/servicemix-jms/trunk/src/main/java/org/apache/servicemix/jms/JmsComponent.java?rev=697314&r1=697313&r2=697314&view=diff
==============================================================================
--- servicemix/components/bindings/servicemix-jms/trunk/src/main/java/org/apache/servicemix/jms/JmsComponent.java (original)
+++ servicemix/components/bindings/servicemix-jms/trunk/src/main/java/org/apache/servicemix/jms/JmsComponent.java Fri Sep 19 19:34:02 2008
@@ -36,9 +36,9 @@
import org.apache.servicemix.jms.endpoints.JmsProviderEndpoint;
/**
+ * JMS JBI binding component
*
* @org.apache.xbean.XBean element="component"
- * description="A jms component"
*/
public class JmsComponent extends DefaultComponent {
@@ -63,6 +63,11 @@
return configuration;
}
+ /**
+ * Specifies the configuration bean used to set up the JMS connections for the endpoints.
+ *
+ * @param configuration the configuration object
+ */
public void setConfiguration(JmsConfiguration configuration) {
this.configuration = configuration;
}
@@ -71,6 +76,11 @@
return endpoints;
}
+ /**
+ * Specifies the list of endpoints hosted by the component.
+ *
+ * @param endpoints the list of endpoints
+ */
public void setEndpoints(JmsEndpointType[] endpoints) {
this.endpoints = endpoints;
}
Modified: servicemix/components/bindings/servicemix-jms/trunk/src/main/java/org/apache/servicemix/jms/JmsConfiguration.java
URL: http://svn.apache.org/viewvc/servicemix/components/bindings/servicemix-jms/trunk/src/main/java/org/apache/servicemix/jms/JmsConfiguration.java?rev=697314&r1=697313&r2=697314&view=diff
==============================================================================
--- servicemix/components/bindings/servicemix-jms/trunk/src/main/java/org/apache/servicemix/jms/JmsConfiguration.java (original)
+++ servicemix/components/bindings/servicemix-jms/trunk/src/main/java/org/apache/servicemix/jms/JmsConfiguration.java Fri Sep 19 19:34:02 2008
@@ -26,6 +26,8 @@
import javax.jms.ConnectionFactory;
/**
+ * Bean for configuring JMS connections
+ *
* @author gnodet
* @org.apache.xbean.XBean element="configuration"
*/
@@ -143,8 +145,10 @@
return password;
}
/**
- * @param password The password to set.
- */
+ * Specifies the password used to to create a connection.
+ *
+ * @param password The password to set.
+ */
public void setPassword(String password) {
this.password = password;
save();
@@ -156,8 +160,10 @@
return userName;
}
/**
- * @param userName The userName to set.
- */
+ * Specifies the user name used to create a connection.
+ *
+ * @param userName The userName to set.
+ */
public void setUserName(String userName) {
this.userName = userName;
save();
@@ -169,8 +175,10 @@
return jndiConnectionFactoryName;
}
/**
- * @param jndiName The jndiName to set.
- */
+ * Specifies the JNDI name used to look up the JMS connection factory.
+ *
+ * @param jndiName the connection factory's JNDI name
+ */
public void setJndiConnectionFactoryName(String jndiName) {
this.jndiConnectionFactoryName = jndiName;
save();
@@ -182,8 +190,10 @@
return jndiInitialContextFactory;
}
/**
- * @param jndiInitialContextFactory The jndiInitialContextFactory to set.
- */
+ * Specifies the default JNDI initial conext factory.
+ *
+ * @param jndiInitialContextFactory the JNDI initial context factory
+ */
public void setJndiInitialContextFactory(String jndiInitialContextFactory) {
this.jndiInitialContextFactory = jndiInitialContextFactory;
save();
@@ -195,7 +205,9 @@
return jndiProviderUrl;
}
/**
- * @param jndiProviderUrl The jndiProviderUrl to set.
+ * Specifies the default JNDI provider URL.
+ *
+ * @param jndiProviderUrl URL of the JNDI provider
*/
public void setJndiProviderUrl(String jndiProviderUrl) {
this.jndiProviderUrl = jndiProviderUrl;
@@ -221,8 +233,8 @@
return connectionFactory;
}
/**
- * Default ConnectionFactory to use in a spring configuration.
- * @param connectionFactory the connectionFactory to set.
+ * Default <code>ConnectionFactory</code> to use in a spring configuration.
+ * @param connectionFactory the default connection factory
*/
public void setConnectionFactory(ConnectionFactory connectionFactory) {
this.connectionFactory = connectionFactory;
Modified: servicemix/components/bindings/servicemix-jms/trunk/src/main/java/org/apache/servicemix/jms/JmsEndpoint.java
URL: http://svn.apache.org/viewvc/servicemix/components/bindings/servicemix-jms/trunk/src/main/java/org/apache/servicemix/jms/JmsEndpoint.java?rev=697314&r1=697313&r2=697314&view=diff
==============================================================================
--- servicemix/components/bindings/servicemix-jms/trunk/src/main/java/org/apache/servicemix/jms/JmsEndpoint.java (original)
+++ servicemix/components/bindings/servicemix-jms/trunk/src/main/java/org/apache/servicemix/jms/JmsEndpoint.java Fri Sep 19 19:34:02 2008
@@ -40,11 +40,13 @@
import org.apache.servicemix.store.StoreFactory;
/**
- *
+ ** non-Spring JMS endpoint
+ * This JMS endpoint can be either a consumer or a provider
+ * and is optimized to work with SOAP messages.
+ *
* @author gnodet
* @version $Revision$
* @org.apache.xbean.XBean element="endpoint"
- * description="A jms endpoint"
*
*/
public class JmsEndpoint extends SoapEndpoint implements JmsEndpointType {
@@ -114,8 +116,8 @@
}
/**
- * For a JCA consumer endpoint, indicates if the JBI exchange
- * should be sent synchronously or asynchronously.
+ * Indicates if a JCA consumer endpoint sends the JBI exchange
+ * synchronously or asynchronously.
* This changes the transaction boundary.
*
* @return the synchronous
@@ -125,13 +127,14 @@
}
/**
- * @param synchronous the synchronous to set
+ * @param synchronous <code>true</code> means the exchange is sent synchronously
*/
public void setSynchronous(boolean synchronous) {
this.synchronous = synchronous;
}
/**
+ * Indicates if the JBI exchange is rolled back if an error is encountered.
* @return the rollbackOnError
*/
public boolean isRollbackOnError() {
@@ -146,7 +149,7 @@
}
/**
- * The ActivatioSpec to use on this JCA consumer endpoint.
+ * The ActivationSpec to use on a JCA consumer endpoint.
*
* @return the activationSpec
*/
@@ -162,7 +165,7 @@
}
/**
- * The ResourceAdapter to use on this JCA consumer endpoint.
+ * The ResourceAdapter to use on a JCA consumer endpoint.
*
* @return the resourceAdapter
*/
@@ -194,7 +197,7 @@
}
/**
- * The name of the destination create by a call to
+ * The name of the destination created by a call to
* <code>Session.createQueue</code> or <code>Session.createTopic</code>.
* This property is used when <code>destination</code> and
* <code>jndiDestinationName</code> are
@@ -215,8 +218,7 @@
/**
* The name of the JMS Reply-to destination to lookup in JNDI.
- * Optional: a temporary queue will be used
- * if a replyTo is not provided.
+ * If this property is not set a temporary replyTo queue is used.
*
* @return Returns the jndiReplyToName.
*/
@@ -225,16 +227,16 @@
}
/**
- * @param jndiReplyToName The jndiReplyToName to set.
+ * @param jndiReplyToName the JNDI name of the replyTo queue
*/
public void setJndiReplyToName(String jndiReplyToName) {
this.jndiReplyToName = jndiReplyToName;
}
/**
- * The name of the reply destination create by a call to
+ * The name of the reply destination created by a call to
* <code>Session.createQueue</code> or <code>Session.createTopic</code>.
* This property is used when <code>jndiReplyToName</code> is
- * <code>null</code>. Optional: a temporary queue will be used
+ * <code>null</code>. A temporary queue will be used
* if a replyTo is not provided.
*
* @return Returns the jmsProviderReplyToName.
@@ -244,7 +246,7 @@
}
/**
- * @param jmsProviderReplyToName The jmsProviderReplyToName to set.
+ * @param jmsProviderReplyToName the name of the replyTo destination
*/
public void setJmsProviderReplyToName(String jmsProviderReplyToName) {
this.jmsProviderReplyToName = jmsProviderReplyToName;
@@ -261,7 +263,7 @@
}
/**
- * @param jndiConnectionFactoryName The jndiConnectionFactoryName to set.
+ * @param jndiConnectionFactoryName the JNDI name of the connection factory
*/
public void setJndiConnectionFactoryName(String jndiConnectionFactoryName) {
this.jndiConnectionFactoryName = jndiConnectionFactoryName;
@@ -271,14 +273,14 @@
* The name of the JMS Destination to lookup in JNDI.
* Used if <code>destination</code> is <code>null</code>.
*
- * @return Returns the jndiDestinationName.
+ * @return Returns the destination's JNDI name.
*/
public String getJndiDestinationName() {
return jndiDestinationName;
}
/**
- * @param jndiDestinationName The jndiDestinationName to set.
+ * @param jndiDestinationName the JNDI name of the JMS destination
*/
public void setJndiDestinationName(String jndiDestinationName) {
this.jndiDestinationName = jndiDestinationName;
@@ -294,14 +296,14 @@
}
/**
- * @param jndiProviderURL The jndiProviderURL to set.
+ * @param jndiProviderURL The JNDI provider URL
*/
public void setJndiProviderURL(String jndiProviderURL) {
this.jndiProviderURL = jndiProviderURL;
}
/**
- * Used to select the destination type used with the jmsProviderDestinationName.
+ * Specifies the destination type used with the jmsProviderDestinationName.
* Can be <code>queue</code> or <code>topic</code>.
*
* @return Returns the destinationStyle.
@@ -311,7 +313,7 @@
}
/**
- * @param destinationStyle The destinationStyle to set.
+ * @param destinationStyle <code>queue</code> or <code>topic</code>
*/
public void setDestinationStyle(String destinationStyle) {
this.destinationStyle = destinationStyle;
@@ -327,7 +329,7 @@
}
/**
- * @param connectionFactory The connectionFactory to set.
+ * @param connectionFactory a configured JMS ConnectionFactory
*/
public void setConnectionFactory(ConnectionFactory connectionFactory) {
this.connectionFactory = connectionFactory;
@@ -343,13 +345,15 @@
}
/**
- * @param destination The destination to set.
+ * @param destination a configured JMS destination
*/
public void setDestination(Destination destination) {
this.destination = destination;
}
/**
+ * Indicates if the JMS properties used by the endpoint need to be spec compliant.
+ *
* @return if jms properties should be spec compliant
*/
public boolean isNeedJavaIdentifiers() {
@@ -364,11 +368,10 @@
}
/**
- * The role of this endpoint.
- * Must be <code>consumer</code> or <code>provider</code>.
+ * Specifies the role of this endpoint. Endpoints can be
+ * <code>consumer</code> or <code>provider</code>.
*
- * @org.apache.xbean.Property alias="role"
- * @param role
+ * @param role the role of the endpoint
*/
public void setRoleAsString(String role) {
super.setRoleAsString(role);
@@ -381,19 +384,25 @@
return store;
}
/**
+ * Specifies a persistent data store to hold pending exchanges for the
+ * endpoint.
+ *
* @param store The store to set.
*/
public void setStore(Store store) {
this.store = store;
}
/**
+
* @return Returns the storeFactory.
*/
public StoreFactory getStoreFactory() {
return storeFactory;
}
/**
- * @param storeFactory The storeFactory to set.
+ * Specifies the factory used to create presistent data stores for this endpoint.
+ *
+ * @param storeFactory the factory used to create persistent stores
*/
public void setStoreFactory(StoreFactory storeFactory) {
this.storeFactory = storeFactory;
@@ -560,7 +569,7 @@
}
/**
- * Determines whether for a request/response pattern, the message id of the request message
+ * Indicates whether the message id of the request message
* should be used as the correlation id in the response or the correlation id of the request.
* @return
*/
@@ -576,6 +585,13 @@
return marshaler;
}
+ /**
+ * Specifies the class implementing the logic for marshaling and
+ * unmarshaling messages between the JMS destination and the endpoint.
+ * Defaults to <code>DefaultJmsMarshaler</code>.
+ *
+ * @param marshaler the marshaling class
+ */
public void setMarshaler(JmsMarshaler marshaler) {
this.marshaler = marshaler;
}
Modified: servicemix/components/bindings/servicemix-jms/trunk/src/main/java/org/apache/servicemix/jms/endpoints/AbstractConsumerEndpoint.java
URL: http://svn.apache.org/viewvc/servicemix/components/bindings/servicemix-jms/trunk/src/main/java/org/apache/servicemix/jms/endpoints/AbstractConsumerEndpoint.java?rev=697314&r1=697313&r2=697314&view=diff
==============================================================================
--- servicemix/components/bindings/servicemix-jms/trunk/src/main/java/org/apache/servicemix/jms/endpoints/AbstractConsumerEndpoint.java (original)
+++ servicemix/components/bindings/servicemix-jms/trunk/src/main/java/org/apache/servicemix/jms/endpoints/AbstractConsumerEndpoint.java Fri Sep 19 19:34:02 2008
@@ -52,6 +52,9 @@
import org.springframework.jms.support.destination.DestinationResolver;
import org.springframework.jms.support.destination.DynamicDestinationResolver;
+/**
+ * The base class for Spring-based JMS consumer endpoints.
+ */
public abstract class AbstractConsumerEndpoint extends ConsumerEndpoint {
protected static final String PROP_JMS_CONTEXT = JmsContext.class.getName();
@@ -99,6 +102,8 @@
}
/**
+ * Specifies a class implementing logic for choosing reply destinations.
+ *
* @param destinationChooser the destinationChooser to set
*/
public void setDestinationChooser(DestinationChooser destinationChooser) {
@@ -113,7 +118,10 @@
}
/**
- * @param replyDeliveryMode the replyDeliveryMode to set
+ * Specifies the JMS delivery mode used for the reply. Defaults to
+ * 2(<code>PERSISTENT</code>).
+ *
+ * @param replyDeliveryMode the JMS delivery mode
*/
public void setReplyDeliveryMode(int replyDeliveryMode) {
this.replyDeliveryMode = replyDeliveryMode;
@@ -127,7 +135,12 @@
}
/**
- * @param replyDestination the replyDestination to set
+ * Specifies the JMS <code>Destination</code> for the replies. If this value
+ * is not set the endpoint will use the <code>destinationChooser</code>
+ * property or the <code>replyDestinationName</code> property to determine
+ * the desitination to use.
+ *
+ * @param replyDestination the JMS destination for replies
*/
public void setReplyDestination(Destination replyDestination) {
this.replyDestination = replyDestination;
@@ -141,7 +154,12 @@
}
/**
- * @param replyDestinationName the replyDestinationName to set
+ * Specifies the name of the JMS destination to use for the reply. The
+ * actual JMS destination is resolved using the
+ * <code>DestinationResolver</code> specified by the
+ * <code>.destinationResolver</code> property.
+ *
+ * @param replyDestinationName the name of the reply destination
*/
public void setReplyDestinationName(String replyDestinationName) {
this.replyDestinationName = replyDestinationName;
@@ -155,7 +173,10 @@
}
/**
- * @param replyExplicitQosEnabled the replyExplicitQosEnabled to set
+ * Specifies if the QoS values specified for the endpoint are explicitly
+ * used when the reply is sent. The default is <code>false</code>.
+ *
+ * @param replyExplicitQosEnabled should the QoS values be sent?
*/
public void setReplyExplicitQosEnabled(boolean replyExplicitQosEnabled) {
this.replyExplicitQosEnabled = replyExplicitQosEnabled;
@@ -169,7 +190,9 @@
}
/**
- * @param replyPriority the replyPriority to set
+ * Specifies the JMS message priority of the reply. Defaults to 4.
+ *
+ * @param replyPriority the reply's priority
*/
public void setReplyPriority(int replyPriority) {
this.replyPriority = replyPriority;
@@ -183,7 +206,9 @@
}
/**
- * @param replyProperties the replyProperties to set
+ * Specifies custom properties to be placed in the reply's JMS header.
+ *
+ * @param replyProperties the properties to set
*/
public void setReplyProperties(Map<String, Object> replyProperties) {
this.replyProperties = replyProperties;
@@ -197,7 +222,10 @@
}
/**
- * @param replyTimeToLive the replyTimeToLive to set
+ * Specifies the number of milliseconds the reply message is valid. The
+ * default is unlimited.
+ *
+ * @param replyTimeToLive the number of milliseonds the message lives
*/
public void setReplyTimeToLive(long replyTimeToLive) {
this.replyTimeToLive = replyTimeToLive;
@@ -211,7 +239,12 @@
}
/**
- * @param useMessageIdInResponse the useMessageIdInResponse to set
+ * Specifies if the request message's ID is used as the reply's correlation
+ * ID. The default behavior is to use the request's correlation ID. Setting
+ * this to <code>true</code> means the request's message ID will be used
+ * instead.
+ *
+ * @param useMessageIdInResponse use the request's message ID as the reply'e correlation ID?
*/
public void setUseMessageIdInResponse(Boolean useMessageIdInResponse) {
this.useMessageIdInResponse = useMessageIdInResponse;
@@ -225,6 +258,8 @@
}
/**
+ * Specifies the <code>ConnectionFactory</code> used by the endpoint.
+ *
* @param connectionFactory the connectionFactory to set
*/
public void setConnectionFactory(ConnectionFactory connectionFactory) {
@@ -239,7 +274,11 @@
}
/**
- * @param pubSubDomain the pubSubDomain to set
+ * Specifies if the destination is a topic. <code>true</code> means the
+ * destination is a topic. <code>false</code> means the destination is a
+ * queue.
+ *
+ * @param pubSubDomain the destination is a topic?
*/
public void setPubSubDomain(boolean pubSubDomain) {
this.pubSubDomain = pubSubDomain;
@@ -253,7 +292,10 @@
}
/**
- * @param destinationResolver the destinationResolver to set
+ * Specifies the class implementing logic for converting strings into
+ * destinations. The default is <code>DynamicDestinationResolver</code>.
+ *
+ * @param destinationResolver the destination resolver implementation
*/
public void setDestinationResolver(DestinationResolver destinationResolver) {
this.destinationResolver = destinationResolver;
@@ -267,7 +309,11 @@
}
/**
- * @param marshaler the marshaler to set
+ * Specifies the class implementing the message marshaler. The message
+ * marshaller is responsible for marshalling and unmarshalling JMS messages.
+ * The default is <code>DefaultConsumerMarshaler</code>.
+ *
+ * @param marshaler the marshaler implementation
*/
public void setMarshaler(JmsConsumerMarshaler marshaler) {
this.marshaler = marshaler;
@@ -281,7 +327,11 @@
}
/**
- * @param synchronous the synchronous to set
+ * Specifies if the consumer will block while waiting for a response. This
+ * means the consumer can only process one message at a time. Defaults to
+ * <code>true</code>.
+ *
+ * @param synchronous the consumer blocks?
*/
public void setSynchronous(boolean synchronous) {
this.synchronous = synchronous;
@@ -291,6 +341,12 @@
return stateless;
}
+ /**
+ * Specifies if the consumer retains state information about the message
+ * exchange while it is in process.
+ *
+ * @param stateless the consumer retains state?
+ */
public void setStateless(boolean stateless) {
this.stateless = stateless;
}
@@ -299,6 +355,14 @@
return store;
}
+ /**
+ * Specifies the persistent store used to store JBI exchanges that are
+ * waiting to be processed. The store will be automatically created if not
+ * set and the endpoint's <code>stateless</code> property is set to
+ * <code>false</code>.
+ *
+ * @param store the <code>Store</code> object
+ */
public void setStore(Store store) {
this.store = store;
}
@@ -307,6 +371,14 @@
return storeFactory;
}
+ /**
+ * Specifies the store factory used to create the store.
+ * If none is set and the endpoint's <code>stateless</code> property is set
+ * to <code>false</code>, a {@link MemoryStoreFactory} will be created
+ * and used instead.
+ *
+ * @param storeFactory the <code>StoreFactory</code> object
+ */
public void setStoreFactory(StoreFactory storeFactory) {
this.storeFactory = storeFactory;
}
@@ -605,7 +677,11 @@
}
/**
- * @param jms102 the jms102 to set
+ * Specifies if the consumer uses JMS 1.0.2 compliant APIs. Defaults to
+ * <code>false</code>.
+ *
+ * @param jms102 consumer is JMS 1.0.2 compliant?
+ * @org.apache.xbean.Property description="Specifies if the consumer uses JMS 1.0.2 compliant APIs. Defaults to <code>false</code>."
*/
public void setJms102(boolean jms102) {
this.jms102 = jms102;
Modified: servicemix/components/bindings/servicemix-jms/trunk/src/main/java/org/apache/servicemix/jms/endpoints/JmsConsumerEndpoint.java
URL: http://svn.apache.org/viewvc/servicemix/components/bindings/servicemix-jms/trunk/src/main/java/org/apache/servicemix/jms/endpoints/JmsConsumerEndpoint.java?rev=697314&r1=697313&r2=697314&view=diff
==============================================================================
--- servicemix/components/bindings/servicemix-jms/trunk/src/main/java/org/apache/servicemix/jms/endpoints/JmsConsumerEndpoint.java (original)
+++ servicemix/components/bindings/servicemix-jms/trunk/src/main/java/org/apache/servicemix/jms/endpoints/JmsConsumerEndpoint.java Fri Sep 19 19:34:02 2008
@@ -44,9 +44,10 @@
import org.springframework.transaction.jta.JtaTransactionManager;
/**
- *
+ * A Sping-based JMS consumer endpoint.
+ *
* @author gnodet
- * @org.apache.xbean.XBean element="consumer"
+ * @org.apache.xbean.XBean element="consumer"
* @since 3.2
*/
public class JmsConsumerEndpoint extends AbstractConsumerEndpoint implements JmsEndpointType {
@@ -112,7 +113,10 @@
}
/**
- * @param transacted the transacted to set
+ * Specifies the type of transaction used to wrap the message exchanges.
+ * Valid values are <code>none</code>, <code>xa</code>, and <code>jms</code>.
+ *
+ * @param transacted the type of transaction wrapper to use
*/
public void setTransacted(String transacted) {
this.transacted = transacted;
@@ -126,6 +130,18 @@
}
/**
+ * Specifies the level of caching allowed by the listener. Valid values are
+ * 0 through 3. The values map to the following:
+ * <ul>
+ * <li>0 - <code>CACHE_NONE</code></li>
+ * <li>1 - <code>CACHE_CONNECTION</code></li>
+ * <li>2 - <code>CACHE_SESSION</code></li>
+ * <li>3 - <code>CACHE_CONSUMER</code></li>
+ * </ul>
+ * The default is <code>CACHE_NONE</code>.<br/>
+ * This property only effects consumers whose <code>listenerType</code>
+ * property is set to <code>default</code>.
+ *
* @param cacheLevel the cacheLevel to set
* @see org.springframework.jms.listener.DefaultMessageListenerContainer#setCacheLevel(int)
*/
@@ -141,6 +157,9 @@
}
/**
+ * Specifies the JMS client id for a shared <code>Connection</code> created and used by
+ * this listener.
+ *
* @param clientId the clientId to set
* @see org.springframework.jms.listener.AbstractMessageListenerContainer#setClientId(String)
*/
@@ -156,7 +175,11 @@
}
/**
- * @param concurrentConsumers the concurrentConsumers to set
+ * Specifies the number of concurrent consumers created by the listener.
+ * This property is only used for consumers whose <code>listenerType</code>
+ * property is set to either <code>simple</code> or <code>default</code>.
+ *
+ * @param concurrentConsumers the number of concurrent consumers to create
* @see org.springframework.jms.listener.DefaultMessageListenerContainer#setConcurrentConsumers(int)
* @see org.springframework.jms.listener.SimpleMessageListenerContainer#setConcurrentConsumers(int)
*/
@@ -172,7 +195,9 @@
}
/**
- * @param destination the destination to set
+ * Specifies the JMS <code>Destination</code> used to receive messages.
+ *
+ * @param destination the JMS destination
* @see org.springframework.jms.listener.AbstractMessageListenerContainer#setDestination(Destination)
*/
public void setDestination(Destination destination) {
@@ -187,7 +212,11 @@
}
/**
- * @param destinationName the destinationName to set
+ * Specifies a string identifying the JMS destination used to recieve
+ * messages. The destination is resolved using the
+ * <code>DesitinationResolver</code>.
+ *
+ * @param destinationName the destination name
* @see org.springframework.jms.listener.AbstractMessageListenerContainer#setDestinationName(String)
*/
public void setDestinationName(String destinationName) {
@@ -202,7 +231,9 @@
}
/**
- * @param durableSubscriptionName the durableSubscriptionName to set
+ * Specifies the name used to register the durable subscription.
+ *
+ * @param durableSubscriptionName the registration name
* @see org.springframework.jms.listener.AbstractMessageListenerContainer#setDurableSubscriptionName(String)
*/
public void setDurableSubscriptionName(String durableSubscriptionName) {
@@ -217,7 +248,11 @@
}
/**
- * @param exceptionListener the exceptionListener to set
+ * Specifies an <code>ExceptionListener</code> to notify in case of a
+ * <code>JMSException</code> is thrown by the registered message listener or
+ * the invocation infrastructure.
+ *
+ * @param exceptionListener the exception listener
* @see org.springframework.jms.listener.AbstractMessageListenerContainer#setExceptionListener(ExceptionListener)
*/
public void setExceptionListener(ExceptionListener exceptionListener) {
@@ -232,7 +267,10 @@
}
/**
- * @param listenerType the listenerType to set
+ * Specifies the type of Spring JMS message listener to use. Valid values
+ * are: <code>default</code>, <code>simple</code>, and <code>server</code>.
+ *
+ * @param listenerType the listener type
*/
public void setListenerType(String listenerType) {
this.listenerType = listenerType;
@@ -246,7 +284,12 @@
}
/**
- * @param maxMessagesPerTask the maxMessagesPerTask to set
+ * Specifies the number of attempts to receive messages per task. The
+ * default is -1 which specifies an unlimited number of attempts.<br/>
+ * This property only effects consumers whose <code>listenerType</code>
+ * property is set to either <code>default</code> or <code>simple</code>.
+ *
+ * @param maxMessagesPerTask the number of attempts to make
* @see org.springframework.jms.listener.DefaultMessageListenerContainer#setMaxMessagesPerTask(int)
* @see org.springframework.jms.listener.serversession.ServerSessionMessageListenerContainer#setMaxMessagesPerTask(int)
*/
@@ -262,7 +305,10 @@
}
/**
- * @param messageSelector the messageSelector to set
+ * Specifies the message selector string to use. The message selector string
+ * should conform to the descrition in the JMS spec.
+ *
+ * @param messageSelector the message selector string
* @see org.springframework.jms.listener.AbstractMessageListenerContainer#setMessageSelector(String)
*/
public void setMessageSelector(String messageSelector) {
@@ -277,7 +323,12 @@
}
/**
- * @param pubSubNoLocal the pubSubNoLocal to set
+ * Specifies if messages published by the listener's <code>Connection</code>
+ * are suppressed. The default is <code>false</code>.<br/>
+ * This property only effects consumers whose <code>listenerType</code>
+ * property is set to either <code>default</code> or <code>simple</code>.
+ *
+ * @param pubSubNoLocal messages are surpressed?
* @see org.springframework.jms.listener.DefaultMessageListenerContainer#setPubSubNoLocal(boolean)
* @see org.springframework.jms.listener.SimpleMessageListenerContainer#setPubSubNoLocal(boolean)
*/
@@ -293,7 +344,12 @@
}
/**
- * @param receiveTimeout the receiveTimeout to set
+ * Specifies the timeout for receiving a message in milliseconds. Defaults
+ * to 1000.<br/>
+ * This property only effects consumers whose <code>listenerType</code>
+ * property is set to <code>default</code>.
+ *
+ * @param receiveTimeout the number of milliseconds before timing out
* @see org.springframework.jms.listener.DefaultMessageListenerContainer#setReceiveTimeout(long)
*/
public void setReceiveTimeout(long receiveTimeout) {
@@ -308,7 +364,12 @@
}
/**
- * @param recoveryInterval the recoveryInterval to set
+ *Specifies the interval, in milliseconds, between attempts to recover after
+ * a failed listener set-up. Defaults to 5000.<br/>
+ * This property only effects consumers whose <code>listenerType</code>
+ * property is set to <code>default</code>.
+ *
+ * @param recoveryInterval the number of milliseconds to wait
* @see org.springframework.jms.listener.DefaultMessageListenerContainer#setRecoveryInterval(long)
*/
public void setRecoveryInterval(long recoveryInterval) {
@@ -323,7 +384,12 @@
}
/**
- * @param serverSessionFactory the serverSessionFactory to set
+ * Specifies the <code>ServerSessionFactory</code> to use. The default is
+ * <code>SimpleServerSessionFactory</code>.<br/>
+ * This property only effects consumers whose <code>listenerType</code>
+ * property is set to <code>server</code>.
+ *
+ * @param serverSessionFactory an implementation of the <code>ServerSessionFactory</code> interface
* @see ServerSessionMessageListenerContainer#setServerSessionFactory(ServerSessionFactory)
*/
public void setServerSessionFactory(ServerSessionFactory serverSessionFactory) {
@@ -338,6 +404,10 @@
}
/**
+ * Specifies the acknowledgment mode that is used when creating a
+ * <code>Session</code> to send a message. Deafults to
+ * <code>Session.AUTO_ACKNOWLEDGE</code>.
+ *
* @param sessionAcknowledgeMode the sessionAcknowledgeMode to set
* @see org.springframework.jms.support.JmsAccessor#setSessionAcknowledgeMode(int)
*/
@@ -353,7 +423,10 @@
}
/**
- * @param subscriptionDurable the subscriptionDurable to set
+ * Specifies if the listener uses a durable subscription to listen for
+ * messages. Defaults to <code>false</code>.
+ *
+ * @param subscriptionDurable the listener uses a durable subscription?
* @see org.springframework.jms.listener.AbstractMessageListenerContainer#setSubscriptionDurable(boolean)
*/
public void setSubscriptionDurable(boolean subscriptionDurable) {
Modified: servicemix/components/bindings/servicemix-jms/trunk/src/main/java/org/apache/servicemix/jms/endpoints/JmsJcaConsumerEndpoint.java
URL: http://svn.apache.org/viewvc/servicemix/components/bindings/servicemix-jms/trunk/src/main/java/org/apache/servicemix/jms/endpoints/JmsJcaConsumerEndpoint.java?rev=697314&r1=697313&r2=697314&view=diff
==============================================================================
--- servicemix/components/bindings/servicemix-jms/trunk/src/main/java/org/apache/servicemix/jms/endpoints/JmsJcaConsumerEndpoint.java (original)
+++ servicemix/components/bindings/servicemix-jms/trunk/src/main/java/org/apache/servicemix/jms/endpoints/JmsJcaConsumerEndpoint.java Fri Sep 19 19:34:02 2008
@@ -38,7 +38,8 @@
import org.springframework.jms.listener.adapter.ListenerExecutionFailedException;
/**
- *
+ * A Spring-based JMS consumer that uses JCA to connect to the JMS provider
+ *
* @author gnodet
* @org.apache.xbean.XBean element="jca-consumer"
*/
@@ -57,7 +58,11 @@
}
/**
- * @param bootstrapContext the bootstrapContext to set
+ * Specifies the <code>BootStrapContext</code> used to start the resource
+ * adapter. If this property is not set, a default
+ * <code>BootstrpContext</code> will be created.
+ *
+ * @param bootstrapContext the <code>BootstrapContext</code> to use
*/
public void setBootstrapContext(BootstrapContext bootstrapContext) {
this.bootstrapContext = bootstrapContext;
@@ -71,7 +76,9 @@
}
/**
- * @param activationSpec the activationSpec to set
+ * Specifies the activation information needed by the endpoint.
+ *
+ * @param activationSpec the <code>ActivationSpec</code> containing the activation information
*/
public void setActivationSpec(ActivationSpec activationSpec) {
this.activationSpec = activationSpec;
@@ -85,7 +92,9 @@
}
/**
- * @param resourceAdapter the resourceAdapter to set
+ * Specifies the resource adapter used for the endpoint.
+ *
+ * @param resourceAdapter the <code>ResourceAdapter</code> to use
*/
public void setResourceAdapter(ResourceAdapter resourceAdapter) {
this.resourceAdapter = resourceAdapter;
Modified: servicemix/components/bindings/servicemix-jms/trunk/src/main/java/org/apache/servicemix/jms/endpoints/JmsProviderEndpoint.java
URL: http://svn.apache.org/viewvc/servicemix/components/bindings/servicemix-jms/trunk/src/main/java/org/apache/servicemix/jms/endpoints/JmsProviderEndpoint.java?rev=697314&r1=697313&r2=697314&view=diff
==============================================================================
--- servicemix/components/bindings/servicemix-jms/trunk/src/main/java/org/apache/servicemix/jms/endpoints/JmsProviderEndpoint.java (original)
+++ servicemix/components/bindings/servicemix-jms/trunk/src/main/java/org/apache/servicemix/jms/endpoints/JmsProviderEndpoint.java Fri Sep 19 19:34:02 2008
@@ -49,7 +49,7 @@
import org.springframework.jms.support.destination.DynamicDestinationResolver;
/**
- * A JMS provider endpoint
+ * A Spring-based JMS provider endpoint
*
* @author gnodet
* @org.apache.xbean.XBean element="provider"
@@ -96,7 +96,9 @@
}
/**
- * @param destination the destination to set
+ * Specifies the JMS <code>Destination</code> used to send messages.
+ *
+ * @param destination the destination
*/
public void setDestination(Destination destination) {
this.destination = destination;
@@ -110,21 +112,30 @@
}
/**
- * @param destinationName the destinationName to set
+ * Specifies a string identifying the JMS destination used to send
+ * messages. The destination is resolved using the
+ * <code>DesitinationResolver</code>.
+ *
+ * @param destinationName the destination name
*/
public void setDestinationName(String destinationName) {
this.destinationName = destinationName;
}
/**
- * @return the jms102
- */
+ * Determines if the provider used JMS 1.0.2 compliant APIs.
+ *
+ * @return <code>true</code> if the provider is JMS 1.0.2 compliant
+ */
public boolean isJms102() {
return jms102;
}
/**
- * @param jms102 the jms102 to set
+ * Specifies if the provider uses JMS 1.0.2 compliant APIs. Defaults to
+ * <code>false</code>.
+ *
+ * @param jms102 provider is JMS 1.0.2 compliant?
*/
public void setJms102(boolean jms102) {
this.jms102 = jms102;
@@ -138,6 +149,8 @@
}
/**
+ * Specifies the <code>ConnectionFactory</code> used by the endpoint.
+ *
* @param connectionFactory the connectionFactory to set
*/
public void setConnectionFactory(ConnectionFactory connectionFactory) {
@@ -152,7 +165,10 @@
}
/**
- * @param deliveryMode the deliveryMode to set
+ * Specifies the JMS delivery mode used for the reply. Defaults to
+ * (2)(<code>PERSISTENT</code>).
+ *
+ * @param deliveryMode the JMS delivery mode
*/
public void setDeliveryMode(int deliveryMode) {
this.deliveryMode = deliveryMode;
@@ -166,7 +182,10 @@
}
/**
- * @param destinationChooser the destinationChooser to set
+ * Specifies a class implementing logic for choosing the destination used
+ * to send messages.
+ *
+ * @param destinationChooser the destination chooser for sending messages
*/
public void setDestinationChooser(DestinationChooser destinationChooser) {
if (destinationChooser == null) {
@@ -176,14 +195,17 @@
}
/**
- * @return the destinationChooser
+ * @return the destination chooser for the reply destination
*/
public DestinationChooser getReplyDestinationChooser() {
return replyDestinationChooser;
}
/**
- * @param replyDestinationChooser the replyDestinationChooser to set
+ * Specifies a class implementing logic for choosing the destination used
+ * to recieve replies.
+ *
+ * @param replyDestinationChooser the destination chooser used for the reply destination
*/
public void setReplyDestinationChooser(DestinationChooser replyDestinationChooser) {
this.replyDestinationChooser = replyDestinationChooser;
@@ -196,7 +218,10 @@
}
/**
- * @param destinationResolver the destinationResolver to set
+ * Specifies the class implementing logic for converting strings into
+ * destinations. The default is <code>DynamicDestinationResolver</code>.
+ *
+ * @param destinationResolver the destination resolver implementation
*/
public void setDestinationResolver(DestinationResolver destinationResolver) {
this.destinationResolver = destinationResolver;
@@ -210,7 +235,10 @@
}
/**
- * @param explicitQosEnabled the explicitQosEnabled to set
+ * Specifies if the QoS values specified for the endpoint are explicitly
+ * used when a messages is sent. The default is <code>false</code>.
+ *
+ * @param replyExplicitQosEnabled should the QoS values be sent?
*/
public void setExplicitQosEnabled(boolean explicitQosEnabled) {
this.explicitQosEnabled = explicitQosEnabled;
@@ -224,7 +252,11 @@
}
/**
- * @param marshaler the marshaler to set
+ * Specifies the class implementing the message marshaler. The message
+ * marshaller is responsible for marshalling and unmarshalling JMS messages.
+ * The default is <code>DefaultProviderMarshaler</code>.
+ *
+ * @param marshaler the marshaler implementation
*/
public void setMarshaler(JmsProviderMarshaler marshaler) {
if (marshaler == null) {
@@ -241,7 +273,15 @@
}
/**
- * @param messageIdEnabled the messageIdEnabled to set
+ * Specifies if your endpoint requires JMS message IDs. Setting the
+ * <code>messageIdEnabled</code> property to <code>false</code> causes the
+ * endpoint to call its message producer's
+ * <code>setDisableMessageID() </code> with a value of <code>true</code>.
+ * The JMS broker is then given a hint that it does not need to generate
+ * message IDs or add them to the messages from the endpoint. The JMS
+ * broker can choose to accept the hint or ignore it.
+ *
+ * @param messageIdEnabled the endpoint requires message IDs?
*/
public void setMessageIdEnabled(boolean messageIdEnabled) {
this.messageIdEnabled = messageIdEnabled;
@@ -255,7 +295,15 @@
}
/**
- * @param messageTimestampEnabled the messageTimestampEnabled to set
+ * Specifies if your endpoints requires time stamps on its messages.
+ * Setting the <code>messageTimeStampEnabled</code> property to
+ * <code>false</code> causes the endpoint to call its message producer's
+ * <code>setDisableMessageTimestamp() </code> method with a value of
+ * <code>true</code>. The JMS broker is then given a hint that it does not
+ * need to generate message IDs or add them to the messages from the
+ * endpoint. The JMS broker can choose to accept the hint or ignore it.
+ *
+ * @param messageTimestampEnabled the endpoint requires time stamps?
*/
public void setMessageTimestampEnabled(boolean messageTimestampEnabled) {
this.messageTimestampEnabled = messageTimestampEnabled;
@@ -269,7 +317,9 @@
}
/**
- * @param priority the priority to set
+ * Specifies the priority assigned to the JMS messages. Defaults to 4.
+ *
+ * @param priority the message priority
*/
public void setPriority(int priority) {
this.priority = priority;
@@ -283,7 +333,11 @@
}
/**
- * @param pubSubDomain the pubSubDomain to set
+ * Specifies if the destination is a topic. <code>true</code> means the
+ * destination is a topic. <code>false</code> means the destination is a
+ * queue.
+ *
+ * @param pubSubDomain the destination is a topic?
*/
public void setPubSubDomain(boolean pubSubDomain) {
this.pubSubDomain = pubSubDomain;
@@ -297,7 +351,10 @@
}
/**
- * @param pubSubNoLocal the pubSubNoLocal to set
+ * Specifies if messages published by the listener's <code>Connection</code>
+ * are suppressed. The default is <code>false</code>.
+ *
+ * @param pubSubNoLocal messages are surpressed?
*/
public void setPubSubNoLocal(boolean pubSubNoLocal) {
this.pubSubNoLocal = pubSubNoLocal;
@@ -311,7 +368,9 @@
}
/**
- * @param receiveTimeout the receiveTimeout to set
+ * Specifies the timeout for receiving a message in milliseconds.
+ *
+ * @param receiveTimeout milliseconds to wait
*/
public void setReceiveTimeout(long receiveTimeout) {
this.receiveTimeout = receiveTimeout;
@@ -325,7 +384,9 @@
}
/**
- * @param timeToLive the timeToLive to set
+ * Specifies the number of milliseconds a message is valid.
+ *
+ * @param timeToLive number of milliseonds a message lives
*/
public void setTimeToLive(long timeToLive) {
this.timeToLive = timeToLive;
@@ -339,7 +400,7 @@
* Sets the store factory used to create the store.
* If none is set, a {@link MemoryStoreFactory} will be created and used instead.
*
- * @param storeFactory
+ * @param storeFactory the factory
*/
public void setStoreFactory(StoreFactory storeFactory) {
this.storeFactory = storeFactory;
@@ -353,7 +414,7 @@
* Sets the store used to store JBI exchanges that are waiting for a response
* JMS message. The store will be automatically created if not set.
*
- * @param store
+ * @param store the store
*/
public void setStore(Store store) {
this.store = store;
Modified: servicemix/components/bindings/servicemix-jms/trunk/src/main/java/org/apache/servicemix/jms/endpoints/JmsSoapConsumerEndpoint.java
URL: http://svn.apache.org/viewvc/servicemix/components/bindings/servicemix-jms/trunk/src/main/java/org/apache/servicemix/jms/endpoints/JmsSoapConsumerEndpoint.java?rev=697314&r1=697313&r2=697314&view=diff
==============================================================================
--- servicemix/components/bindings/servicemix-jms/trunk/src/main/java/org/apache/servicemix/jms/endpoints/JmsSoapConsumerEndpoint.java (original)
+++ servicemix/components/bindings/servicemix-jms/trunk/src/main/java/org/apache/servicemix/jms/endpoints/JmsSoapConsumerEndpoint.java Fri Sep 19 19:34:02 2008
@@ -46,7 +46,8 @@
import org.springframework.core.io.Resource;
/**
- *
+ * A Spring-based JMS consumer optimized for handling SOAP messages
+ *
* @author gnodet
* @since 3.2
* @org.apache.xbean.XBean element="soap-consumer"
@@ -74,6 +75,11 @@
return wsdl;
}
+ /**
+ * Specifies the WSDL document describing the service's interface.
+ *
+ * @param wsdl a <code>Resource</code> containing the WSDL
+ */
public void setWsdl(Resource wsdl) {
this.wsdl = wsdl;
}
@@ -82,6 +88,12 @@
return validateWsdl;
}
+ /**
+ * Specifies if the WSDL is checked WSI-BP compliance. Defaults to
+ * <code>true</code>.
+ *
+ * @param validateWsdl the WSDL is validated?
+ */
public void setValidateWsdl(boolean validateWsdl) {
this.validateWsdl = validateWsdl;
}
@@ -90,6 +102,12 @@
return useJbiWrapper;
}
+ /**
+ * Specifies if the endpoint expects SOAP messages to be wrapped in the JBI
+ * wrapper. Defaults to <code>true</code>.
+ *
+ * @param useJbiWrapper the endpoint expects the JBI wrapper?
+ */
public void setUseJbiWrapper(boolean useJbiWrapper) {
this.useJbiWrapper = useJbiWrapper;
}
@@ -98,6 +116,11 @@
return policies;
}
+ /**
+ * Specifies an array of interceptors used to process SOAP messages.
+ *
+ * @param policies the array of interceptors
+ */
public void setPolicies(Policy[] policies) {
this.policies = policies;
}
Modified: servicemix/components/bindings/servicemix-jms/trunk/src/main/java/org/apache/servicemix/jms/endpoints/JmsSoapProviderEndpoint.java
URL: http://svn.apache.org/viewvc/servicemix/components/bindings/servicemix-jms/trunk/src/main/java/org/apache/servicemix/jms/endpoints/JmsSoapProviderEndpoint.java?rev=697314&r1=697313&r2=697314&view=diff
==============================================================================
--- servicemix/components/bindings/servicemix-jms/trunk/src/main/java/org/apache/servicemix/jms/endpoints/JmsSoapProviderEndpoint.java (original)
+++ servicemix/components/bindings/servicemix-jms/trunk/src/main/java/org/apache/servicemix/jms/endpoints/JmsSoapProviderEndpoint.java Fri Sep 19 19:34:02 2008
@@ -42,7 +42,8 @@
import org.springframework.core.io.Resource;
/**
- *
+ * A Spring-based JMS provider optimized for SOAP messages
+ *
* @author gnodet
* @since 3.2
* @org.apache.xbean.XBean element="soap-provider"
@@ -58,6 +59,11 @@
return wsdl;
}
+ /**
+ * Specifies the WSDL document describing the service's interface.
+ *
+ * @param wsdl a <code>Resource</code> containing the WSDL
+ */
public void setWsdl(Resource wsdl) {
this.wsdl = wsdl;
}
@@ -66,6 +72,12 @@
return validateWsdl;
}
+ /**
+ * Specifies if the WSDL is checked WSI-BP compliance. Defaults to
+ * <code>true</code>.
+ *
+ * @param validateWsdl the WSDL is validated?
+ */
public void setValidateWsdl(boolean validateWsdl) {
this.validateWsdl = validateWsdl;
}
@@ -74,6 +86,12 @@
return useJbiWrapper;
}
+ /**
+ * Specifies if the endpoint expects SOAP messages to be wrapped in the JBI
+ * wrapper. Defaults to <code>true</code>.
+ *
+ * @param useJbiWrapper the endpoint expects the JBI wrapper?
+ */
public void setUseJbiWrapper(boolean useJbiWrapper) {
this.useJbiWrapper = useJbiWrapper;
}
@@ -82,6 +100,11 @@
return policies;
}
+ /**
+ * Specifies an array of interceptors used to process SOAP messages.
+ *
+ * @param policies the array of interceptors
+ */
public void setPolicies(Policy[] policies) {
this.policies = policies;
}