cxf-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ericjohn...@apache.org
Subject svn commit: r761094 - in /cxf/trunk: api/src/main/java/org/apache/cxf/message/Message.java rt/ws/addr/src/main/java/org/apache/cxf/ws/addressing/ContextUtils.java
Date Wed, 01 Apr 2009 22:28:01 GMT
Author: ericjohnson
Date: Wed Apr  1 22:28:01 2009
New Revision: 761094

URL: http://svn.apache.org/viewvc?rev=761094&view=rev
Log:
added comments to identify what some of the message properties mean.

Modified:
    cxf/trunk/api/src/main/java/org/apache/cxf/message/Message.java
    cxf/trunk/rt/ws/addr/src/main/java/org/apache/cxf/ws/addressing/ContextUtils.java

Modified: cxf/trunk/api/src/main/java/org/apache/cxf/message/Message.java
URL: http://svn.apache.org/viewvc/cxf/trunk/api/src/main/java/org/apache/cxf/message/Message.java?rev=761094&r1=761093&r2=761094&view=diff
==============================================================================
--- cxf/trunk/api/src/main/java/org/apache/cxf/message/Message.java (original)
+++ cxf/trunk/api/src/main/java/org/apache/cxf/message/Message.java Wed Apr  1 22:28:01 2009
@@ -31,17 +31,40 @@
  */
 public interface Message extends StringMap {
     
-    String TRANSPORT = "org.apache.cxf.transport";    
+    String TRANSPORT = "org.apache.cxf.transport";
+
+    /**
+     * Boolean property specifying if the message is a request message.
+     */
     String REQUESTOR_ROLE = "org.apache.cxf.client";
 
+    /**
+     * Boolean property specifying if the message is inbound.
+     */
     String INBOUND_MESSAGE = "org.apache.cxf.message.inbound";
+    
+    /**
+     * A Map keyed by a string that stores optional context information 
+     * associated with the invocation that spawned the message.
+     */
     String INVOCATION_CONTEXT = "org.apache.cxf.invocation.context";
     
+    /**
+     * A Map containing the MIME headers for a SOAP message.
+     */
     String MIME_HEADERS = "org.apache.cxf.mime.headers";
     
+    /**
+     * Boolean property specifying if the server should send the response 
+     * asynchronously.
+     */
     String ASYNC_POST_RESPONSE_DISPATCH =
         "org.apache.cxf.async.post.response.dispatch";
 
+    /**
+     * Boolean property specifying if this message arrived via a 
+     * decoupled endpoint.
+     */
     String DECOUPLED_CHANNEL_MESSAGE = "decoupled.channel.message";
     String PARTIAL_RESPONSE_MESSAGE = "org.apache.cxf.partial.response";
     
@@ -52,6 +75,11 @@
     String PATH_INFO = Message.class.getName() + ".PATH_INFO";
     String REQUEST_URI = Message.class.getName() + ".REQUEST_URI";
     String QUERY_STRING = Message.class.getName() + ".QUERY_STRING";
+
+    /**
+     * Boolean property specifying in the runtime is configured to process 
+     * MTOM attachments.
+     */
     String MTOM_ENABLED = "mtom-enabled";
     String MTOM_THRESHOLD = "mtom-threshold";
     String SCHEMA_VALIDATION_ENABLED = "schema-validation-enabled";

Modified: cxf/trunk/rt/ws/addr/src/main/java/org/apache/cxf/ws/addressing/ContextUtils.java
URL: http://svn.apache.org/viewvc/cxf/trunk/rt/ws/addr/src/main/java/org/apache/cxf/ws/addressing/ContextUtils.java?rev=761094&r1=761093&r2=761094&view=diff
==============================================================================
--- cxf/trunk/rt/ws/addr/src/main/java/org/apache/cxf/ws/addressing/ContextUtils.java (original)
+++ cxf/trunk/rt/ws/addr/src/main/java/org/apache/cxf/ws/addressing/ContextUtils.java Wed
Apr  1 22:28:01 2009
@@ -144,7 +144,7 @@
     * Determine if current messaging role is that of requestor.
     *
     * @param message the current Message
-    * @return true iff the current messaging role is that of requestor
+    * @return true if the current messaging role is that of requestor
     */
     public static boolean isRequestor(Message message) {
         Boolean requestor = (Boolean)message.get(REQUESTOR_ROLE);
@@ -157,9 +157,9 @@
      * @param isProviderContext true if the binding provider request context 
      * available to the client application as opposed to the message context 
      * visible to handlers
-     * @param isRequestor true iff the current messaging role is that of
+     * @param isRequestor true if the current messaging role is that of
      * requestor
-     * @param isOutbound true iff the message is outbound
+     * @param isOutbound true if the message is outbound
      * @return the property name to use when caching the MAPs in the context
      */
     public static String getMAPProperty(boolean isRequestor, 
@@ -180,7 +180,7 @@
      * Store MAPs in the message.
      *
      * @param message the current message
-     * @param isOutbound true iff the message is outbound
+     * @param isOutbound true if the message is outbound
      */
     public static void storeMAPs(AddressingProperties maps,
                                  Message message,
@@ -193,8 +193,8 @@
      *
      * @param maps the MAPs to store
      * @param message the current message
-     * @param isOutbound true iff the message is outbound
-     * @param isRequestor true iff the current messaging role is that of
+     * @param isOutbound true if the message is outbound
+     * @param isRequestor true if the current messaging role is that of
      * requestor
      * @param handler true if HANDLER scope, APPLICATION scope otherwise
      */
@@ -210,8 +210,8 @@
      *
      * @param maps the MAPs to store
      * @param message the current message
-     * @param isOutbound true iff the message is outbound
-     * @param isRequestor true iff the current messaging role is that of
+     * @param isOutbound true if the message is outbound
+     * @param isRequestor true if the current messaging role is that of
      * requestor
      * @param handler true if HANDLER scope, APPLICATION scope otherwise
      * @param isProviderContext true if the binding provider request context 
@@ -235,7 +235,7 @@
      * @param isProviderContext true if the binding provider request context
      * available to the client application as opposed to the message context
      * visible to handlers
-     * @param isOutbound true iff the message is outbound
+     * @param isOutbound true if the message is outbound
      * @return the current addressing properties
      */
     public static AddressingPropertiesImpl retrieveMAPs(
@@ -250,7 +250,7 @@
      * @param isProviderContext true if the binding provider request context
      * available to the client application as opposed to the message context
      * visible to handlers
-     * @param isOutbound true iff the message is outbound
+     * @param isOutbound true if the message is outbound
      * @param warnIfMissing log a warning  message if properties cannot be retrieved
      * @return the current addressing properties
      */
@@ -309,7 +309,7 @@
      * none or anonymous).
      *
      * @param ref the EPR under test
-     * @return true iff the address is generic
+     * @return true if the address is generic
      */
     public static boolean isGenericAddress(EndpointReferenceType ref) {
         return ref == null 
@@ -321,10 +321,10 @@
     /**
      * Helper method to determine if an MAPs Action is empty (a null action
      * is considered empty, whereas a zero length action suppresses
-     * the propogation of the Action property).
+     * the propagation of the Action property).
      *
      * @param ref the MAPs Action under test
-     * @return true iff the Action is empty
+     * @return true if the Action is empty
      */
     public static boolean hasEmptyAction(AddressingProperties maps) {
         boolean empty = maps.getAction() == null;



Mime
View raw message