001/**
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.camel.spi;
018
019import java.util.Map;
020import java.util.Set;
021
022/**
023 * Represents a service registry which may be implemented via a Spring ApplicationContext,
024 * via JNDI, a simple Map or the OSGi Service Registry
025 */
026public interface Registry {
027
028    /**
029     * Looks up a service in the registry based purely on name,
030     * returning the service or <tt>null</tt> if it could not be found.
031     *
032     * @param name the name of the service
033     * @return the service from the registry or <tt>null</tt> if it could not be found
034     */
035    Object lookupByName(String name);
036
037    /**
038     * Looks up a service in the registry, returning the service or <tt>null</tt> if it could not be found.
039     *
040     * @param name the name of the service
041     * @param type the type of the required service
042     * @return the service from the registry or <tt>null</tt> if it could not be found
043     */
044    <T> T lookupByNameAndType(String name, Class<T> type);
045
046    /**
047     * Finds services in the registry by their type.
048     *
049     * @param type  the type of the registered services
050     * @return the types found, with their ids as the key. Returns an empty Map if none found.
051     */
052    <T> Map<String, T> findByTypeWithName(Class<T> type);
053
054    /**
055     * Finds services in the registry by their type.
056     *
057     * @param type  the type of the registered services
058     * @return the types found. Returns an empty Set if none found.
059     */
060    <T> Set<T> findByType(Class<T> type);
061
062}