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.component.bean;
018
019import org.apache.camel.NoSuchBeanException;
020import org.apache.camel.Processor;
021
022/**
023 * Object holder for a bean.
024 *
025 * @version 
026 */
027public interface BeanHolder {
028
029    /**
030     * Gets the bean.
031     *
032     * @throws NoSuchBeanException is thrown if the bean cannot be found.
033     */
034    Object getBean() throws NoSuchBeanException;
035
036    /**
037     * Gets a {@link Processor} for this bean, if supported.
038     *
039     * @return the {@link Processor}, or <tt>null</tt> if not supported.
040     */
041    Processor getProcessor();
042
043    /**
044     * Whether a {@link Processor} is supported by this bean holder.
045     *
046     * @return <tt>true</tt> if the holder can supporting using a processor, <tt>false</tt> otherwise
047     */
048    boolean supportProcessor();
049
050    /**
051     * Gets bean info for the bean.
052     */
053    BeanInfo getBeanInfo();
054
055    /**
056     * Gets bean info for the given bean.
057     * <p/>
058     * This implementation allows a thread safe usage for {@link BeanHolder} implementations
059     * such as the {@link RegistryBean}.
060     *
061     * @param bean the bean
062     * @return <tt>null</tt> if not supported, then use {@link #getBeanInfo()} instead.
063     */
064    BeanInfo getBeanInfo(Object bean);
065}