KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > cocoon > portal > PortalComponentManager


1 /*
2  * Copyright 1999-2002,2004-2005 The Apache Software Foundation.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 package org.apache.cocoon.portal;
17
18 import org.apache.avalon.framework.context.Context;
19 import org.apache.cocoon.portal.coplet.CopletFactory;
20 import org.apache.cocoon.portal.event.EventManager;
21 import org.apache.cocoon.portal.layout.LayoutFactory;
22 import org.apache.cocoon.portal.layout.renderer.Renderer;
23 import org.apache.cocoon.portal.profile.ProfileManager;
24
25 /**
26  * This component provides access to all other components used
27  * throughout the portal.
28  * Any component in the portal should never lookup these components
29  * itself, but use this component manager instead.
30  *
31  * This manager allows to run differently configured portals in Cocoon
32  * at the same time. This component can't be looked up using the
33  * usual Avalon mechanisms, it has to be get by the {@link PortalService}.
34  *
35  * @author <a HREF="mailto:cziegeler@s-und-n.de">Carsten Ziegeler</a>
36  *
37  * @version CVS $Id: PortalComponentManager.java 230796 2005-08-08 12:54:55Z cziegeler $
38  */
39 public interface PortalComponentManager {
40
41     /**
42      * Get the link service.
43      */
44     LinkService getLinkService();
45
46     /**
47      * Get the current profile manager.
48      */
49     ProfileManager getProfileManager();
50
51     /**
52      * Get the renderer.
53      */
54     Renderer getRenderer(String JavaDoc hint);
55
56     /**
57      * Get the coplet factory.
58      */
59     CopletFactory getCopletFactory();
60     
61     /**
62      * Get the layout factory
63      */
64     LayoutFactory getLayoutFactory();
65     
66     /**
67      * Get the event manager
68      */
69     EventManager getEventManager();
70
71     /**
72      * Get the portal manager
73      * @since 2.1.8
74      */
75     PortalManager getPortalManager();
76
77
78     /**
79      * Return the component context.
80      * @since 2.1.8
81      */
82     Context getComponentContext();
83 }
84
Popular Tags