File: IStoreFactory.java

package info (click to toggle)
tomcat10 10.1.52-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 47,900 kB
  • sloc: java: 375,756; xml: 59,410; jsp: 4,741; sh: 1,381; perl: 324; makefile: 25; ansic: 14
file content (65 lines) | stat: -rw-r--r-- 1,869 bytes parent folder | download | duplicates (11)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.catalina.storeconfig;

import java.io.PrintWriter;

public interface IStoreFactory {

    /**
     * @return the writer
     */
    StoreAppender getStoreAppender();

    /**
     * Set the store appender.
     *
     * @param storeWriter the writer
     */
    void setStoreAppender(StoreAppender storeWriter);

    /**
     * Set the registry.
     *
     * @param aRegistry the registry to be associated with
     */
    void setRegistry(StoreRegistry aRegistry);

    /**
     * @return the associated registry
     */
    StoreRegistry getRegistry();

    /**
     * Store a server.xml element with attributes and children.
     *
     * @param aWriter  the writer to write to
     * @param indent   the indentation
     * @param aElement the element to write
     *
     * @throws Exception if an error occurs
     */
    void store(PrintWriter aWriter, int indent, Object aElement) throws Exception;

    /**
     * Store XML header.
     *
     * @param aWriter the writer to write to
     */
    void storeXMLHead(PrintWriter aWriter);

}