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 bean repository used to lookup components by name and type.
024 * This allows Camel to plugin to third-party bean repositories such as Spring, JNDI, OSGi.
025 */
026public interface BeanRepository {
027
028    /**
029     * Looks up a bean in the registry based purely on name,
030     * returning the bean or <tt>null</tt> if it could not be found.
031     * <p/>
032     * Important: Multiple beans of different types may be bound with the same name, and its
033     * encouraged to use the {@link #lookupByNameAndType(String, Class)} to lookup the bean
034     * with a specific type, or to use any of the <tt>find</tt> methods.
035     *
036     * @param name the name of the bean
037     * @return the bean from the registry or <tt>null</tt> if it could not be found
038     */
039    Object lookupByName(String name);
040
041    /**
042     * Looks up a bean in the registry, returning the bean or <tt>null</tt> if it could not be found.
043     *
044     * @param name the name of the bean
045     * @param type the type of the required bean
046     * @return the  bean from the registry or <tt>null</tt> if it could not be found
047     */
048    <T> T lookupByNameAndType(String name, Class<T> type);
049
050    /**
051     * Finds beans in the registry by their type.
052     *
053     * @param type  the type of the beans
054     * @return the types found, with their bean ids as the key. Returns an empty Map if none found.
055     */
056    <T> Map<String, T> findByTypeWithName(Class<T> type);
057
058    /**
059     * Finds beans in the registry by their type.
060     *
061     * @param type  the type of the beans
062     * @return the types found. Returns an empty Set if none found.
063     */
064    <T> Set<T> findByType(Class<T> type);
065
066    /**
067     * Strategy to wrap the value to be stored in the registry.
068     *
069     * @param value  the value
070     * @return the value to return
071     */
072    default Object unwrap(Object value) {
073        return value;
074    }
075
076}