View Javadoc

1   /*
2    * Copyright 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  
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 157038 2005-03-11 03:44:40Z ddewolf $
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       * (web.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       * (web.xml).
53       * @param pd
54       * @throws IOException if an IO error occurs.
55       */
56      void write(PortletAppDD pd) throws IOException;
57  }