Класс JarInputStream

java.util.jar.JarInputStream

Все реализованные интерфейсы:: Closeable, AutoCloseable

public class JarInputStream extends ZipInputStream

Класс JarInputStream, который расширяет ZipInputStream, используется для чтения содержимого файла JAR из потока ввода. Он предоставляет поддержку чтения необязательной записи Manifest. Класс Manifest может использоваться для хранения метаданных о файле JAR и его записях.

Доступ к Manifest

Метод getManifest используется для возвращения Manifest из записи META-INF/MANIFEST.MF при условии, что она является первой записью в потоке (или второй, если первая запись в потоке META-INF/, а вторая запись META-INF/MANIFEST.MF).

Методы getNextJarEntry() и getNextEntry() используются для чтения записей файла JAR из потока. Эти методы пропускают Manifest (META-INF/MANIFEST.MF) когда он находится в начале потока. Другими словами, эти методы не возвращают запись для Manifest, когда Manifest является первой записью в потоке. Если первой записью является META-INF/, а второй записью — Manifest, то обе эти записи пропускаются этими методами. Не определено, пропускают ли эти методы Manifest, если он встречается позже в потоке.

Подписанные файлы JAR

Подписанный JarInputStream проверяет подписи записей в подписанном файле JAR, когда:

Manifest является первой записью в потоке (или второй, если первая запись в потоке META-INF/, а вторая запись META-INF/MANIFEST.MF).
Все записи, связанные с подписью, следуют непосредственно за Manifest

После того, как JarEntry будет полностью проверен (это делается путем чтения до конца входного потока записи), можно вызвать JarEntry.getCertificates() для получения сертификатов для этой записи и JarEntry.getCodeSigners() для получения подписывающих сторон.

Важно отметить, что процесс проверки не включает проверку сертификата подписывающей стороны. Вызывающая сторона должна проверить возвращаемое значение JarEntry.getCodeSigners(), чтобы дополнительно определить, можно ли доверять подписи.

Примечание API:

Если JarEntry изменяется после того, как файл JAR был подписан, при чтении записи будет брошено исключение SecurityException.

С:

1.2

См. также:

Краткое описание полей

Модификатор и тип	Поле	Описание
`static final int`	`CENATT`	Смещение поля атрибутов внутреннего файла заголовка центрального каталога (CEN).
`static final int`	`CENATX`	Смещение поля атрибутов внешнего файла заголовка центрального каталога (CEN).
`static final int`	`CENCOM`	Смещение поля длины комментария заголовка центрального каталога (CEN).
`static final int`	`CENCRC`	Смещение поля значения CRC-32 нескомпрессированного файла заголовка центрального каталога (CEN).
`static final int`	`CENDSK`	Смещение поля начального номера диска заголовка центрального каталога (CEN).
`static final int`	`CENEXT`	Смещение поля длины дополнительного поля заголовка центрального каталога (CEN).
`static final int`	`CENFLG`	Смещение поля смещения флагов шифрования/дешифрования заголовка центрального каталога (CEN).
`static final int`	`CENHDR`	Размер заголовка центрального каталога (CEN) в байтах (включая сигнатуру).
`static final int`	`CENHOW`	Смещение поля метода сжатия заголовка центрального каталога (CEN).
`static final int`	`CENLEN`	Смещение поля размера нескомпрессированного файла заголовка центрального каталога (CEN).
`static final int`	`CENNAM`	Смещение поля длины имени файла заголовка центрального каталога (CEN).
`static final int`	`CENOFF`	Смещение поля смещения заголовка LOC заголовка центрального каталога (CEN).
`static final long`	`CENSIG`	Сигнатура заголовка центрального каталога (CEN).
`static final int`	`CENSIZ`	Смещение поля размера сжатого файла заголовка центрального каталога (CEN).
`static final int`	`CENTIM`	Смещение поля времени модификации заголовка центрального каталога (CEN).
`static final int`	`CENVEM`	Смещение поля смещения версии, создавшей файл, заголовка центрального каталога (CEN).
`static final int`	`CENVER`	Смещение поля версии, необходимой для извлечения, заголовка центрального каталога (CEN).
`static final int`	`ENDCOM`	Смещение поля длины комментария файла ZIP в заголовке конца центрального каталога (END).
`static final int`	`ENDHDR`	Размер заголовка конца центрального каталога (END) в байтах (включая сигнатуру).
`static final int`	`ENDOFF`	Смещение поля смещения первого заголовка CEN в заголовке конца центрального каталога (END).
`static final long`	`ENDSIG`	Сигнатура заголовка конца центрального каталога (END).
`static final int`	`ENDSIZ`	Смещение поля размера центрального каталога в байтах в заголовке конца центрального каталога (END).
`static final int`	`ENDSUB`	Смещение поля количества записей на этом диске в заголовке конца центрального каталога (END).
`static final int`	`ENDTOT`	Смещение поля общего количества записей в заголовке конца центрального каталога (END).
`static final int`	`EXTCRC`	Смещение поля значения CRC-32 нескомпрессированного файла дополнительного локального заголовка (EXT).
`static final int`	`EXTHDR`	Размер дополнительного локального заголовка (EXT) в байтах (включая сигнатуру).
`static final int`	`EXTLEN`	Смещение поля размера нескомпрессированного файла дополнительного локального заголовка (EXT).
`static final long`	`EXTSIG`	Сигнатура дополнительного локального заголовка (EXT).
`static final int`	`EXTSIZ`	Смещение поля размера сжатого файла дополнительного локального заголовка (EXT).
`static final int`	`LOCCRC`	Смещение поля значения CRC-32 нескомпрессированного файла локального заголовка (LOC).
`static final int`	`LOCEXT`	Смещение поля длины дополнительного поля локального заголовка (LOC).
`static final int`	`LOCFLG`	Смещение поля флага общего назначения локального заголовка (LOC).
`static final int`	`LOCHDR`	Размер локального заголовка (LOC) в байтах (включая сигнатуру).
`static final int`	`LOCHOW`	Смещение поля метода сжатия локального заголовка (LOC).
`static final int`	`LOCLEN`	Смещение поля размера нескомпрессированного файла локального заголовка (LOC).
`static final int`	`LOCNAM`	Смещение поля длины имени файла локального заголовка (LOC).
`static final long`	`LOCSIG`	Сигнатура локального заголовка (LOC).
`static final int`	`LOCSIZ`	Смещение поля размера сжатого файла локального заголовка (LOC).
`static final int`	`LOCTIM`	Смещение поля времени модификации локального заголовка (LOC).
`static final int`	`LOCVER`	Смещение поля версии, необходимой для извлечения, локального заголовка (LOC).

Поля, объявленные в классе java.util.zip.InflaterInputStream

buf, inf, len

Поля, объявленные в классе java.io.FilterInputStream

in

Краткое описание конструкторов

Конструктор	Описание
`JarInputStream(InputStream in)`	Создает новый `JarInputStream` и считывает необязательный манифест.
`JarInputStream(InputStream in, boolean verify)`	Создает новый `JarInputStream` и считывает необязательный манифест.

Краткое описание методов

Модификатор и тип	Метод	Описание
`protected ZipEntry`	`createZipEntry(String name)`	Создает новый `JarEntry` (`ZipEntry`) для указанного имени записи файла JAR.
`Manifest`	`getManifest()`	Возвращает `Manifest` для этого файла JAR, когда он является первой записью в потоке (или второй записью, если первой записью в потоке является `META-INF/` и второй записью является `META-INF/MANIFEST.MF`), или `null` в противном случае.
`ZipEntry`	`getNextEntry()`	Считывает следующую запись файла ZIP и позиционирует поток в начале данных записи.
`JarEntry`	`getNextJarEntry()`	Считывает следующую запись файла JAR и позиционирует поток в начале данных записи.
`int`	`read(byte[] b, int off, int len)`	Считывает из текущей записи файла JAR в массив байтов, возвращая количество распакованных байтов.

Методы, объявленные в классе java.util.zip.ZipInputStream

available, close, closeEntry, read, readAllBytes, readNBytes, readNBytes, skip, skipNBytes, transferTo

Методы, объявленные в классе java.util.zip.InflaterInputStream

fill, mark, markSupported, reset

Методы, объявленные в классе java.io.FilterInputStream

read

Методы, объявленные в классе java.io.InputStream

nullInputStream

Методы, объявленные в классе java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Подробное описание полей

LOCSIG

static final long LOCSIG

Подпись заголовка локального файла (LOC).

См. также:

EXTSIG

static final long EXTSIG

Подпись дополнительного локального заголовка (EXT).

См. также:

CENSIG

static final long CENSIG

Подпись заголовка центрального каталога (CEN).

См. также:

ENDSIG

static final long ENDSIG

Подпись заголовка конца центрального каталога (END).

См. также:

LOCHDR

static final int LOCHDR

Размер заголовка локального файла (LOC) в байтах (включая подпись).

См. также:

EXTHDR

static final int EXTHDR

Размер дополнительного локального заголовка (EXT) в байтах (включая подпись).

См. также:

CENHDR

static final int CENHDR

Размер заголовка центрального каталога (CEN) в байтах (включая подпись).

См. также:

ENDHDR

static final int ENDHDR

Размер заголовка конца центрального каталога (END) в байтах (включая подпись).

См. также:

LOCVER

static final int LOCVER

Смещение поля версии заголовка локального файла (LOC), необходимой для извлечения.

См. также:

LOCFLG

static final int LOCFLG

Смещение поля флага общего назначения заголовка локального файла (LOC).

См. также:

LOCHOW

static final int LOCHOW

Смещение поля метода сжатия заголовка локального файла (LOC).

См. также:

LOCTIM

static final int LOCTIM

Смещение поля времени изменения заголовка локального файла (LOC).

См. также:

LOCCRC

static final int LOCCRC

Смещение поля значения CRC-32 нескомпрессированного файла заголовка локального файла (LOC).

См. также:

LOCSIZ

static final int LOCSIZ

Смещение поля сжатого размера заголовка локального файла (LOC).

См. также:

LOCLEN

static final int LOCLEN

Смещение поля размера нескомпрессированного файла заголовка локального файла (LOC).

См. также:

LOCNAM

static final int LOCNAM

Смещение поля длины имени файла заголовка локального файла (LOC).

См. также:

LOCEXT

static final int LOCEXT

Смещение поля длины дополнительного поля заголовка локального файла (LOC).

См. также:

EXTCRC

static final int EXTCRC

Смещение поля значения CRC-32 нескомпрессированного файла дополнительного локального заголовка (EXT).

См. также:

EXTSIZ

static final int EXTSIZ

Смещение поля сжатого размера дополнительного локального заголовка (EXT).

См. также:

EXTLEN

static final int EXTLEN

Смещение поля размера нескомпрессированного файла дополнительного локального заголовка (EXT).

См. также:

CENVEM

static final int CENVEM

Смещение поля версии, созданной заголовком центрального каталога (CEN).

См. также:

CENVER

static final int CENVER

Смещение поля версии, необходимой для извлечения, заголовка центрального каталога (CEN).

См. также:

CENFLG

static final int CENFLG

Смещение поля флагов шифрования/расшифрования заголовка центрального каталога (CEN).

См. также:

CENHOW

static final int CENHOW

Смещение поля метода сжатия заголовка центрального каталога (CEN).

См. также:

CENTIM

static final int CENTIM

Смещение поля времени изменения заголовка центрального каталога (CEN).

См. также:

CENCRC

static final int CENCRC

Смещение поля значения CRC-32 нескомпрессированного файла заголовка центрального каталога (CEN).

См. также:

CENSIZ

static final int CENSIZ

Смещение поля сжатого размера заголовка центрального каталога (CEN).

См. также:

CENLEN

static final int CENLEN

Смещение поля размера нескомпрессированного файла заголовка центрального каталога (CEN).

См. также:

CENNAM

static final int CENNAM

Смещение поля длины имени файла заголовка центрального каталога (CEN).

См. также:

CENEXT

static final int CENEXT

Смещение поля длины дополнительного поля заголовка центрального каталога (CEN).

См. также:

CENCOM

static final int CENCOM

Смещение поля длины комментария заголовка центрального каталога (CEN).

См. также:

CENDSK

static final int CENDSK

Смещение поля номера диска начала заголовка центрального каталога (CEN).

См. также:

CENATT

static final int CENATT

Смещение поля атрибутов внутреннего файла заголовка центрального каталога (CEN).

См. также:

CENATX

static final int CENATX

Смещение поля атрибутов внешнего файла заголовка центрального каталога (CEN).

См. также:

CENOFF

static final int CENOFF

Смещение поля смещения заголовка LOC в заголовке центрального каталога (CEN).

См. также:

ENDSUB

static final int ENDSUB

Смещение поля количества записей на этом диске в заголовке конца центрального каталога (END).

См. также:

ENDTOT

static final int ENDTOT

Смещение поля общего количества записей в заголовке конца центрального каталога (END).

См. также:

ENDSIZ

static final int ENDSIZ

Смещение поля размера центрального каталога в байтах в заголовке конца центрального каталога (END).

См. также:

ENDOFF

static final int ENDOFF

Смещение поля смещения первого заголовка CEN в заголовке конца центрального каталога (END).

См. также:

ENDCOM

static final int ENDCOM

Смещение поля длины комментария файла ZIP в заголовке конца центрального каталога (END).

См. также:

Подробное описание конструкторов

JarInputStream

public JarInputStream(InputStream in) throws IOException

Создаёт новый JarInputStream и считывает необязательный манифест. Если манифест присутствует, также пытается проверить подписи, если JarInputStream подписан.

Параметры:: in - фактический входной поток
Исключения:: IOException - если произошла ошибка ввода-вывода

JarInputStream

public JarInputStream(InputStream in, boolean verify) throws IOException

Создаёт новый JarInputStream и считывает необязательный манифест. Если манифест присутствует и verify равен true, также пытается проверить подписи, если JarInputStream подписан.

Параметры:: in - фактический входной поток; verify - выполнять ли проверку JarInputStream, если он подписан.
Исключения:: IOException - если произошла ошибка ввода-вывода

Подробное описание методов

getManifest

public Manifest getManifest()

Возвращает Manifest для этого файла JAR, когда он является первой записью в потоке (или второй записью, если первая запись в потоке — META-INF/, а вторая — META-INF/MANIFEST.MF), или null в противном случае.

Возвращает:: Manifest для этого файла JAR, или null в противном случае.

getNextEntry

public ZipEntry getNextEntry() throws IOException

Считывает следующую запись файла ZIP и устанавливает поток в начало данных записи. Если проверка включена, любое обнаруженное недействительное значение подписи при позиционировании потока для следующей записи приведет к исключению.

Переопределяет:: getNextEntry в классе ZipInputStream
Возвращает:: следующую запись файла ZIP или null, если больше записей нет
Исключения:: ZipException - если произошла ошибка файла ZIP; IOException - если произошла ошибка ввода-вывода; SecurityException - если какая-либо из записей файла JAR подписана неправильно.

getNextJarEntry

public JarEntry getNextJarEntry() throws IOException

Считывает следующую запись файла JAR и устанавливает поток в начало данных записи. Если проверка включена, любое обнаруженное недействительное значение подписи при позиционировании потока для следующей записи приведет к исключению.

Возвращает:: следующую запись файла JAR или null, если больше записей нет
Исключения:: ZipException - если произошла ошибка файла ZIP; IOException - если произошла ошибка ввода-вывода; SecurityException - если какая-либо из записей файла JAR подписана неправильно.

read

public int read(byte[] b, int off, int len) throws IOException

Считывает из текущей записи JAR в массив байтов, возвращая количество распакованных байтов. Если len не равно нулю, метод блокируется до тех пор, пока доступен какой-либо ввод; в противном случае байты не считываются, и возвращается 0.

Если текущая запись сжата и этот метод возвращает ненулевое целое число n, то buf[off] через buf[off+n-1] содержат данные без сжатия. Содержимое элементов buf[off+n] через buf[off+len-1] не определено, вопреки спецификации суперкласса InputStream, поэтому реализация свободна изменять эти элементы во время операции распаковки. Если этот метод возвращает -1 или выбрасывает исключение, то содержимое buf[off] через buf[off+len-1] не определено.

Если проверка включена, любая недействительная подпись в текущей записи будет сообщена в какой-то момент до достижения конца записи.

Переопределяет:

read в классе ZipInputStream

Параметры:

b - буфер, в который считываются данные

off - начальное смещение в целевом массиве b

len - максимальное количество байтов для чтения

Возвращает:

фактическое количество прочитанных байтов или -1, если достигнут конец записи

Исключения:

NullPointerException - Если b равно null.

IndexOutOfBoundsException - Если off отрицательно, len отрицательно или len больше b.length - off

ZipException - если произошла ошибка файла ZIP

IOException - если произошла ошибка ввода-вывода

SecurityException - если какая-либо из записей файла JAR подписана неправильно.

См. также:

createZipEntry

protected ZipEntry createZipEntry(String name)

Создаёт новую JarEntry (ZipEntry) для указанного имени записи файла JAR. Атрибуты манифеста указанного имени записи файла JAR будут скопированы в новую JarEntry.

Переопределяет:: createZipEntry в классе ZipInputStream
Параметры:: name - имя записи файла JAR/ZIP
Возвращает:: объект JarEntry, который был только что создан

© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/jar/JarInputStream.html