1 /*
2 * GordianKnot: Security Suite
3 * Copyright 2012-2026. Tony Washer
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
6 * use this file except in compliance with the License. You may obtain a copy
7 * of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
13 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
14 * License for the specific language governing permissions and limitations under
15 * the License.
16 */
17 package io.github.tonywasher.joceanus.gordianknot.api.zip;
18
19 import io.github.tonywasher.joceanus.gordianknot.api.base.GordianException;
20 import org.w3c.dom.Document;
21
22 import java.io.File;
23 import java.io.IOException;
24 import java.io.OutputStream;
25
26
27 /**
28 * GordianKnot Zip WriteFile API.
29 */
30 public interface GordianZipWriteFile extends AutoCloseable {
31 /**
32 * Obtain an output stream for an entry in the zip file.
33 *
34 * @param pFile the file details for the new zip entry
35 * @param pCompress should we compress this file?
36 * @return the output stream
37 * @throws GordianException on error
38 */
39 OutputStream createOutputStream(File pFile,
40 boolean pCompress) throws GordianException;
41
42 /**
43 * Write an XML Document as a compressed in the Zip file.
44 *
45 * @param pFile the file details for the new zip entry
46 * @param pDocument the XML document.
47 * @throws GordianException on error
48 */
49 void writeXMLDocument(File pFile,
50 Document pDocument) throws GordianException;
51
52 /**
53 * Obtain the contents.
54 *
55 * @return the ZipFile Contents
56 */
57 GordianZipFileContents getContents();
58
59 /**
60 * Obtain the currently active ZipFileEntry.
61 *
62 * @return the ZipFile Entry
63 */
64 GordianZipFileEntry getCurrentEntry();
65
66 @Override
67 void close() throws IOException;
68 }