1   /**
2    * Copyright (c) 2000-2008 Liferay, Inc. All rights reserved.
3    *
4    * Permission is hereby granted, free of charge, to any person obtaining a copy
5    * of this software and associated documentation files (the "Software"), to deal
6    * in the Software without restriction, including without limitation the rights
7    * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8    * copies of the Software, and to permit persons to whom the Software is
9    * furnished to do so, subject to the following conditions:
10   *
11   * The above copyright notice and this permission notice shall be included in
12   * all copies or substantial portions of the Software.
13   *
14   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20   * SOFTWARE.
21   */
22  
23  package com.liferay.portal.bean;
24  
25  import com.liferay.portal.kernel.bean.BeanLocator;
26  import com.liferay.portal.kernel.bean.BeanLocatorException;
27  import com.liferay.portal.spring.util.SpringUtil;
28  
29  import java.util.HashSet;
30  import java.util.Set;
31  
32  import org.apache.commons.logging.Log;
33  import org.apache.commons.logging.LogFactory;
34  
35  import org.springframework.context.ApplicationContext;
36  
37  /**
38   * <a href="BeanLocatorImpl.java.html"><b><i>View Source</i></b></a>
39   *
40   * @author Brian Wing Shun Chan
41   *
42   */
43  public class BeanLocatorImpl implements BeanLocator {
44  
45      public Object locate(String name) throws BeanLocatorException {
46          return locate(name, _DEFAULT_WARN);
47      }
48  
49      public Object locate(String name, boolean warn)
50          throws BeanLocatorException {
51  
52          if (warn) {
53              if (_beans.contains(name)) {
54                  if (_log.isWarnEnabled()) {
55                      _log.warn(
56                          "Cache the reference to " + name + " for better " +
57                              "performance");
58                  }
59              }
60          }
61  
62          ApplicationContext ctx = SpringUtil.getContext();
63  
64          if (_log.isDebugEnabled()) {
65              _log.debug("Locating " + name);
66          }
67  
68          Object obj = ctx.getBean(name);
69  
70          if (warn) {
71              _beans.add(name);
72          }
73  
74          return obj;
75      }
76  
77      private static final boolean _DEFAULT_WARN = true;
78  
79      private static Log _log = LogFactory.getLog(BeanLocatorImpl.class);
80  
81      private Set<Object> _beans = new HashSet<Object>();
82  
83  }