Registry.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.camel.spi;

import java.util.Map;
import java.util.Set;

/**
 * Represents a service registry which may be implemented via a Spring ApplicationContext,
 * via JNDI, a simple Map or the OSGi Service Registry
 *
 * @version 
 */
public interface Registry {

    /**
     * Looks up a service in the registry based purely on name,
     * returning the service or <tt>null</tt> if it could not be found.
     *
     * @param name the name of the service
     * @return the service from the registry or <tt>null</tt> if it could not be found
     */
    Object lookupByName(String name);

    /**
     * Looks up a service in the registry, returning the service or <tt>null</tt> if it could not be found.
     *
     * @param name the name of the service
     * @param type the type of the required service
     * @return the service from the registry or <tt>null</tt> if it could not be found
     */
    <T> T lookupByNameAndType(String name, Class<T> type);

    /**
     * Finds services in the registry by their type.
     *
     * @param type  the type of the registered services
     * @return the types found, with their ids as the key. Returns an empty Map if none found.
     */
    <T> Map<String, T> findByTypeWithName(Class<T> type);

    /**
     * Finds services in the registry by their type.
     *
     * @param type  the type of the registered services
     * @return the types found. Returns an empty Set if none found.
     */
    <T> Set<T> findByType(Class<T> type);

    /**
     * Looks up a service in the registry based purely on name,
     * returning the service or <tt>null</tt> if it could not be found.
     *
     * @param name the name of the service
     * @return the service from the registry or <tt>null</tt> if it could not be found
     * @deprecated use {@link #lookupByName(String)}
     */
    @Deprecated
    Object lookup(String name);

    /**
     * Looks up a service in the registry, returning the service or <tt>null</tt> if it could not be found.                                            cha
     *
     * @param name the name of the service
     * @param type the type of the required service
     * @return the service from the registry or <tt>null</tt> if it could not be found
     * @deprecated use {@link #lookupByNameAndType(String, Class)}
     */
    @Deprecated
    <T> T lookup(String name, Class<T> type);

    /**
     * Looks up services in the registry by their type.
     * <p/>
     * <b>Note:</b> Not all registry implementations support this feature,
     * such as the {@link org.apache.camel.impl.JndiRegistry}.
     *
     * @param type  the type of the registered services
     * @return the types found, with their id as the key. Returns an empty Map if none found.
     * @deprecated use {@link #findByTypeWithName(Class)}
     */
    @Deprecated
    <T> Map<String, T> lookupByType(Class<T> type);

}