IStoreConfig


1   /*
2    * Copyright 1999-2001,2004 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.catalina.storeconfig;
18  
19  import java.io.PrintWriter  ;
20  
21  import org.apache.catalina.Context;
22  import org.apache.catalina.Host;
23  import org.apache.catalina.Server;
24  import org.apache.catalina.Service;
25  
26  /**
27   * @author Peter Rossbach 
28   *  
29   */
30  public interface IStoreConfig {
31  
32      /**
33       * Get Configuration Registry
34       * 
35       * @return aRegistry that handle the store operations
36       */
37      StoreRegistry getRegistry();
38  
39      /**
40       * Set Configuration Registry
41       * 
42       * @param aRegistry
43       *            aregistry that handle the store operations
44       */
45      void setRegistry(StoreRegistry aRegistry);
46  
47      /**
48       * Store the current StoreFactory Server.
49       * 
50       * @exception Exception
51       *                if an exception occurs while storing
52       */
53      void storeConfig() throws Exception  ;
54  
55      /**
56       * Store the specified Server properties.
57       * 
58       * @param aServer
59       *            Object to be stored
60       * 
61       * @exception Exception
62       *                if an exception occurs while storing
63       */
64      void store(Server aServer) throws Exception  ;
65  
66      /**
67       * Store the specified Server properties.
68       * 
69       * @param aWriter
70       *            PrintWriter to which we are storing
71       * @param indent
72       *            Number of spaces to indent this element
73       * @param aServer
74       *            Object to be stored
75       * 
76       * @exception Exception
77       *                if an exception occurs while storing
78       */
79      void store(PrintWriter   aWriter, int indent, Server aServer);
80  
81      /**
82       * Store the specified Service properties.
83       * 
84       * @param aWriter
85       *            PrintWriter to which we are storing
86       * @param indent
87       *            Number of spaces to indent this element
88       * @param aService
89       *            Object to be stored
90       * 
91       * @exception Exception
92       *                if an exception occurs while storing
93       */
94      void store(PrintWriter   aWriter, int indent, Service aService);
95  
96      /**
97       * Store the specified Host properties.
98       * 
99       * @param aWriter
100      *            PrintWriter to which we are storing
101      * @param indent
102      *            Number of spaces to indent this element
103      * @param aHost
104      *            Object to be stored
105      * 
106      * @exception Exception
107      *                if an exception occurs while storing
108      */
109     void store(PrintWriter   aWriter, int indent, Host aHost);
110 
111     /**
112      * Store the specified Context properties.
113      * 
114      * @param aContext
115      *            Object to be stored
116      * 
117      * @exception Exception
118      *                if an exception occurs while storing
119      */
120     void store(Context aContext);
121 
122     /**
123      * Store the specified Context properties.
124      * 
125      * @param aWriter
126      *            PrintWriter to which we are storing
127      * @param indent
128      *            Number of spaces to indent this element
129      * @param aContext
130      *            Object to be stored
131      * 
132      * @exception Exception
133      *                if an exception occurs while storing
134      */
135     void store(PrintWriter   aWriter, int indent, Context aContext);
136 }
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags