/*
    * Copyright 2001-2011 The Apache Software Foundation.
    * 
    * Licensed under the Apache License, Version 2.0 (the "License");
    * you may not use this file except in compliance with the License.
    * You may obtain a copy of the License at
    * 
    *      http://www.apache.org/licenses/LICENSE-2.0
    * 
   * Unless required by applicable law or agreed to in writing, software
   * distributed under the License is distributed on an "AS IS" BASIS,
   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   * See the License for the specific language governing permissions and
   * limitations under the License.
   *
   */
  package org.apache.juddi.v3.client.config;
  
  import javax.servlet.ServletContext;
  
  import org.apache.commons.configuration.ConfigurationException;
  import org.apache.commons.logging.Log;
  import org.apache.commons.logging.LogFactory;
  
  /**
   * 
   * @author kstam
   */
  public class WebHelper {
  
          public static final Log logger = LogFactory.getLog(WebHelper.class);
          public static final String UDDI_CLIENT_NAME = "uddi.client.name";
          public static final String UDDI_CLIENT_CONFIG_FILE = "uddi.client.config.file";
          public static final String JUDDI_CLIENT_NAME = "juddi.client.name";
          public static final String JUDDI_CLIENT_TRANSPORT = "juddi.client.transport";
  
          /**
           * Checks the servlet context for the manager defined in the web
           * context. Optionally, in your web.xml you can specify either the
           * manager name if you want to use an existing manager called
           * 'uddi-portlet-manager':
           * <pre>
           * &lt;context-param&gt;
           *   &lt;param-name&gt;uddi.client.manager.name&lt;/param-name&gt;
           *   &lt;param-value&gt;uddi-portlet-manager&lt;/param-value&gt;
           * &lt;/context-param&gt;
           * </pre> or, if you don't want to use the default META-INF/uddi.xml
           * file path, but 'META-INF/my-uddi.xml' instead, then you can set:
           * <pre>
           * &lt;context-param&gt;
           *   &lt;param-name&gt;uddi.client.config.path&lt;/param-name&gt;
           *   &lt;param-value&gt;META-INF/my-uddi.xml&lt;/param-value&gt;
           * &lt;/context-param&gt;
           * </pre>
           *
           * @param servletContext
           * @return a UDDI Client instance
           * @throws ConfigurationException
           */
          public static UDDIClient getUDDIClient(ServletContext servletContext) throws ConfigurationException {
                  if (servletContext.getAttribute(JUDDI_CLIENT_NAME) != null) {
                          String clientName = String.valueOf(servletContext.getAttribute(JUDDI_CLIENT_NAME));
                          return UDDIClientContainer.getUDDIClient(clientName);
                  } else {
                          String clientName = servletContext.getInitParameter(UDDI_CLIENT_NAME);
                          if (clientName != null) {
                                  try {
                                          UDDIClient client = UDDIClientContainer.getUDDIClient(clientName);
                                          logger.info("Client " + clientName + " was already started.");
                                          servletContext.setAttribute(JUDDI_CLIENT_NAME, clientName);
                                          return client;
                                  } catch (ConfigurationException ce) {
                                          logger.debug("Client " + clientName + " is not yet started.");
                                  }
                          }
                          String clientConfigFile = servletContext.getInitParameter(UDDI_CLIENT_CONFIG_FILE);
                          if (clientConfigFile == null) {
                                  clientConfigFile = ClientConfig.DEFAULT_UDDI_CONFIG;
                          }
                          
  
                          logger.info("Reading the clientName from the clientConfig file " + clientConfigFile);
                          UDDIClient client = new UDDIClient(clientConfigFile);
                          if (client.getName() == null) {
                                  logger.warn("Deprecated, client name set to 'default', however it should be provided in the uddi.xml");
                                  clientName = "default";
                          }
                          if (client.getName() != null) {
                                  logger.info("Starting Client " + client.getName() + "...");
                                  clientName = client.getName();
                          } else {
                                  throw new ConfigurationException("A client name needs to be specified in the client config file.");
                          }
  
                          client.start();
                          servletContext.setAttribute(JUDDI_CLIENT_NAME, clientName);
                          return client;
                  }
          }
 }