1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17 package org.apache.pluto.descriptors.services;
18
19 import java.io.IOException;
20
21 import org.apache.pluto.descriptors.portlet.PortletAppDD;
22
23 /***
24 * Read/Write services for Portlet Application configuration
25 * This service reads the portlet.xml and converts it to a
26 * standard bean model.
27 *
28 * @author <a href="ddewolf@apache.org">David H. DeWolf</a>
29 * @version $Id: PortletAppDescriptorService.java 264842 2005-08-30 19:54:06Z cziegeler $
30 * @since Mar 6, 2005
31 */
32 public interface PortletAppDescriptorService {
33
34 /***
35 * Retrieve the name of the context path
36 * within which PortletApps retrieved from this
37 * service reside.
38 * @return
39 */
40 String getContextPath();
41
42 /***
43 * Retrieve the PortletApp deployment descriptor
44 * (portlet.xml).
45 * @return Object representation of the descriptor.
46 * @throws IOException if an IO error occurs.
47 */
48 PortletAppDD read() throws IOException;
49
50 /***
51 * Write the PortletApp deployment descriptor
52 * (portlet.xml).
53 * @param pd
54 * @throws IOException if an IO error occurs.
55 */
56 void write(PortletAppDD pd) throws IOException;
57 }