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 */
017 package org.apache.camel.spi;
018
019 import java.util.Map;
020 import 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 *
026 * @version
027 */
028 public interface Registry {
029
030 /**
031 * Looks up a service in the registry based purely on name,
032 * returning the service or <tt>null</tt> if it could not be found.
033 *
034 * @param name the name of the service
035 * @return the service from the registry or <tt>null</tt> if it could not be found
036 */
037 Object lookupByName(String name);
038
039 /**
040 * Looks up a service in the registry, returning the service or <tt>null</tt> if it could not be found.
041 *
042 * @param name the name of the service
043 * @param type the type of the required service
044 * @return the service from the registry or <tt>null</tt> if it could not be found
045 */
046 <T> T lookupByNameAndType(String name, Class<T> type);
047
048 /**
049 * Finds services in the registry by their type.
050 *
051 * @param type the type of the registered services
052 * @return the types found, with their ids as the key. Returns an empty Map if none found.
053 */
054 <T> Map<String, T> findByTypeWithName(Class<T> type);
055
056 /**
057 * Finds services in the registry by their type.
058 *
059 * @param type the type of the registered services
060 * @return the types found. Returns an empty Set if none found.
061 */
062 <T> Set<T> findByType(Class<T> type);
063
064 /**
065 * Looks up a service in the registry based purely on name,
066 * returning the service or <tt>null</tt> if it could not be found.
067 *
068 * @param name the name of the service
069 * @return the service from the registry or <tt>null</tt> if it could not be found
070 * @deprecated use {@link #lookupByName(String)}
071 */
072 @Deprecated
073 Object lookup(String name);
074
075 /**
076 * Looks up a service in the registry, returning the service or <tt>null</tt> if it could not be found. cha
077 *
078 * @param name the name of the service
079 * @param type the type of the required service
080 * @return the service from the registry or <tt>null</tt> if it could not be found
081 * @deprecated use {@link #lookupByNameAndType(String, Class)}
082 */
083 @Deprecated
084 <T> T lookup(String name, Class<T> type);
085
086 /**
087 * Looks up services in the registry by their type.
088 * <p/>
089 * <b>Note:</b> Not all registry implementations support this feature,
090 * such as the {@link org.apache.camel.impl.JndiRegistry}.
091 *
092 * @param type the type of the registered services
093 * @return the types found, with their id as the key. Returns an empty Map if none found.
094 * @deprecated use {@link #findByTypeWithName(Class)}
095 */
096 @Deprecated
097 <T> Map<String, T> lookupByType(Class<T> type);
098
099 }