ArchiveInputStream

java.lang.Object
- java.io.InputStream
- - java.io.FilterInputStream
  - - java.util.zip.InflaterInputStream
    - - java.util.zip.ZipInputStream
      - no.nordicsemi.android.dfu.internal.ArchiveInputStream

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable
```
public class ArchiveInputStream
extends java.util.zip.ZipInputStream
```
Reads the firmware files from the a ZIP file. The ZIP file must be either created using the nrf utility tool, available together with Master Control Panel v3.8.0+, or follow the backward compatibility syntax: must contain only files with names: application.hex/bin, softdevice.hex/dat or bootloader.hex/bin, optionally also application.dat and/or system.dat with init packets.

The ArchiveInputStream will read only files with types specified by types parameter of the constructor.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CENATT`
`static int`	`CENATX`
`static int`	`CENCOM`
`static int`	`CENCRC`
`static int`	`CENDSK`
`static int`	`CENEXT`
`static int`	`CENFLG`
`static int`	`CENHDR`
`static int`	`CENHOW`
`static int`	`CENLEN`
`static int`	`CENNAM`
`static int`	`CENOFF`
`static long`	`CENSIG`
`static int`	`CENSIZ`
`static int`	`CENTIM`
`static int`	`CENVEM`
`static int`	`CENVER`
`static int`	`ENDCOM`
`static int`	`ENDHDR`
`static int`	`ENDOFF`
`static long`	`ENDSIG`
`static int`	`ENDSIZ`
`static int`	`ENDSUB`
`static int`	`ENDTOT`
`static int`	`EXTCRC`
`static int`	`EXTHDR`
`static int`	`EXTLEN`
`static long`	`EXTSIG`
`static int`	`EXTSIZ`
`static int`	`LOCCRC`
`static int`	`LOCEXT`
`static int`	`LOCFLG`
`static int`	`LOCHDR`
`static int`	`LOCHOW`
`static int`	`LOCLEN`
`static int`	`LOCNAM`
`static long`	`LOCSIG`
`static int`	`LOCSIZ`
`static int`	`LOCTIM`
`static int`	`LOCVER`

Fields inherited from class java.util.zip.InflaterInputStream
buf, inf, len

Fields inherited from class java.io.FilterInputStream
in

Constructor Summary

Constructors
Constructor and Description
`ArchiveInputStream(java.io.InputStream stream, int mbrSize, int types)` The ArchiveInputStream read HEX or BIN files from the Zip stream.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`applicationImageSize()` Returns the total size of the Application firmware.
`int`	`available()`
`int`	`bootloaderImageSize()` Returns the total size of the Bootloader firmware.
`void`	`close()`
`byte[]`	`getApplicationInit()` Returns the content of the init file for the Application or `null` if no application file in the ZIP, or the DAT file is not provided.
`int`	`getContentType()` Returns the content type based on the content of the ZIP file.
`Manifest`	`getManifest()` Returns the manifest object if it was specified in the ZIP file.
`byte[]`	`getSystemInit()` Returns the content of the init file for SoftDevice and/or Bootloader.
`int`	`read(byte[] buffer)`
`int`	`setContentType(int type)` Truncates the current content type.
`int`	`softDeviceImageSize()` Returns the total size of the SoftDevice firmware.

Methods inherited from class java.util.zip.ZipInputStream
closeEntry, createZipEntry, getNextEntry, read, skip

Methods inherited from class java.util.zip.InflaterInputStream
fill, mark, markSupported, read, reset

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - LOCSIG
```
public static final long LOCSIG
```
    See Also:
    
    Constant Field Values
  - EXTSIG
```
public static final long EXTSIG
```
    See Also:
    
    Constant Field Values
  - CENSIG
```
public static final long CENSIG
```
    See Also:
    
    Constant Field Values
  - ENDSIG
```
public static final long ENDSIG
```
    See Also:
    
    Constant Field Values
  - LOCHDR
```
public static final int LOCHDR
```
    See Also:
    
    Constant Field Values
  - EXTHDR
```
public static final int EXTHDR
```
    See Also:
    
    Constant Field Values
  - CENHDR
```
public static final int CENHDR
```
    See Also:
    
    Constant Field Values
  - ENDHDR
```
public static final int ENDHDR
```
    See Also:
    
    Constant Field Values
  - LOCVER
```
public static final int LOCVER
```
    See Also:
    
    Constant Field Values
  - LOCFLG
```
public static final int LOCFLG
```
    See Also:
    
    Constant Field Values
  - LOCHOW
```
public static final int LOCHOW
```
    See Also:
    
    Constant Field Values
  - LOCTIM
```
public static final int LOCTIM
```
    See Also:
    
    Constant Field Values
  - LOCCRC
```
public static final int LOCCRC
```
    See Also:
    
    Constant Field Values
  - LOCSIZ
```
public static final int LOCSIZ
```
    See Also:
    
    Constant Field Values
  - LOCLEN
```
public static final int LOCLEN
```
    See Also:
    
    Constant Field Values
  - LOCNAM
```
public static final int LOCNAM
```
    See Also:
    
    Constant Field Values
  - LOCEXT
```
public static final int LOCEXT
```
    See Also:
    
    Constant Field Values
  - EXTCRC
```
public static final int EXTCRC
```
    See Also:
    
    Constant Field Values
  - EXTSIZ
```
public static final int EXTSIZ
```
    See Also:
    
    Constant Field Values
  - EXTLEN
```
public static final int EXTLEN
```
    See Also:
    
    Constant Field Values
  - CENVEM
```
public static final int CENVEM
```
    See Also:
    
    Constant Field Values
  - CENVER
```
public static final int CENVER
```
    See Also:
    
    Constant Field Values
  - CENFLG
```
public static final int CENFLG
```
    See Also:
    
    Constant Field Values
  - CENHOW
```
public static final int CENHOW
```
    See Also:
    
    Constant Field Values
  - CENTIM
```
public static final int CENTIM
```
    See Also:
    
    Constant Field Values
  - CENCRC
```
public static final int CENCRC
```
    See Also:
    
    Constant Field Values
  - CENSIZ
```
public static final int CENSIZ
```
    See Also:
    
    Constant Field Values
  - CENLEN
```
public static final int CENLEN
```
    See Also:
    
    Constant Field Values
  - CENNAM
```
public static final int CENNAM
```
    See Also:
    
    Constant Field Values
  - CENEXT
```
public static final int CENEXT
```
    See Also:
    
    Constant Field Values
  - CENCOM
```
public static final int CENCOM
```
    See Also:
    
    Constant Field Values
  - CENDSK
```
public static final int CENDSK
```
    See Also:
    
    Constant Field Values
  - CENATT
```
public static final int CENATT
```
    See Also:
    
    Constant Field Values
  - CENATX
```
public static final int CENATX
```
    See Also:
    
    Constant Field Values
  - CENOFF
```
public static final int CENOFF
```
    See Also:
    
    Constant Field Values
  - ENDSUB
```
public static final int ENDSUB
```
    See Also:
    
    Constant Field Values
  - ENDTOT
```
public static final int ENDTOT
```
    See Also:
    
    Constant Field Values
  - ENDSIZ
```
public static final int ENDSIZ
```
    See Also:
    
    Constant Field Values
  - ENDOFF
```
public static final int ENDOFF
```
    See Also:
    
    Constant Field Values
  - ENDCOM
```
public static final int ENDCOM
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ArchiveInputStream
```
public ArchiveInputStream(java.io.InputStream stream,
                          int mbrSize,
                          int types)
                   throws java.io.IOException
```
    The ArchiveInputStream read HEX or BIN files from the Zip stream. It may skip some of them, depending on the value of the types parameter. This is useful if the DFU service wants to send the Soft Device and Bootloader only, and then the Application in the following connection, despite the ZIP file contains all 3 HEX/BIN files. When types is equal to DfuBaseService.TYPE_AUTO all present files are read.
    
    Use bit combination of the following types:
    Parameters:
    
    stream - the Zip Input Stream
    
    mbrSize - The size of the MRB segment (Master Boot Record) on the device. The parser will cut data from addresses below that number from all HEX files.
    
    types - File types that are to be read from the ZIP. Use DfuBaseService.TYPE_APPLICATION etc.
    
    Throws:
    
    java.io.IOException
- Method Detail
  - close
```
public void close()
           throws java.io.IOException
```
    Specified by:
    
    close in interface java.io.Closeable
    
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Overrides:
    
    close in class java.util.zip.ZipInputStream
    
    Throws:
    
    java.io.IOException
  - read
```
public int read(byte[] buffer)
         throws java.io.IOException
```
    Overrides:
    
    read in class java.io.FilterInputStream
    
    Throws:
    
    java.io.IOException
  - getManifest
```
public Manifest getManifest()
```
    Returns the manifest object if it was specified in the ZIP file.
    
    Returns:
    
    the manifest object
  - getContentType
```
public int getContentType()
```
    Returns the content type based on the content of the ZIP file. The content type may be truncated using setContentType(int).
    
    Returns:
    
    a bit field of TYPE_SOFT_DEVICE, TYPE_BOOTLOADER and TYPE_APPLICATION
  - setContentType
```
public int setContentType(int type)
```
    Truncates the current content type. May be used to hide some files, f.e. to send Soft Device and Bootloader without Application or only the Application.
    
    Parameters:
    
    type - the new type
    
    Returns:
    
    the final type after truncating
  - available
```
public int available()
```
    Overrides:
    
    available in class java.util.zip.ZipInputStream
  - softDeviceImageSize
```
public int softDeviceImageSize()
```
    Returns the total size of the SoftDevice firmware. In case the firmware was given as a HEX, this method returns the size of the BIN content of the file.
    
    Returns:
    
    the size of the SoftDevice firmware (BIN part)
  - bootloaderImageSize
```
public int bootloaderImageSize()
```
    Returns the total size of the Bootloader firmware. In case the firmware was given as a HEX, this method returns the size of the BIN content of the file.
    
    Returns:
    
    the size of the Bootloader firmware (BIN part)
  - applicationImageSize
```
public int applicationImageSize()
```
    Returns the total size of the Application firmware. In case the firmware was given as a HEX, this method returns the size of the BIN content of the file.
    
    Returns:
    
    the size of the Application firmware (BIN part)
  - getSystemInit
```
public byte[] getSystemInit()
```
    Returns the content of the init file for SoftDevice and/or Bootloader. When both SoftDevice and Bootloader are present in the ZIP file (as two files using the compatibility mode or as one file using the new Distribution packet) the system init contains validation data for those two files combined (e.g. the CRC value). This method may return null if there is no SoftDevice nor Bootloader in the ZIP or the DAT file is not present there.
    
    Returns:
    
    the content of the init packet for SoftDevice and/or Bootloader
  - getApplicationInit
```
public byte[] getApplicationInit()
```
    Returns the content of the init file for the Application or null if no application file in the ZIP, or the DAT file is not provided.
    
    Returns:
    
    the content of the init packet for Application

Class ArchiveInputStream

Field Summary

Fields inherited from class java.util.zip.InflaterInputStream

Fields inherited from class java.io.FilterInputStream

Constructor Summary

Method Summary

Methods inherited from class java.util.zip.ZipInputStream

Methods inherited from class java.util.zip.InflaterInputStream

Methods inherited from class java.lang.Object

Field Detail

LOCSIG

EXTSIG

CENSIG

ENDSIG

LOCHDR

EXTHDR

CENHDR

ENDHDR

LOCVER

LOCFLG

LOCHOW

LOCTIM

LOCCRC

LOCSIZ

LOCLEN

LOCNAM

LOCEXT

EXTCRC

EXTSIZ

EXTLEN

CENVEM

CENVER

CENFLG

CENHOW

CENTIM

CENCRC

CENSIZ

CENLEN

CENNAM

CENEXT

CENCOM

CENDSK

CENATT

CENATX

CENOFF

ENDSUB

ENDTOT

ENDSIZ

ENDOFF

ENDCOM

Constructor Detail

ArchiveInputStream

Method Detail

close

read

getManifest

getContentType

setContentType

available

softDeviceImageSize

bootloaderImageSize

applicationImageSize

getSystemInit

getApplicationInit