** * The "permissions" attribute is the set of access permissions that are optionally * stored for entries in a Zip file. The value of the attribute is {@code null} * for entries that do not have access permissions. Zip file systems do not * enforce access permissions. * ** * *
** * * *Name *Type ** * *permissions *{@link Set}<{@link PosixFilePermission}> *
The "permissions" attribute may be read and set using the * {@linkplain Files#getAttribute(Path, String, LinkOption...) Files.getAttribute} and * {@linkplain Files#setAttribute(Path, String, Object, LinkOption...) Files.setAttribute} * methods. The following example uses these methods to read and set the attribute: *
{@code
* Set perms = Files.getAttribute(entry, "zip:permissions");
* if (perms == null) {
* perms = PosixFilePermissions.fromString("rw-rw-rw-");
* Files.setAttribute(entry, "zip:permissions", perms);
* }
* }
*
* In addition to the "{@code zip}" view, a Zip file system optionally supports * the {@link PosixFileAttributeView} ("{@code posix}"). * This view extends the "{@code basic}" view with type safe access to the * {@link PosixFileAttributes#owner() owner}, {@link PosixFileAttributes#group() group-owner}, * and {@link PosixFileAttributes#permissions() permissions} attributes. The * "{@code posix}" view is only supported when the Zip file system is created with * the provider property "{@code enablePosixFileAttributes}" set to "{@code true}". * The following creates a file system with this property and reads the access * permissions of a file: *
{@code
* var env = Map.of("enablePosixFileAttributes", "true");
* try (FileSystem fs = FileSystems.newFileSystem(file, env) {
* Path entry = fs.getPath("entry");
* Set perms = Files.getPosixFilePermissions(entry);
* }
* }
*
* The file owner and group owner attributes are not persisted, meaning they are * not stored in the zip file. The "{@code defaultOwner}" and "{@code defaultGroup}" * provider properties (listed below) can be used to configure the default values * for these attributes. If these properties are not set then the file owner * defaults to the owner of the zip file, and the group owner defaults to the * zip file's group owner (or the file owner on platforms that don't support a * group owner). * *
The "{@code permissions}" attribute is not optional in the "{@code posix}" * view so a default set of permissions are used for entries that do not have * access permissions stored in the Zip file. The default set of permissions * are *
| Property Name | *Data Type | *Default Value | *Description | *
|---|---|---|---|
| create | *{@link java.lang.String} or {@link java.lang.Boolean} | *false | ** If the value is {@code true}, the Zip file system provider * creates a new Zip or JAR file if it does not exist. * | *
| encoding | *{@link java.lang.String} | *UTF-8 | ** The value indicates the encoding scheme for the * names of the entries in the Zip or JAR file. * | *
| enablePosixFileAttributes | *{@link java.lang.String} or {@link java.lang.Boolean} | *false | ** If the value is {@code true}, the Zip file system will support * the {@link java.nio.file.attribute.PosixFileAttributeView PosixFileAttributeView}. * | *
| defaultOwner | *{@link java.nio.file.attribute.UserPrincipal UserPrincipal} or * {@link java.lang.String} |
* null/unset | *
* Override the default owner for entries in the Zip file system. * The value can be a UserPrincipal or a String value that is used as the UserPrincipal's name. * |
*
| defaultGroup | *{@link java.nio.file.attribute.GroupPrincipal GroupPrincipal} or * {@link java.lang.String} |
* null/unset | *
* Override the the default group for entries in the Zip file system. * The value can be a GroupPrincipal or a String value that is used as the GroupPrincipal's name. * |
*
| defaultPermissions | *{@link java.util.Set Set}<{@link java.nio.file.attribute.PosixFilePermission PosixFilePermission}> * or {@link java.lang.String} |
* null/unset | *
* Override the default Set of permissions for entries in the Zip file system. * The value can be a {@link java.util.Set Set}<{@link java.nio.file.attribute.PosixFilePermission PosixFilePermission}> or * a String that is parsed by {@link java.nio.file.attribute.PosixFilePermissions#fromString PosixFilePermissions::fromString} * |
*
| compressionMethod | *{@link java.lang.String} | *"DEFLATED" | *
* The value representing the compression method to use when writing entries
* to the Zip file system.
*
|
*
| releaseVersion | *{@link java.lang.String} or {@link java.lang.Integer} | *null/unset | *
* A value representing the version entry to use when accessing a
*
* multi-release JAR. If the JAR is not a
*
* multi-release JAR, the value will be ignored and the JAR will be
* considered un-versioned.
* * The value must represent a valid * {@linkplain Runtime.Version Java SE Platform version number}, * such as {@code 9}, or {@code 14} in order to determine the version entry. * *
|
*
* {@code
*
* URI uri = URI.create("jar:file:/home/luckydog/tennisTeam.zip");
* Map env = Map.of("create", "true");
* FileSystem zipfs = FileSystems.newFileSystem(uri, env);
* }
*
*
* Construct a new Zip file system that is identified by specifying a path
* and using automatic file type detection. Iterate from the root of the JAR displaying each
* found entry:
*
* {@code
*
* FileSystem zipfs = FileSystems.newFileSystem(Path.of("helloworld.jar"));
* Path rootDir = zipfs.getPath("/");
* Files.walk(rootDir)
* .forEach(System.out::println);
* }
*
* @provides java.nio.file.spi.FileSystemProvider
* @moduleGraph
* @since 9
*/
module jdk.zipfs {
provides java.nio.file.spi.FileSystemProvider with
jdk.nio.zipfs.ZipFileSystemProvider;
}