/**
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.activemq.jndi;

import java.util.Hashtable;
import java.util.Iterator;
import java.util.Map;

import javax.naming.Context;
import javax.naming.NamingException;

/**
 * This implementation of <CODE>InitialContextFactory</CODE> should be used
 * when ActiveMQ is used as WebSphere Generic JMS Provider. It is proved that it
 * works on WebSphere 5.1. The reason for using this class is that custom
 * property defined for Generic JMS Provider are passed to InitialContextFactory
 * only if it begins with java.naming or javax.naming prefix. Additionaly
 * provider url for the JMS provider can not contain ',' character that is
 * necessary when the list of nodes is provided. So the role of this class is to
 * transform properties before passing it to
 * <CODE>ActiveMQInitialContextFactory</CODE>.
 * 
 * @author Pawel Tucholski
 */
public class ActiveMQWASInitialContextFactory extends ActiveMQInitialContextFactory {

    /**
     * @see javax.naming.spi.InitialContextFactory#getInitialContext(java.util.Hashtable)
     */
    public Context getInitialContext(Hashtable environment) throws NamingException {

        return super.getInitialContext(transformEnvironment(environment));
    }

    /**
     * Performs following transformation of properties:
     * <ul>
     * <li>(java.naming.queue.xxx.yyy,value)=>(queue.xxx/yyy,value)
     * <li>(java.naming.topic.xxx.yyy,value)=>(topic.xxx/yyy,value)
     * <li>(java.naming.connectionFactoryNames,value)=>(connectionFactoryNames,value)
     * <li>(java.naming.provider.url,url1;url2)=>java.naming.provider.url,url1,url1)
     * <ul>
     * 
     * @param environment properties for transformation
     * @return environment after transformation
     */
    protected Hashtable transformEnvironment(Hashtable environment) {

        Hashtable environment1 = new Hashtable();

        Iterator it = environment.entrySet().iterator();

        while (it.hasNext()) {
            Map.Entry entry = (Map.Entry)it.next();
            String key = (String)entry.getKey();
            String value = (String)entry.getValue();

            if (key.startsWith("java.naming.queue")) {
                String key1 = key.substring("java.naming.queue.".length());
                key1 = key1.replace('.', '/');
                environment1.put("queue." + key1, value);
            } else if (key.startsWith("java.naming.topic")) {
                String key1 = key.substring("java.naming.topic.".length());
                key1 = key1.replace('.', '/');
                environment1.put("topic." + key1, value);
            } else if (key.startsWith("java.naming.connectionFactoryNames")) {
                String key1 = key.substring("java.naming.".length());
                environment1.put(key1, value);
            } else if (key.startsWith("java.naming.connection")) {
                String key1 = key.substring("java.naming.".length());
                environment1.put(key1, value);
            } else if (key.startsWith(Context.PROVIDER_URL)) {
                // websphere administration console does not exept , character
                // in provider url, so ; must be used
                // all ; to ,
                value = value.replace(';', ',');
                environment1.put(Context.PROVIDER_URL, value);
            } else {
                environment1.put(key, value);
            }
        }

        return environment1;
    }
}
