1 /**
2 * Portions of this software was developed by employees of the National Institute
3 * of Standards and Technology (NIST), an agency of the Federal Government and is
4 * being made available as a public service. Pursuant to title 17 United States
5 * Code Section 105, works of NIST employees are not subject to copyright
6 * protection in the United States. This software may be subject to foreign
7 * copyright. Permission in the United States and in foreign countries, to the
8 * extent that NIST may hold copyright, to use, copy, modify, create derivative
9 * works, and distribute this software and its documentation without fee is hereby
10 * granted on a non-exclusive basis, provided that this notice and disclaimer
11 * of warranty appears in all copies.
12 *
13 * THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER
14 * EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY
15 * THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF
16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM
17 * INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE
18 * SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE. IN NO EVENT
19 * SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT,
20 * INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM,
21 * OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY,
22 * CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR
23 * PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT
24 * OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER.
25 */
26
27 package gov.nist.secauto.swid.plugin.entry;
28
29 import org.codehaus.plexus.components.io.fileselectors.FileInfo;
30
31 import java.io.FileNotFoundException;
32 import java.io.IOException;
33 import java.io.InputStream;
34 import java.nio.file.Path;
35 import java.util.List;
36
37 public interface FileEntry {
38
39 /**
40 * Retrieve the path to the file.
41 *
42 * @return the path
43 */
44 public Path getPath();
45
46 /**
47 * Retrieve the path to the file relative to where it is to be output.
48 *
49 * @return the path
50 */
51 public String getOutputRelativePath();
52
53 /**
54 * Retrieve the relative path of to the SWID Tag.
55 *
56 * @param swidTagPath
57 * the path to relativize
58 * @return the file's relative path
59 */
60 public List<String> getRelativePathSegements(String swidTagPath);
61
62 /**
63 * Retrieve the file's size.
64 *
65 * @return the size in bytes
66 */
67 public Long getSize();
68
69 /**
70 * Retrieve an input stream that can be used to read the file.
71 *
72 * @return an input stream
73 * @throws FileNotFoundException
74 * if the file does not exist
75 * @throws IOException
76 * if the file cannot be read
77 */
78 public InputStream getInputStream() throws FileNotFoundException, IOException;
79
80 /**
81 * Retrieve the file's version.
82 *
83 * @return the file's version or <code>null</code> if a version cannot be determined
84 */
85 public String getVersion();
86
87 public FileInfo asFileInfo();
88 }