BundleArchiveImpl

java.lang.Object
- org.knopflerfish.framework.bundlestorage.file.BundleArchiveImpl

All Implemented Interfaces:: BundleArchive

public class BundleArchiveImpl
extends java.lang.Object
implements BundleArchive

Interface for managing bundle data.

Field Summary
- Fields inherited from interface org.knopflerfish.framework.BundleArchive
  AUTOSTART_SETTING_ACTIVATION_POLICY, AUTOSTART_SETTING_EAGER, AUTOSTART_SETTING_STOPPED

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()` Close archive for further access.
`java.util.Enumeration<java.lang.String>`	`findResourcesPath(java.lang.String path)` Returns an Enumeration of all the paths (`String` objects) to entries within the bundle whose longest sub-path matches the supplied path argument.
`java.lang.String`	`getAttribute(java.lang.String key)` Get an attribute from the manifest of a bundle.
`int`	`getAutostartSetting()` Get autostart setting.
`BundleGeneration`	`getBundleGeneration()` Get bundle generation associated with this bundle archive.
`long`	`getBundleId()` Get bundle identifier for this bundle archive.
`java.lang.String`	`getBundleLocation()` Get bundle location for this bundle archive.
`BundleResourceStream`	`getBundleResourceStream(java.lang.String component, int ix)` Get a BundleResourceStream to named entry inside a bundle.
`java.util.ArrayList<java.util.List<java.security.cert.X509Certificate>>`	`getCertificateChains(boolean onlyTrusted)` Return certificates for signed bundle, otherwise null.
`FileArchive`	`getFileArchive(java.lang.String path)` Get a FileArchive handle to a named Jar file or directory within this archive.
`java.lang.String`	`getJarLocation()`
`long`	`getLastModified()` Get last modified timestamp.
`java.util.Hashtable<java.lang.String,java.lang.String>`	`getLocalizationEntries(java.lang.String localeFile)` returns the localization entries of this archive.
`int`	`getStartLevel()` Get stored bundle start level.
`HeaderDictionary`	`getUnlocalizedAttributes()` returns the raw unlocalized entries of this archive.
`void`	`purge()` Remove bundle archive from persistent storage.
`void`	`setAutostartSetting(int setting)` Set autostart setting.
`void`	`setBundleGeneration(BundleGeneration bg)` Set bundle generation associated with this bundle archive.
`void`	`setLastModified(long timemillisecs)` Set stored last modified timestamp.
`void`	`setStartLevel(int level)` Set stored bundle start level.
`void`	`trustCertificateChain(java.util.List<java.security.cert.X509Certificate> trustedChain)` Mark certificate chain as trusted.

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

- Method Detail
  - getAttribute
```
public java.lang.String getAttribute(java.lang.String key)
```
    Get an attribute from the manifest of a bundle.
    
    Specified by:
    
    getAttribute in interface BundleArchive
    
    Parameters:
    
    key - Name of attribute to get.
    
    Returns:
    
    A string with result or null if the entry doesn't exists.
  - getFileArchive
```
public FileArchive getFileArchive(java.lang.String path)
```
    Get a FileArchive handle to a named Jar file or directory within this archive.
    
    Specified by:
    
    getFileArchive in interface BundleArchive
    
    Parameters:
    
    path - Name of Jar file or directory to get.
    
    Returns:
    
    A FileArchive object representing new archive, null if not found.
    
    Throws:
    
    java.io.IOException - if we failed to get top of file archive.
  - getLocalizationEntries
```
public java.util.Hashtable<java.lang.String,java.lang.String> getLocalizationEntries(java.lang.String localeFile)
```
    returns the localization entries of this archive.
    
    Specified by:
    
    getLocalizationEntries in interface BundleArchive
    
    Parameters:
    
    localeFile - Filename within archive for localization properties.
    
    Returns:
    
    null or a mapping of the entries.
  - getUnlocalizedAttributes
```
public HeaderDictionary getUnlocalizedAttributes()
```
    returns the raw unlocalized entries of this archive.
    
    Specified by:
    
    getUnlocalizedAttributes in interface BundleArchive
  - getBundleGeneration
```
public BundleGeneration getBundleGeneration()
```
    Get bundle generation associated with this bundle archive.
    
    Specified by:
    
    getBundleGeneration in interface BundleArchive
    
    Returns:
    
    BundleGeneration object.
  - setBundleGeneration
```
public void setBundleGeneration(BundleGeneration bg)
```
    Set bundle generation associated with this bundle archive.
    
    Specified by:
    
    setBundleGeneration in interface BundleArchive
    
    Parameters:
    
    BundleGeneration - object.
  - getBundleId
```
public long getBundleId()
```
    Get bundle identifier for this bundle archive.
    
    Specified by:
    
    getBundleId in interface BundleArchive
    
    Returns:
    
    Bundle identifier.
  - getBundleLocation
```
public java.lang.String getBundleLocation()
```
    Get bundle location for this bundle archive.
    
    Specified by:
    
    getBundleLocation in interface BundleArchive
    
    Returns:
    
    Bundle location.
  - getStartLevel
```
public int getStartLevel()
```
    Description copied from interface: BundleArchive
    
    Get stored bundle start level.
    
    Specified by:
    
    getStartLevel in interface BundleArchive
  - setStartLevel
```
public void setStartLevel(int level)
                   throws java.io.IOException
```
    Description copied from interface: BundleArchive
    
    Set stored bundle start level.
    
    Specified by:
    
    setStartLevel in interface BundleArchive
    
    Throws:
    
    java.io.IOException
  - getLastModified
```
public long getLastModified()
```
    Description copied from interface: BundleArchive
    
    Get last modified timestamp.
    
    Specified by:
    
    getLastModified in interface BundleArchive
  - setLastModified
```
public void setLastModified(long timemillisecs)
                     throws java.io.IOException
```
    Description copied from interface: BundleArchive
    
    Set stored last modified timestamp.
    
    Specified by:
    
    setLastModified in interface BundleArchive
    
    Throws:
    
    java.io.IOException
  - getBundleResourceStream
```
public BundleResourceStream getBundleResourceStream(java.lang.String component,
                                                    int ix)
```
    Get a BundleResourceStream to named entry inside a bundle. Leading '/' is stripped.
    
    Specified by:
    
    getBundleResourceStream in interface BundleArchive
    
    Parameters:
    
    component - Entry to get reference to.
    
    ix - index of sub archives. A postive number is the classpath entry index. 0 means look in the main bundle.
    
    Returns:
    
    BundleResourceStream to entry or null if it doesn't exist.
  - getAutostartSetting
```
public int getAutostartSetting()
```
    Get autostart setting.
    
    Specified by:
    
    getAutostartSetting in interface BundleArchive
    
    Returns:
    
    the autostart setting.
  - setAutostartSetting
```
public void setAutostartSetting(int setting)
                         throws java.io.IOException
```
    Set autostart setting.
    
    Specified by:
    
    setAutostartSetting in interface BundleArchive
    
    Parameters:
    
    setting - the new autostart setting.
    
    Throws:
    
    java.io.IOException
  - findResourcesPath
```
public java.util.Enumeration<java.lang.String> findResourcesPath(java.lang.String path)
```
    Description copied from interface: BundleArchive
    
    Returns an Enumeration of all the paths (String objects) to entries within the bundle whose longest sub-path matches the supplied path argument.
    
    Specified by:
    
    findResourcesPath in interface BundleArchive
    
    Returns:
  - getJarLocation
```
public java.lang.String getJarLocation()
```
    Specified by:
    
    getJarLocation in interface BundleArchive
    
    Returns:
    
    the location of the cached bundle.
  - getCertificateChains
```
public java.util.ArrayList<java.util.List<java.security.cert.X509Certificate>> getCertificateChains(boolean onlyTrusted)
```
    Return certificates for signed bundle, otherwise null.
    
    Specified by:
    
    getCertificateChains in interface BundleArchive
    
    Parameters:
    
    onlyTrusted - Only return trusted certificates.
    
    Returns:
    
    An array of certificates or null.
  - trustCertificateChain
```
public void trustCertificateChain(java.util.List<java.security.cert.X509Certificate> trustedChain)
```
    Mark certificate chain as trusted.
    
    Specified by:
    
    trustCertificateChain in interface BundleArchive
  - purge
```
public void purge()
```
    Remove bundle archive from persistent storage. If we removed the active revision also remove bundle status files.
    
    Specified by:
    
    purge in interface BundleArchive
  - close
```
public void close()
```
    Close archive for further access. It should still be possible to get attributes.
    
    Specified by:
    
    close in interface BundleArchive

Class BundleArchiveImpl

Field Summary

Fields inherited from interface org.knopflerfish.framework.BundleArchive

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getAttribute

getFileArchive

getLocalizationEntries

getUnlocalizedAttributes

getBundleGeneration

setBundleGeneration

getBundleId

getBundleLocation

getStartLevel

setStartLevel

getLastModified

setLastModified

getBundleResourceStream

getAutostartSetting

setAutostartSetting

findResourcesPath

getJarLocation

getCertificateChains

trustCertificateChain

purge

close