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.driver.config;
18:
19: import org.apache.pluto.driver.services.portal.admin.PortletRegistryAdminService;
20: import org.apache.pluto.driver.services.portal.admin.RenderConfigAdminService;
21:
22: import javax.servlet.ServletContext;
23:
24: /**
25: * Interface defining a means for obtaining administrative
26: * services for portal configuration. An implementation
27: * of this interface will be bound to the portal's
28: * ServletContext IF administrative functions are
29: * supported by the current implementation.
30: *
31: * @version 1.0
32: * @since Nov 30, 2005
33: */
34: public interface AdminConfiguration {
35:
36: /**
37: * Lifecyle method used to initialize the configuration
38: * @param context
39: */
40: void init(ServletContext context)
41: throws DriverConfigurationException;
42:
43: /**
44: * Lifecylce method used to remove the configuration
45: * from service.
46: */
47: void destroy() throws DriverConfigurationException;
48:
49: /**
50: * Retrieve the administrative service for managing the
51: * portlet registry.
52: *
53: * @return the service if one has been provided
54: */
55: PortletRegistryAdminService getPortletRegistryAdminService();
56:
57: /**
58: * Retrieve the administrative service for managing the
59: * render configuration.
60: * @return the service if one has been provided
61: */
62: RenderConfigAdminService getRenderConfigAdminService();
63:
64: }
|