View Javadoc

1   // 
2   // Copyright (c) 2003, Caltha - Gajda, Krzewski, Mach, Potempski Sp.J. 
3   // All rights reserved. 
4   //   
5   // Redistribution and use in source and binary forms, with or without modification,  
6   // are permitted provided that the following conditions are met: 
7   //   
8   // * Redistributions of source code must retain the above copyright notice,  
9   //   this list of conditions and the following disclaimer. 
10  // * Redistributions in binary form must reproduce the above copyright notice,  
11  //   this list of conditions and the following disclaimer in the documentation  
12  //   and/or other materials provided with the distribution. 
13  // * Neither the name of the Caltha - Gajda, Krzewski, Mach, Potempski Sp.J.  
14  //   nor the names of its contributors may be used to endorse or promote products  
15  //   derived from this software without specific prior written permission. 
16  // 
17  // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"  
18  // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED  
19  // WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 
20  // IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,  
21  // INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,  
22  // BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, 
23  // OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,  
24  // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)  
25  // ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE  
26  // POSSIBILITY OF SUCH DAMAGE. 
27  //
28  
29  package org.objectledge.pico.customization;
30  
31  import org.picocontainer.PicoContainer;
32  import org.picocontainer.PicoInitializationException;
33  import org.picocontainer.PicoIntrospectionException;
34  import org.picocontainer.PicoVerificationException;
35  
36  /***
37   * Provides customized component adapters, based on requesting component's key and implementation 
38   * class.
39   *
40   * @author <a href="Rafal.Krzewski">rafal@caltha.pl</a>
41   * @version $Id: CustomizedComponentProvider.java,v 1.10 2005/02/04 02:28:15 rafal Exp $
42   */
43  public interface CustomizedComponentProvider
44  {
45      /***
46       * Returns a customized component instance.
47       * 
48       * @param container the container.
49       * @param componentKey requesting component's key.
50       * @param componentImplementaion requesting component's implmenetation class.
51       * @return customized component.
52       * @throws PicoInitializationException if the customized component cannot be initialized.
53       * @throws PicoIntrospectionException if the customized component cannot be initialized.
54       * @throws UnsupportedKeyTypeException if the componentKey has unsupported type.
55       */
56      public Object getCustomizedComponentInstance(PicoContainer container, Object componentKey,
57          Class componentImplementaion)
58          throws PicoInitializationException, PicoIntrospectionException, UnsupportedKeyTypeException;
59      
60      /***
61       * Returns the type of the customized components.
62       * 
63       * @return the type of the customized components.
64       */
65      public Class getCustomizedComponentImplementation();
66      
67      /***
68       * Verifies if the customized component can be instantiated using the dependencies present
69       * in the associated container.
70       * 
71       * @param container the container.
72       * @throws PicoVerificationException if the container does not contain required
73       *         dependencies.
74       */
75      public void verify(PicoContainer container) 
76          throws PicoVerificationException;
77  }