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.pluto;
18:
19: import org.apache.pluto.spi.optional.PortletPreferencesService;
20: import org.apache.pluto.spi.optional.PortletEnvironmentService;
21: import org.apache.pluto.spi.optional.PortletInvokerService;
22: import org.apache.pluto.spi.optional.PortletRegistryService;
23: import org.apache.pluto.spi.optional.PortletInfoService;
24: import org.apache.pluto.spi.optional.PortalAdministrationService;
25: import org.apache.pluto.spi.optional.UserInfoService;
26:
27: /**
28: * Defines the services necessary for integration between the Pluto Container
29: * and a Portal.
30: *
31: * <p>NOTE: Backwards compatibility is not garaunteed against
32: * this interface as additional services may be needed.
33: * Please extend the DefaultOptionalContainerServices
34: * class to ensure your implementation can be used without
35: * modicications in the future.</p>
36: *
37: * @since 1.1.0
38: */
39: public interface OptionalContainerServices {
40:
41: /**
42: * Returns the portlet preferences service implementation
43: * used by the container.
44: *
45: * @return portlet preferences service implementation.
46: */
47: PortletPreferencesService getPortletPreferencesService();
48:
49: /**
50: * Returns the environment services implementation
51: * used by the container.
52: *
53: * @return portlet environment services implementation.
54: */
55: PortletEnvironmentService getPortletEnvironmentService();
56:
57: /**
58: * Returns the portlet registry services implementation
59: * used by the container.
60: *
61: * @return registry service implementation
62: */
63: PortletRegistryService getPortletRegistryService();
64:
65: /**
66: * Returns an invoker for the specified PortletWindow.
67: *
68: * @return an invoker which can be used to service the indicated portlet.
69: */
70: PortletInvokerService getPortletInvokerService();
71:
72: /**
73: * Returns the portlet info service implementation used
74: * by the container.
75: *
76: * @return portlet info service implementation.
77: */
78: PortletInfoService getPortletInfoService();
79:
80: /**
81: * Returns the admin service implementation used by
82: * the container.
83: *
84: * @return portal admin service
85: */
86: PortalAdministrationService getPortalAdministrationService();
87:
88: /**
89: * Returns the user info service implementation used
90: * by the container.
91: *
92: * @return user info service
93: */
94: UserInfoService getUserInfoService();
95:
96: }
|