GenericServiceLocator.java

/**
 * 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.openejb.client;

import javax.naming.Context;
import javax.naming.NamingException;
import java.net.URI;

/**
 * @version $Rev$ $Date$
 */
@SuppressWarnings("unchecked")
public class GenericServiceLocator extends ServiceLocator {

    private final String commonPrefix;

    public GenericServiceLocator(final URI serverUri, final String commonPrefix) throws NamingException {
        super(serverUri);
        this.commonPrefix = commonPrefix;
    }

    public GenericServiceLocator(final URI serverUri, final String username, final String password, final String commonPrefix) throws NamingException {
        super(serverUri, username, password);
        this.commonPrefix = commonPrefix;
    }

    public GenericServiceLocator(final URI serverUri, final String username, final String password, final String realm, final String commonPrefix) throws NamingException {
        super(serverUri, username, password, realm);
        this.commonPrefix = commonPrefix;
    }

    public GenericServiceLocator(final Context context, final String commonPrefix) {
        super(context);
        this.commonPrefix = commonPrefix;
    }

    @Override
    public Object lookup(String name) {
        if (commonPrefix != null) {
            name = commonPrefix + "/" + name;
        }
        return super.lookup(name);
    }

    /**
     * Usable with JNDI name formats ending in the full class name of the interface
     * <p/>
     * Such as:
     * - {interfaceClass}
     * <p/>
     * Or with commonPrefix (supplied in constructor) such as:
     * - {moduleId}/{interfaceClass}
     * - ejb/{moduleId}/{interfaceClass}
     *
     * @param type the interfaceClass
     * @return (T) lookup(type.getName())
     */
    public <T> T lookup(final Class<T> type) {
        return (T) lookup(type.getName());
    }

    /**
     * Usable with JNDI name formats including a varying prefix such as ejbName or deploymentID
     * and ending in the full class name of the interface
     * <p/>
     * Such as:
     * - {ejbName}/{interfaceClass}
     * - {deploymentId}/{interfaceClass}
     * <p/>
     * Or with commonPrefix (supplied in constructor) such as:
     * - {moduleId}/{ejbName}/{interfaceClass}
     * - ejb/{moduleId}/{deploymentId}/{interfaceClass}
     *
     * @param prefix such as ejbName or deploymentId
     * @param type   the interfaceClass
     * @return (T) lookup(prefix + "/" + type.getName())
     */
    public <T> T lookup(final String prefix, final Class<T> type) {
        return (T) lookup(prefix + "/" + type.getName());
    }

    /**
     * Usable with JNDI name formats comprised of the interfaceClass and ejbClass
     * <p/>
     * For variation, the interface class is the prefix and the ejb class is the
     * suffix.  This is neat as the the prefix (the interface class name) becomes
     * a jndi context with one binding in it for each implementing ejb class.
     * <p/>
     * Works with:
     * - {interfaceClass}/{ejbClass}
     * <p/>
     * Or with commonPrefix (supplied in constructor) such as:
     * - {moduleId}/{interfaceClass}/{ejbClass}
     * - ejb/{moduleId}/{interfaceClass}/{ejbClass}
     *
     * @param type     the interfaceClass
     * @param ejbClass the ejbClass
     * @return (T) lookup(type.getName() + "/" + ejbClass.getName())
     */
    public <T, B> T lookup(final Class<T> type, final Class<B> ejbClass) {
        return (T) lookup(type.getName() + "/" + ejbClass.getName());
    }
}