Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/stain/nio-zipfs

java.util.nio zipfs file system - from OpenJDK8u demo code
https://github.com/stain/nio-zipfs

Last synced: about 1 month ago
JSON representation

java.util.nio zipfs file system - from OpenJDK8u demo code

Awesome Lists containing this project

README 

        
# nio-zipfs



[ZipFileSystem](src/main/java/no/s11/zipfs/ZipFileSystem) 

is a file system provider that treats the contents of a zip or

JAR file as a [java.nio.file.FileSystem](http://docs.oracle.com/javase/7/docs/api/java/nio/file/FileSystem.html).



# Related projects



[zipfilesystem-standalone](https://github.com/marschall/zipfilesystem-standalone) by Philippe Marschall.



# Building



To build, you will need Oracle JDK 7/OpenJDK 7 or newer, 

together with [Apache Maven 3.x](http://maven.apache.org/download.html). 



This implementation is tested with Maven 3.2, openjdk7 and openjdk8.



To build:



	mvn clean install



To then use from a Maven project, use:



	

		no.s11.zipfs

		nio-zipfs

		8.60.0-SNAPSHOT	

	

	

Check [pom.xml](pom.xml) to find the latest `` number.	



TODO: Set up Maven snapshot repository.



# Usage



If `nio-zipfs` is on the Java classpath, then it should be discovered by the

ServiceLoader mechanism in [FileSystemProvider](http://docs.oracle.com/javase/7/docs/api/java/nio/file/spi/FileSystemProvider.html).



*WARNING*: If [java.nio.file.spi.FileSystemProvider.installedProviders()



The factory methods defined by the 

[java.nio.file.FileSystems](http://docs.oracle.com/javase/7/docs/api/java/nio/file/FileSystems.html) 

class can be used to create a `ZipFileSystem` for an existing ZIP file:



	   // use file type detection

	   Path zipfile = Paths.get("foo.zip");

	   FileSystem fs = FileSystems.newFileSystem(zipfile, null);



-or-:



	   // locate file system by the legacy ZIP URL syntax

	   Map env = Collections.emptyMap();

	   URI uri = URI.create("zip:file:/mydir/foo.zip");

	   FileSystem fs = FileSystems.newFileSystem(uri, env);



Once a FileSystem is created then classes in the 

[java.nio.file package](http://docs.oracle.com/javase/7/docs/api/java/nio/file/package-summary.html)

can be used to access files in the zip/JAR file, eg:



	   Path mf = fs.getPath("/META-INF/MANIFEST.MF");

	   InputStream in = mf.newInputStream();



See [Demo.java](src/test/java/no/s11/zipfs/Demo.java) for more interesting usages.



# License



**License**: [BSD 3-Clause](http://opensource.org/licenses/BSD-3-Clause)



- Copyright (c) 2015 University of Manchester, UK.

- Copyright (c) 2009, 2012, Oracle and/or its affiliates. 



All rights reserved.  



Based on the zipfs demo of OpenJDK 8 by Oracle, distributed

under a [BSD 3-Clause license](LICENSE).



For details, see the files [NOTICE](NOTICE) and [LICENSE](LICENSE). 



## Relation to OpenJDK



This code is based on the 

[demo/nio/zipfs](http://hg.openjdk.java.net/jdk8u/jdk8u/jdk/file/default/src/share/demo/nio/zipfs) 

code from [OpenJDK 8](http://openjdk.java.net/projects/jdk8/) which has been distributed

with Open JDK since 7u20.



While OpenJDK 8 is licensed under 

[GPL 2 with the classpath exception](http://openjdk.java.net/legal/gplv2+ce.html),

the zipfs code was 

[distributed under the BSD 3-Clause license](http://hg.openjdk.java.net/jdk8u/jdk8u/jdk/file/c10fd784956c/src/share/demo/nio/zipfs/src/com/sun/nio/zipfs/ZipFileSystemProvider.java#l2).



Since OpenJDK 9, 

[zipfs is included in the main OpenJDK codebase](http://hg.openjdk.java.net/jdk9/dev/jdk/file/default/src/jdk.zipfs/share/classes/jdk/nio/zipfs), 

but now covered by the GPL license.



This code in *nio-zipfs* is only based on the OpenJDK 8 demo code,

and remains licensed under BSD 3-Clause, which makes it compatible with 

other open source licenses like Apache Software License 2.0,

provided you retain the notices in the files [NOTICE](NOTICE) and [LICENSE](LICENSE).  



# Contributing



If you have a question, feature request or think you found a bug, 

please raise a [GitHub issue](https://github.com/stain/nio-zipfs/issues).



To suggest changes or improvements to the code, please raise 

a [GitHub pull request](https://github.com/stain/nio-zipfs/pulls). 

The whole purpose of moving this code out of OpenJDK is to be able

to improve it independently of the OpenJDK release schedule. 



Please make sure that your patch is a clean contribution intellectual-property-wise, e.g. 

that you or your employer owns the copyright or that you are allowed to contribute it

under the BSD 3-Clause license. This means that you *cannot* contribute any code from the

[upstream OpenJDK 9 code base]((http://hg.openjdk.java.net/jdk9/dev/jdk/file/default/src/jdk.zipfs/share/classes/jdk/nio/zipfs)

as it is now licensed under GPL. Patches from 

[upstream OpenJDK 8](http://hg.openjdk.java.net/jdk8u/jdk8u/jdk/file/default/src/share/demo/nio/zipfs) )

are however allowed, as long as they still have the BSD license headers. 



There's no mailing list, but you can 

[watch this repository](https://github.com/stain/nio-zipfs/subscription) to be included

when issues and pull requests are raised.