/*

 Copyright (c) 2006, University of Tromsø

 All rights reserved.

 Redistribution and use in source and binary forms, with or without 

 modification, are permitted provided that the following conditions are met:

  * Redistributions of source code must retain the above copyright notice, this list 

    of conditions and the following disclaimer.

  * 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.

  * Neither the name of the University of Tromsø nor the names of its contributors may 

    be used to endorse or promote products derived from this software without specific 

    prior written permission.

 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY 

 EXPRESS 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 COPYRIGHT OWNER OR 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.

 */

 package axis.dynamic;

 import java.util.ArrayList;

 import java.util.HashMap;

 import java.util.List;

 import java.util.Map;

 import org.apache.axis.AxisEngine;

 import org.apache.axis.Chain;

 import org.apache.axis.Handler;

 import org.apache.axis.SimpleChain;

 import org.apache.axis.constants.Style;

 import org.apache.axis.constants.Use;

 /**

  * base class for soap senders and receivers.

  * 

  * TODO: refactor code that this class has in common with SoapConfiguration.

  */

 public abstract class SoapInterface

 {

   private List<Handler> _requestHandlers;

   private List<Handler> _responseHandlers;

   protected Map<String, Object> _properties = new HashMap<String, Object>();

   public abstract void setStyle( Style style );

   public abstract void setUse( Use use );

   public void setSendMultiRefs( boolean multiRefs )

   {

     setProperty(AxisEngine.PROP_DOMULTIREFS, Boolean.valueOf(multiRefs));

   }

   public void setSendXsiTypes( boolean xsiTypes )

   {

     setProperty(AxisEngine.PROP_SEND_XSI, Boolean.valueOf(xsiTypes));

   }

   public void setUsePrettyXml( boolean pretty )

   {

     setProperty(AxisEngine.PROP_DISABLE_PRETTY_XML, Boolean.valueOf(! pretty));

   }

   /*

   public void setSendXmlDeclaration( boolean sendXmlDeclaration )

   {

     setProperty(AxisEngine.PROP_XML_DECL, Boolean.valueOf(sendXmlDeclaration));

   }

   */

   /*

   public void setDotNetSoapEncFix( boolean dotNetSoapEncFix )

   {

     setProperty(AxisEngine.PROP_DOTNET_SOAPENC_FIX, Boolean.valueOf(dotNetSoapEncFix));

   }

   */

   protected void setProperty( String name, Object value )

   {

     _properties.put(name, value);

   }

   public void setRequestHandlers( List<Handler> handlers )

   {

     _requestHandlers = handlers;

   }

   public void addRequestHandler( Handler handler )

   {

     if (_requestHandlers == null) _requestHandlers = new ArrayList<Handler>();

     _requestHandlers.add(handler);

   }

   public void setResponseHandlers( List<Handler> handlers )

   {

     _responseHandlers = handlers;

   }

   public void addResponseHandler( Handler handler )

   {

     if (_responseHandlers == null) _responseHandlers = new ArrayList<Handler>();

     _responseHandlers.add(handler);

   }

   /**

    * @return may be null

    */

   protected Chain getRequestChain()

   {

     return getChain(_requestHandlers);

   }

   /**

    * @return may be null

    */

   protected Chain getResponseChain()

   {

     return getChain(_responseHandlers);

   }

   /**

    * @param handlers 

    * @return null if given list is null

    */

   private Chain getChain( List<Handler> handlers )

   {

     if (handlers == null) return null;

     SimpleChain chain = new SimpleChain();

     for (Handler handler : handlers)

     {

       chain.addHandler(handler);

     }

     return chain;

   }

 }