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