/*
 * The Apache Software License, Version 1.1
 *
 *
 * Copyright (c) 2001-2003 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.jboss.axis.configuration;

import org.jboss.axis.AxisEngine;
import org.jboss.axis.ConfigurationException;

import java.io.ByteArrayInputStream;

/**
 * A simple ConfigurationProvider that uses the Admin class to
 * configure the engine from a String containing XML.
 * <p/>
 * This provider does not write configuration to persistent storage.
 * <p/>
 * Example of usage:
 * new XMLStringProvider("<engineConfig><handlers><handler name=" +
 * "\"MsgDispatcher\" class=\"org.jboss.axis.providers.java" +
 * ".MsgProvider\"/></handlers><services><service name=\"Adm" +
 * "inService\" pivot=\"MsgDispatcher\"><option name=\"class" +
 * "Name\" value=\"org.jboss.axis.utils.Admin\"/><option na" +
 * "me=\"allowedMethods\" value=\"AdminService\"/><option na" +
 * "me=\"enableRemoteAdmin\" value=\"false\"/></service></se" +
 * "rvices></engineConfig>");
 *
 * @author Glen Daniels (gdaniels@macromedia.com)
 */
public class XMLStringProvider extends FileProvider
{
   String xmlConfiguration;

   /**
    * Constructor
    *
    * @param xmlConfiguration a String containing an engine configuration
    *                         in XML.
    */
   public XMLStringProvider(String xmlConfiguration)
   {
      super(new ByteArrayInputStream(xmlConfiguration.getBytes()));
      this.xmlConfiguration = xmlConfiguration;
   }

   public void writeEngineConfig(AxisEngine engine)
           throws ConfigurationException
   {
      // NOOP
   }

   public void configureEngine(AxisEngine engine) throws ConfigurationException
   {
      setInputStream(new ByteArrayInputStream(xmlConfiguration.getBytes()));
      super.configureEngine(engine);
   }
}