You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cxf.apache.org by ni...@apache.org on 2009/03/10 05:25:19 UTC

svn commit: r751979 - in /cxf/branches/2.1.x-fixes: ./ api/src/main/java/org/apache/cxf/message/MessageUtils.java api/src/main/java/org/apache/cxf/phase/AbstractPhaseInterceptor.java

Author: ningjiang
Date: Tue Mar 10 04:25:18 2009
New Revision: 751979

URL: http://svn.apache.org/viewvc?rev=751979&view=rev
Log:
Merged revisions 751828 via svnmerge from 
https://svn.apache.org/repos/asf/cxf/trunk

........
  r751828 | ericjohnson | 2009-03-10 04:56:14 +0800 (Tue, 10 Mar 2009) | 2 lines
  
  added javadoc to AbstractPhaseInterceptor
  fixed some typos in MessageUtils javadoc
........

Modified:
    cxf/branches/2.1.x-fixes/   (props changed)
    cxf/branches/2.1.x-fixes/api/src/main/java/org/apache/cxf/message/MessageUtils.java
    cxf/branches/2.1.x-fixes/api/src/main/java/org/apache/cxf/phase/AbstractPhaseInterceptor.java

Propchange: cxf/branches/2.1.x-fixes/
------------------------------------------------------------------------------
--- svn:mergeinfo (original)
+++ svn:mergeinfo Tue Mar 10 04:25:18 2009
@@ -1 +1 @@
-/cxf/trunk:686333-686363,686764,686820,687096,687194,687363,687387,687463,687543,687722,687798,687814,687817,687891,687910,687914,688086,688102,688133,688596,688735,688870,689572,689596,689855,689924,690067,690289,691246,691271,691295,691338,691355,691488,691602,691646,691706,691728,692116,692157,692310,692466,692499,693653,693819,694179,694263,694417,694716,694744,694747,694795,694869,694981,694987,694993,695041,695096,695396,695484,695537,695552,695561,695619,695684,695835,695840,695868,695935,695977,696016,696094,696433,696720,697085,697868,698128,699289,700261,700507,700602,700981,701316,701783,701830,701862,702187,702205-702248,702267,702547,702561,702580,702602,702609,702616,702653,702656,702957,703191,703239,703309,703501,703513,703548,704584,704937,704997,705150,705235,705274,705340,705446,705548,705614,705692,705708,706482,706631,706675,706900,706909,707034,707089,707100,707902,708035,708044,708074,708410,708417,708550,708554,709353-709354,709425,710076,710150,71015
 4,711193,711388,711410,711490,711635,711949,711975,712194,712198,712238,712272,712299,712312,712670,712893,713082,713095-713096,713099,713584,713597,713737,713804,713899,714167-714168,714245,714255,717937-717961,718281-718448,718565,718620,718640,718665,718970,719017,719210,719215-719218,719222-719273,719305,719327-719680,720053,720119-720218,720238,720293-720316,720497,721221,721241,721501,722117,722129,722412,722988,723024,723338,723378,723716-723791,724333-724372,724433-724438,724449,724481,724485,724668,724780,724782,724785,724793,724795,724940,725071,725316,725332,725335,725348,725364,725418,725425-725426,725455,725506,725554,725562,725651,725671,725688,725754,725773,725799,725839,726342,726524,726631,726634,726637,726639,726692,726724,726769,726992,727096,727445,727521,727568,727692,727754,727781,727792,728070,728087,728696,728897,729051,729430,729449,729460,729863,730082,730139,730889,730891,731598,731604,731615,731631,731635,732036,732050,732320,732363,732411,732450,
 732710,732773,732827,732829,733512,733582,733901,734367,734462,734666,734762,734772,734812,734836,734965,735113,735252,735722-735723,735729,735734,735751,735782,735787,735987,736332,736343,736352,736358-736362,736408,736423,736448,736491,736621,736726,736736,736738-736739,736766,736825,736852,737032,737046,737061,737069,737124,737237,737246,737299,737356,737494,737498,737761,737817,737849,737855,737994,738166,738178,738201,738210,738242,738244,738265,738516,738583,738863,738937,738983,739366-739367,739451-739452,739799-739800,739867,739876-739877,739922,739937,739990,740045,740108,740154,740186,740197,740255,740706,740730,740810,740844,740886,740902,740923,740994,741058,741124,741152,741188,741521,741529,741879,742914,743087,743439,743441,743459,743469,743965,743967,744175,744195,744237,744756,745214,745243,745560,745578,745586,745592,745638,745950,746012,746019-746020,746256,746266,746306,746357,746373-746374,747217,747386,747406,747454,747649,747766,747986,748159,748192,74
 8223,748305,748313,748603-748604,748768,749420,749449,749454-749456,749505,749511,749513,749584,749767,749771,749799,749890,750059-750060,750302,750591,750689,750935,751067-751110,751233,751527,751567,751576,751607,751732,751787
+/cxf/trunk:686333-686363,686764,686820,687096,687194,687363,687387,687463,687543,687722,687798,687814,687817,687891,687910,687914,688086,688102,688133,688596,688735,688870,689572,689596,689855,689924,690067,690289,691246,691271,691295,691338,691355,691488,691602,691646,691706,691728,692116,692157,692310,692466,692499,693653,693819,694179,694263,694417,694716,694744,694747,694795,694869,694981,694987,694993,695041,695096,695396,695484,695537,695552,695561,695619,695684,695835,695840,695868,695935,695977,696016,696094,696433,696720,697085,697868,698128,699289,700261,700507,700602,700981,701316,701783,701830,701862,702187,702205-702248,702267,702547,702561,702580,702602,702609,702616,702653,702656,702957,703191,703239,703309,703501,703513,703548,704584,704937,704997,705150,705235,705274,705340,705446,705548,705614,705692,705708,706482,706631,706675,706900,706909,707034,707089,707100,707902,708035,708044,708074,708410,708417,708550,708554,709353-709354,709425,710076,710150,71015
 4,711193,711388,711410,711490,711635,711949,711975,712194,712198,712238,712272,712299,712312,712670,712893,713082,713095-713096,713099,713584,713597,713737,713804,713899,714167-714168,714245,714255,717937-717961,718281-718448,718565,718620,718640,718665,718970,719017,719210,719215-719218,719222-719273,719305,719327-719680,720053,720119-720218,720238,720293-720316,720497,721221,721241,721501,722117,722129,722412,722988,723024,723338,723378,723716-723791,724333-724372,724433-724438,724449,724481,724485,724668,724780,724782,724785,724793,724795,724940,725071,725316,725332,725335,725348,725364,725418,725425-725426,725455,725506,725554,725562,725651,725671,725688,725754,725773,725799,725839,726342,726524,726631,726634,726637,726639,726692,726724,726769,726992,727096,727445,727521,727568,727692,727754,727781,727792,728070,728087,728696,728897,729051,729430,729449,729460,729863,730082,730139,730889,730891,731598,731604,731615,731631,731635,732036,732050,732320,732363,732411,732450,
 732710,732773,732827,732829,733512,733582,733901,734367,734462,734666,734762,734772,734812,734836,734965,735113,735252,735722-735723,735729,735734,735751,735782,735787,735987,736332,736343,736352,736358-736362,736408,736423,736448,736491,736621,736726,736736,736738-736739,736766,736825,736852,737032,737046,737061,737069,737124,737237,737246,737299,737356,737494,737498,737761,737817,737849,737855,737994,738166,738178,738201,738210,738242,738244,738265,738516,738583,738863,738937,738983,739366-739367,739451-739452,739799-739800,739867,739876-739877,739922,739937,739990,740045,740108,740154,740186,740197,740255,740706,740730,740810,740844,740886,740902,740923,740994,741058,741124,741152,741188,741521,741529,741879,742914,743087,743439,743441,743459,743469,743965,743967,744175,744195,744237,744756,745214,745243,745560,745578,745586,745592,745638,745950,746012,746019-746020,746256,746266,746306,746357,746373-746374,747217,747386,747406,747454,747649,747766,747986,748159,748192,74
 8223,748305,748313,748603-748604,748768,749420,749449,749454-749456,749505,749511,749513,749584,749767,749771,749799,749890,750059-750060,750302,750591,750689,750935,751067-751110,751233,751527,751567,751576,751607,751732,751787,751828

Propchange: cxf/branches/2.1.x-fixes/
------------------------------------------------------------------------------
Binary property 'svnmerge-integrated' - no diff available.

Modified: cxf/branches/2.1.x-fixes/api/src/main/java/org/apache/cxf/message/MessageUtils.java
URL: http://svn.apache.org/viewvc/cxf/branches/2.1.x-fixes/api/src/main/java/org/apache/cxf/message/MessageUtils.java?rev=751979&r1=751978&r2=751979&view=diff
==============================================================================
--- cxf/branches/2.1.x-fixes/api/src/main/java/org/apache/cxf/message/MessageUtils.java (original)
+++ cxf/branches/2.1.x-fixes/api/src/main/java/org/apache/cxf/message/MessageUtils.java Tue Mar 10 04:25:18 2009
@@ -37,7 +37,7 @@
      * Determine if message is outbound.
      * 
      * @param message the current Message
-     * @return true iff the message direction is outbound
+     * @return true if the message direction is outbound
      */
     public static boolean isOutbound(Message message) {
         Exchange exchange = message.getExchange();
@@ -49,7 +49,7 @@
      * Determine if message is fault.
      * 
      * @param message the current Message
-     * @return true iff the message is a fault
+     * @return true if the message is a fault
      */
     public static boolean isFault(Message message) {
         return message != null
@@ -83,7 +83,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(Message.REQUESTOR_ROLE);
@@ -94,7 +94,7 @@
      * Determine if the current message is a partial response.
      * 
      * @param message the current message
-     * @return true iff the current messags is a partial response
+     * @return true if the current messags is a partial response
      */
     public static boolean isPartialResponse(Message message) {
         return Boolean.TRUE.equals(message.get(Message.PARTIAL_RESPONSE_MESSAGE));
@@ -103,7 +103,7 @@
     /**
      * Returns true if a value is either the String "true" (regardless of case)  or Boolean.TRUE.
      * @param value
-     * @return true iff value is either the String "true" or Boolean.TRUE
+     * @return true if value is either the String "true" or Boolean.TRUE
      */
     public static boolean isTrue(Object value) {
         if (value == null) {

Modified: cxf/branches/2.1.x-fixes/api/src/main/java/org/apache/cxf/phase/AbstractPhaseInterceptor.java
URL: http://svn.apache.org/viewvc/cxf/branches/2.1.x-fixes/api/src/main/java/org/apache/cxf/phase/AbstractPhaseInterceptor.java?rev=751979&r1=751978&r2=751979&view=diff
==============================================================================
--- cxf/branches/2.1.x-fixes/api/src/main/java/org/apache/cxf/phase/AbstractPhaseInterceptor.java (original)
+++ cxf/branches/2.1.x-fixes/api/src/main/java/org/apache/cxf/phase/AbstractPhaseInterceptor.java Tue Mar 10 04:25:18 2009
@@ -27,21 +27,63 @@
 import org.apache.cxf.common.util.SortedArraySet;
 import org.apache.cxf.message.Message;
 
+/**
+ * Provides a starting point implementation for a interceptors that 
+ * participate in phased message processing. Developers should extend from 
+ * this class when implementing custom interceptors.
+ * Developers need to provide an implementation for handleMessage() and 
+ * can overide the handleFault() implementation. They should not overide 
+ * the other methods.
+ */
 public abstract class AbstractPhaseInterceptor<T extends Message> implements PhaseInterceptor<T> {
     private final String id;
     private final String phase;
     private final Set<String> before = new SortedArraySet<String>();
     private final Set<String> after = new SortedArraySet<String>();
 
-    public AbstractPhaseInterceptor(String phase) {
+    /**
+	 * Instantiates the interceptor to live in a specified phase. The 
+	 * interceptor's id will be set to the name of the implementing class.
+	 *
+	 * @param phase the interceptor's phase
+	 */
+	public AbstractPhaseInterceptor(String phase) {
         this(null, phase, false);
     }
+
+    /**
+	 * Instantiates the interceptor with a specified id.
+	 *
+	 * @param i the interceptor's id
+	 * @param p the interceptor's phase
+	 */
     public AbstractPhaseInterceptor(String i, String p) {
         this(i, p, false);
     }
+
+    /**
+	 * Instantiates the interceptor and specifies if it gets a system 
+	 * determined unique id. If <code>uniqueId</code> is set to true the 
+	 * interceptor's id will be determined by the runtime. If 
+	 * <code>uniqueId</code> is set to false, the implementing class' name 
+	 * is used as the id.
+	 *
+	 * @param p the interceptor's phase
+	 * @param uniqueId
+	 */
     public AbstractPhaseInterceptor(String phase, boolean uniqueId) {
         this(null, phase, uniqueId);
     }
+
+    /**
+	 * Instantiates the interceptor with a specified id or with a system 
+	 * determined unique id. The specified id will be used unless 
+	 * <code>uniqueId</code> is set to true.
+	 *
+	 * @param i the interceptor's id
+	 * @param p the interceptor's phase
+	 * @param uniqueId
+	 */
     public AbstractPhaseInterceptor(String i, String p, boolean uniqueId) {
         if (i == null) {
             i = getClass().getName();