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.InputStream;
23
24 /**
25 * GordianKnot Zip ReadFile API.
26 */
27 public interface GordianZipReadFile {
28 /**
29 * Obtain the contents.
30 *
31 * @return the contents
32 */
33 GordianZipFileContents getContents();
34
35 /**
36 * Is the zip file encrypted?
37 *
38 * @return true/false
39 */
40 boolean isEncrypted();
41
42 /**
43 * Obtain the lock for the file.
44 *
45 * @return the lock
46 */
47 GordianZipLock getLock();
48
49 /**
50 * Obtain an input stream for an entry in the zip file.
51 *
52 * @param pFile the file details for the new zip entry
53 * @return the input stream
54 * @throws GordianException on error
55 */
56 InputStream createInputStream(GordianZipFileEntry pFile) throws GordianException;
57
58 /**
59 * Read an entry in the zip file and parse as an XML Document.
60 *
61 * @param pFile the file details for the new zip entry
62 * @return the parsed XML Document
63 * @throws GordianException on error
64 */
65 Document readXMLDocument(GordianZipFileEntry pFile) throws GordianException;
66 }