You are viewing a plain text version of this content. The canonical link for it is here.
Posted to java-dev@axis.apache.org by gd...@apache.org on 2003/04/08 06:12:22 UTC
cvs commit: xml-axis/java/src/org/apache/axis SimpleTargetedChain.java
gdaniels 2003/04/07 21:12:22
Modified: java/src/org/apache/axis SimpleTargetedChain.java
Log:
Flesh out JavaDoc a tad.
Revision Changes Path
1.44 +135 -134 xml-axis/java/src/org/apache/axis/SimpleTargetedChain.java
Index: SimpleTargetedChain.java
===================================================================
RCS file: /home/cvs/xml-axis/java/src/org/apache/axis/SimpleTargetedChain.java,v
retrieving revision 1.43
retrieving revision 1.44
diff -u -r1.43 -r1.44
--- SimpleTargetedChain.java 11 Dec 2002 22:38:07 -0000 1.43
+++ SimpleTargetedChain.java 8 Apr 2003 04:12:22 -0000 1.44
@@ -1,57 +1,57 @@
/*
- * The Apache Software License, Version 1.1
- *
- *
- * Copyright (c) 2001 The Apache Software Foundation. All rights
- * reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions
- * are met:
- *
- * 1. Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
- *
- * 2. Redistributions in binary form must reproduce the above copyright
- * notice, this list of conditions and the following disclaimer in
- * the documentation and/or other materials provided with the
- * distribution.
- *
- * 3. The end-user documentation included with the redistribution,
- * if any, must include the following acknowledgment:
- * "This product includes software developed by the
- * Apache Software Foundation (http://www.apache.org/)."
- * Alternately, this acknowledgment may appear in the software itself,
- * if and wherever such third-party acknowledgments normally appear.
- *
- * 4. The names "Axis" and "Apache Software Foundation" must
- * not be used to endorse or promote products derived from this
- * software without prior written permission. For written
- * permission, please contact apache@apache.org.
- *
- * 5. Products derived from this software may not be called "Apache",
- * nor may "Apache" appear in their name, without prior written
- * permission of the Apache Software Foundation.
- *
- * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
- * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
- * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
- * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
- * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
- * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
- * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
- * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
- * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
- * SUCH DAMAGE.
- * ====================================================================
- *
- * This software consists of voluntary contributions made by many
- * individuals on behalf of the Apache Software Foundation. For more
- * information on the Apache Software Foundation, please see
- * <http://www.apache.org/>.
- */
+* The Apache Software License, Version 1.1
+*
+*
+* Copyright (c) 2001 The Apache Software Foundation. All rights
+* reserved.
+*
+* Redistribution and use in source and binary forms, with or without
+* modification, are permitted provided that the following conditions
+* are met:
+*
+* 1. Redistributions of source code must retain the above copyright
+* notice, this list of conditions and the following disclaimer.
+*
+* 2. Redistributions in binary form must reproduce the above copyright
+* notice, this list of conditions and the following disclaimer in
+* the documentation and/or other materials provided with the
+* distribution.
+*
+* 3. The end-user documentation included with the redistribution,
+* if any, must include the following acknowledgment:
+* "This product includes software developed by the
+* Apache Software Foundation (http://www.apache.org/)."
+* Alternately, this acknowledgment may appear in the software itself,
+* if and wherever such third-party acknowledgments normally appear.
+*
+* 4. The names "Axis" and "Apache Software Foundation" must
+* not be used to endorse or promote products derived from this
+* software without prior written permission. For written
+* permission, please contact apache@apache.org.
+*
+* 5. Products derived from this software may not be called "Apache",
+* nor may "Apache" appear in their name, without prior written
+* permission of the Apache Software Foundation.
+*
+* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
+* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
+* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
+* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
+* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+* SUCH DAMAGE.
+* ====================================================================
+*
+* This software consists of voluntary contributions made by many
+* individuals on behalf of the Apache Software Foundation. For more
+* information on the Apache Software Foundation, please see
+* <http://www.apache.org/>.
+*/
package org.apache.axis ;
@@ -60,91 +60,92 @@
import org.apache.commons.logging.Log;
/**
+ * A SimpleTargetedChain has a request handler, a pivot handler, and a response
+ * handler (any of which may themselves be chains).
*
* @author Doug Davis (dug@us.ibm.com)
* @author Glyn Normington (norm@uk.ibm.com)
*/
public class SimpleTargetedChain extends SimpleChain implements TargetedChain
{
- protected static Log log =
- LogFactory.getLog(SimpleTargetedChain.class.getName());
-
- protected Handler requestHandler ;
- protected Handler pivotHandler ;
- protected Handler responseHandler ;
-
- /**
- * Pivot indicator sets "past pivot point" before the response handler
- * runs. This avoids having to reimplement SimpleChain.invoke and
- * SimpleChain.generateWSDL.
- */
- private class PivotIndicator extends BasicHandler {
- public PivotIndicator() {}
-
- public void invoke(MessageContext msgContext) throws AxisFault {
- msgContext.setPastPivot(true);
- }
- }
-
- /**
- * Default no-arg constructor.
- */
- public SimpleTargetedChain() {}
-
- /**
- * Constructor for an instance with effectively only a pivot handler.
- */
- public SimpleTargetedChain(Handler handler) {
- pivotHandler = handler;
- if (pivotHandler != null) {
- addHandler(pivotHandler);
- addHandler(new PivotIndicator());
- }
- }
-
- /**
- * Constructor which takes real or null request, pivot, and response
- * handlers.
- */
- public SimpleTargetedChain(Handler reqHandler, Handler pivHandler,
- Handler respHandler) {
- init(reqHandler, null, pivHandler, null, respHandler);
- }
-
- /**
- * Initialiser which takes real or null request, pivot, and response
- * handlers and which allows for special request and response
- * handlers to be inserted just before and after any pivot handler.
- */
- protected void init(Handler reqHandler, Handler specialReqHandler,
- Handler pivHandler, Handler specialRespHandler,
- Handler respHandler) {
-
- requestHandler = reqHandler;
- if (requestHandler != null)
- addHandler(requestHandler);
-
- if (specialReqHandler != null)
- addHandler(specialReqHandler);
-
- pivotHandler = pivHandler;
- if (pivotHandler != null) {
- addHandler(pivotHandler);
- addHandler(new PivotIndicator());
- }
-
- if (specialRespHandler != null)
- addHandler(specialRespHandler);
-
- responseHandler = respHandler;
- if (responseHandler != null)
- addHandler(responseHandler);
- }
-
- public Handler getRequestHandler() { return( requestHandler ); }
-
- public Handler getPivotHandler() { return( pivotHandler ); }
-
- public Handler getResponseHandler() { return( responseHandler ); }
-
+ protected static Log log =
+ LogFactory.getLog(SimpleTargetedChain.class.getName());
+
+ protected Handler requestHandler ;
+ protected Handler pivotHandler ;
+ protected Handler responseHandler ;
+
+ /**
+ * Pivot indicator sets "past pivot point" before the response handler
+ * runs. This avoids having to reimplement SimpleChain.invoke and
+ * SimpleChain.generateWSDL.
+ */
+ private class PivotIndicator extends BasicHandler {
+ public PivotIndicator() {}
+
+ public void invoke(MessageContext msgContext) throws AxisFault {
+ msgContext.setPastPivot(true);
+ }
+ }
+
+ /**
+ * Default no-arg constructor.
+ */
+ public SimpleTargetedChain() {}
+
+ /**
+ * Constructor for an instance with effectively only a pivot handler.
+ */
+ public SimpleTargetedChain(Handler handler) {
+ pivotHandler = handler;
+ if (pivotHandler != null) {
+ addHandler(pivotHandler);
+ addHandler(new PivotIndicator());
+ }
+ }
+
+ /**
+ * Constructor which takes real or null request, pivot, and response
+ * handlers.
+ */
+ public SimpleTargetedChain(Handler reqHandler, Handler pivHandler,
+ Handler respHandler) {
+ init(reqHandler, null, pivHandler, null, respHandler);
+ }
+
+ /**
+ * Initialiser which takes real or null request, pivot, and response
+ * handlers and which allows for special request and response
+ * handlers to be inserted just before and after any pivot handler.
+ */
+ protected void init(Handler reqHandler, Handler specialReqHandler,
+ Handler pivHandler, Handler specialRespHandler,
+ Handler respHandler) {
+
+ requestHandler = reqHandler;
+ if (requestHandler != null)
+ addHandler(requestHandler);
+
+ if (specialReqHandler != null)
+ addHandler(specialReqHandler);
+
+ pivotHandler = pivHandler;
+ if (pivotHandler != null) {
+ addHandler(pivotHandler);
+ addHandler(new PivotIndicator());
+ }
+
+ if (specialRespHandler != null)
+ addHandler(specialRespHandler);
+
+ responseHandler = respHandler;
+ if (responseHandler != null)
+ addHandler(responseHandler);
+ }
+
+ public Handler getRequestHandler() { return( requestHandler ); }
+
+ public Handler getPivotHandler() { return( pivotHandler ); }
+
+ public Handler getResponseHandler() { return( responseHandler ); }
};