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  package org.apache.pluto.descriptors.services;
17  
18  import java.io.IOException;
19  
20  import org.apache.pluto.descriptors.servlet.WebAppDD;
21  
22  /***
23   * WebApplication configuration as contained
24   * within the web.xml Deployment Descriptor.
25   *
26   * @author <a href="ddewolf@apache.org">David H. DeWolf</a>
27   * @version $Id: WebAppDescriptorService.java 157038 2005-03-11 03:44:40Z ddewolf $
28   * @since Feb 28, 2005
29   */
30  public interface WebAppDescriptorService {
31  
32      /***
33       * Retrieve the name of the context path
34       * within which WebApps retrieved from this
35       * service reside.
36       * @return
37       */
38      String getContextPath();
39  
40      /***
41       * Retrieve the WebApp deployment descriptor
42       * (web.xml).
43       * @return Object representation of the descriptor.
44       * @throws IOException if an IO error occurs.
45       */ 
46      WebAppDD read() throws IOException;
47  
48      /***
49       * Write the WebApp deployment descriptor
50       * (web.xml).
51       * @param dd
52       * @throws IOException if an IO error occurs.
53       */
54      void write(WebAppDD dd) throws IOException;
55  }