/*

 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.Collections;

 import java.util.Hashtable;

 import java.util.List;

 import java.util.Map;

 import java.util.concurrent.ConcurrentHashMap;

 import javax.xml.namespace.QName;

 import org.apache.axis.AxisEngine;

 import org.apache.axis.ConfigurationException;

 import org.apache.axis.EngineConfiguration;

 import org.apache.axis.Handler;

 import org.apache.axis.encoding.TypeMappingRegistry;

 import org.apache.axis.encoding.TypeMappingRegistryImpl;

 /**

  * abstract base class for dynamic Axis {@link EngineConfiguration}s.

  */

 public abstract class SoapConfiguration implements EngineConfiguration

 {

   /** the transport handlers. */

   protected final Map<QName, Handler> _transports = new ConcurrentHashMap<QName, Handler>();

   /** this will register the Axis default type mappings */

   protected final TypeMappingRegistry _tmr = new TypeMappingRegistryImpl();

   /** the global request handler (may be a handler chain) */

   protected Handler _globalRequest = null;

   /** the global response handler (may be a handler chain) */

   protected Handler _globalResponse = null;

   /** reference to the engine that uses this configuration, set in {@link #configureEngine} */

   protected /* volatile ? */ AxisEngine _engine;

   /** synchronization shouldn't be necessary, it's a Hashtable and only modified on startup */

   protected final Hashtable<String, String> _globalOptions = new Hashtable<String, String>();

   /**

    * called from {@link AxisEngine#init()}. Note: when this method is called, the given engine already

    * has a reference to this object.

    * @param engine

    * @throws ConfigurationException

    * @see EngineConfiguration#configureEngine(AxisEngine)

    * @see AxisEngine#init()

    */

   public void configureEngine( AxisEngine engine ) throws ConfigurationException

   {

     _engine = engine;

     // engine already knows this object - now it loads our options.

     _engine.refreshGlobalOptions();

   }

   /**

    * We don't write ourselves out, so this is a no-op.

    * @param engine 

    */

   public void writeEngineConfig(AxisEngine engine)

   {

     // nothing to do

   }

   /**

    * Returns the global configuration options.

    * @return  the global options

    */

   public Hashtable<String, String> getGlobalOptions() 

   {

     return _globalOptions;

   }

   /**

    * Returns a global request handler.

    * @return the global request handler (may be a handler chain)

    */

   public Handler getGlobalRequest() 

   {

     return _globalRequest;

   }

   /**

    * Set the global request Handler

    * @param globalRequest (may be a handler chain)

    */

   public void setGlobalRequest( Handler globalRequest ) 

   {

     _globalRequest = globalRequest;

   }

   /**

    * Returns a global response handler.

    * @return the global response handler (may be a handler chain)

    */

   public Handler getGlobalResponse()

   {

     return _globalResponse;

   }

   /**

    * Set the global response Handler

    * @param globalResponse (may be a handler chain)

    */

   public void setGlobalResponse( Handler globalResponse ) 

   {

     _globalResponse = globalResponse;

   }

   /**

    * We do not use handlers with a 'global' name, so this method always returns null.

    * @param qname

    * @return global handler with given name

    * @see EngineConfiguration#getHandler(QName)

    */

   public Handler getHandler( QName qname )

   {

     return null;

   }

   /**

    * Get our TypeMappingRegistry.

    * @return the TypeMappingRegistry of this configuration.

    */

   public TypeMappingRegistry getTypeMappingRegistry()

   {

     return _tmr;

   }

   /**

    * @param qname

    * @return the transport for the given name, may be null

    * @see EngineConfiguration#getTransport(QName)

    */

   public Handler getTransport( QName qname ) 

   {

     return _transports.get(qname);

   }

   /**

    * sets the transport for the given name

    * @param name e.g. "http"

    * @param transport

    */

   public void deployTransport( String name, Handler transport )

   {

     _transports.put(new QName(name), transport);

   }

   /**

    * removes the transport for the given name

    * @param name

    */

   public void undeployTransport( String name )

   {

     _transports.remove(new QName(name));

   }

   /**

    * currently, we don't use roles, so this method always returns null.

    * @return empty list

    */

   public List<String> getRoles() 

   {

     return Collections.emptyList();

   }

 }