Class Jar

java.lang.Object
aQute.bnd.osgi.Jar
All Implemented Interfaces:
Closeable, AutoCloseable
public class Jar extends Object implements Closeable

  • Field Details

    • EMPTY_ARRAY

      public static final Object[] EMPTY_ARRAY

    • METAINF_SIGNING_P

      public static final Pattern METAINF_SIGNING_P

  • Constructor Details

  • Method Details

    • fromResource

      public static Jar fromResource(String name, Resource resource) throws Exception
      Throws:
      Exception

    • getResources

      public static Stream<Resource> getResources(Resource jarResource, Predicate<String> filter) throws Exception
      Throws:
      Exception

    • setName

      public void setName(String name)

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • putResource

      public boolean putResource(String path, Resource resource)

    • putResource

      public boolean putResource(String path, Resource resource, boolean overwrite)

    • getResource

      public Resource getResource(String path)

    • getResourceNames

      public Stream<String> getResourceNames(Predicate<String> matches)

    • getResources

      public Stream<Resource> getResources(Predicate<String> matches)

    • getDirectories

      public Map<String, Map<String,Resource>> getDirectories()

    • getDirectory

      public Map<String,Resource> getDirectory(String path)

    • getResources

      public Map<String,Resource> getResources()

    • addDirectory

      public boolean addDirectory(Map<String,Resource> directory, boolean overwrite)

    • getManifest

      public Manifest getManifest() throws Exception
      Throws:
      Exception

    • getModuleName

      public String getModuleName() throws Exception
      Throws:
      Exception

    • getModuleVersion

      public String getModuleVersion() throws Exception
      Throws:
      Exception

    • exists

      public boolean exists(String path)

    • isEmpty

      public boolean isEmpty()

    • setManifest

      public void setManifest(Manifest manifest)

    • setManifest

      public void setManifest(File file) throws IOException
      Throws:
      IOException

    • getManifestName

      public String getManifestName()

    • setManifestName

      public void setManifestName(String manifestName)

    • write

      public void write(File file) throws Exception
      Throws:
      Exception

    • write

      public void write(String file) throws Exception
      Throws:
      Exception

    • write

      public void write(OutputStream to) throws Exception
      Throws:
      Exception

    • writeFolder

      public void writeFolder(File dir) throws Exception
      Throws:
      Exception

    • doChecksums

      public void doChecksums(OutputStream out) throws Exception
      Throws:
      Exception

    • writeManifest

      public void writeManifest(OutputStream out) throws Exception
      Cleanup the manifest for writing. Cleaning up consists of adding a space after any \n to prevent the manifest to see this newline as a delimiter.
      Parameters:
      out - Output
      Throws:
      IOException
      Exception

    • writeManifest

      public static void writeManifest(Manifest manifest, OutputStream out) throws IOException
      Throws:
      IOException

    • outputManifest

      public static void outputManifest(Manifest manifest, OutputStream out) throws IOException
      Main function to output a manifest properly in UTF-8.
      Parameters:
      manifest - The manifest to output
      out - The output stream
      Throws:
      IOException - when something fails

    • getName

      public String getName()

    • addAll

      public boolean addAll(Jar sub, Instruction filter)
      Add all the resources in the given jar that match the given filter.
      Parameters:
      sub - the jar
      filter - a pattern that should match the resoures in sub to be added

    • addAll

      public boolean addAll(Jar sub, Instruction filter, String destination)
      Add all the resources in the given jar that match the given filter.
      Parameters:
      sub - the jar
      filter - a pattern that should match the resoures in sub to be added

    • close

      public void close()
      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in interface Closeable

    • lastModified

      public long lastModified()

    • updateModified

      public void updateModified(long time, String reason)

    • hasDirectory

      public boolean hasDirectory(String path)

    • getPackages

      public List<String> getPackages()

    • getSource

      public File getSource()

    • setSource

      public void setSource(File source)

    • addAll

      public boolean addAll(Jar src)

    • rename

      public boolean rename(String oldPath, String newPath)

    • remove

      public Resource remove(String path)

    • setDoNotTouchManifest

      public void setDoNotTouchManifest()
      Make sure nobody touches the manifest! If the bundle is signed, we do not want anybody to touch the manifest after the digests have been calculated.

    • calcChecksums

      public void calcChecksums(String[] algorithms) throws Exception
      Calculate the checksums and set them in the manifest.
      Throws:
      Exception

    • getBsn

      public String getBsn() throws Exception
      Get the jar bsn from the Constants.BUNDLE_SYMBOLICNAME manifest header.
      Returns:
      null when the jar has no manifest, when the manifest has no Constants.BUNDLE_SYMBOLICNAME header, or when the value of the header is not a valid bsn according to BSN.
      Throws:
      Exception - when the jar is closed or when the manifest could not be retrieved.

    • getVersion

      public String getVersion() throws Exception
      Get the jar version from the Constants.BUNDLE_VERSION manifest header.
      Returns:
      null when the jar has no manifest or when the manifest has no Constants.BUNDLE_VERSION header
      Throws:
      Exception - when the jar is closed or when the manifest could not be retrieved.

    • expand

      public void expand(File dir) throws Exception
      Expand the JAR file to a directory.
      Parameters:
      dir - the dst directory, is not required to exist
      Throws:
      Exception - if anything does not work as expected.

    • ensureManifest

      public void ensureManifest() throws Exception
      Make sure we have a manifest
      Throws:
      Exception

    • isManifestFirst

      public boolean isManifestFirst()
      Answer if the manifest was the first entry

    • isReproducible

      public boolean isReproducible()

    • setReproducible

      public void setReproducible(String outputTimestamp)

    • setReproducible

      @Deprecated public void setReproducible(boolean reproducible)
      Deprecated.
      Replaced by setReproducible(String).

    • copy

      public void copy(Jar srce, String path, boolean overwrite)

    • setCompression

      public void setCompression(Jar.Compression compression)

    • hasCompression

      public Jar.Compression hasCompression()

    • getDataURI

      public URI getDataURI(String path, String mime, int max) throws Exception
      Return a data uri from the JAR. The data must be less than 32k
      Parameters:
      path - the path in the jar
      mime - the mime type
      Returns:
      a URI or null if conversion could not take place
      Throws:
      Exception

    • setDigestAlgorithms

      public void setDigestAlgorithms(String[] algorithms)

    • getTimelessDigest

      public byte[] getTimelessDigest() throws Exception
      Throws:
      Exception

    • stripSignatures

      public void stripSignatures()

    • removePrefix

      public void removePrefix(String prefixLow)

    • removeSubDirs

      public void removeSubDirs(String dir)

    • getPomXmlResources

      public Stream<Resource> getPomXmlResources()

    • setCalculateFileDigest

      public Jar setCalculateFileDigest(boolean onOrOff)
      Make this jar calculate the SHA256 when it is saved as a file. When this JAR is written, the digest is always cleared. If this flag is on, it will be calculated and set when the file is successfully saved.
      Parameters:
      onOrOff - state of calculating the digest when writing this jar. true is on, otherwise off

    • getSHA256

      public Optional<byte[]> getSHA256()
      Get the SHA256 digest of the last write operation when setCalculateFileDigest(boolean) was on.
      Returns:
      the SHA 256 digest or empty

    • getLength

      public int getLength()
      Get the length of the last written file or -1 if unavailable. The length is only calculated when the checksum calculation was on during the write.
      Returns:
      the length of the last written file or -1 if unavailable.