|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.felix.framework.cache.BundleArchive
public class BundleArchive
This class is a logical abstraction for a bundle archive. This class, combined with BundleCache and concrete BundleRevision subclasses, implement the bundle cache for Felix. The bundle archive abstracts the actual bundle content into revisions and the revisions provide access to the actual bundle content. When a bundle is installed it has one revision associated with its content. Updating a bundle adds another revision for the updated content. Any number of revisions can be associated with a bundle archive. When the bundle (or framework) is refreshed, then all old revisions are purged and only the most recent revision is maintained.
The content associated with a revision can come in many forms, such as a standard JAR file or an exploded bundle directory. The bundle archive is responsible for creating all revision instances during invocations of the revise() method call. Internally, it determines the concrete type of revision type by examining the location string as an URL. Currently, it supports standard JAR files, referenced JAR files, and referenced directories. Examples of each type of URL are, respectively:
The "reference:" notation signifies that the resource should be used "in place", meaning that they will not be copied. For referenced JAR files, some resources may still be copied, such as embedded JAR files or native libraries, but for referenced exploded bundle directories, nothing will be copied. Currently, reference URLs can only refer to "file:" targets.
BundleCache
,
BundleRevision
Field Summary | |
---|---|
static java.lang.String |
FILE_PROTOCOL
|
static java.lang.String |
INPUTSTREAM_PROTOCOL
|
static java.lang.String |
REFERENCE_PROTOCOL
|
Constructor Summary | |
---|---|
BundleArchive()
This constructor is only used by the system bundle archive implementation because it is special an is not really an archive. |
|
BundleArchive(Logger logger,
java.io.File archiveRootDir)
This constructor is called when an archive for a bundle is being reconstructed when the framework is restarted. |
|
BundleArchive(Logger logger,
java.io.File archiveRootDir,
long id,
java.lang.String location,
java.io.InputStream is)
This constructor is used for creating new archives when a bundle is installed into the framework. |
Method Summary | |
---|---|
java.io.File |
getDataFile(java.lang.String fileName)
Returns a File object corresponding to the data file of the relative path of the specified string. |
long |
getId()
Returns the bundle identifier associated with this archive. |
long |
getLastModified()
Returns the last modification time of this archive. |
java.lang.String |
getLocation()
Returns the location string associated with this archive. |
int |
getPersistentState()
Returns the persistent state of this archive. |
BundleRevision |
getRevision(int i)
Returns the revision object for the specified revision. |
int |
getRevisionCount()
Returns the number of revisions available for this archive. |
int |
getStartLevel()
Returns the start level of this archive. |
void |
purge()
This method removes all old revisions associated with the archive and keeps only the current revision. |
void |
revise(java.lang.String location,
java.io.InputStream is)
This method adds a revision to the archive. |
boolean |
rollbackRevise()
This method undoes the previous revision to the archive; this method will remove the latest revision from the archive. |
void |
setLastModified(long lastModified)
Sets the the last modification time of this archive. |
void |
setPersistentState(int state)
Sets the persistent state of this archive. |
void |
setStartLevel(int level)
Sets the the start level of this archive this archive. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final transient java.lang.String FILE_PROTOCOL
public static final transient java.lang.String REFERENCE_PROTOCOL
public static final transient java.lang.String INPUTSTREAM_PROTOCOL
Constructor Detail |
---|
public BundleArchive()
This constructor is only used by the system bundle archive implementation because it is special an is not really an archive.
public BundleArchive(Logger logger, java.io.File archiveRootDir, long id, java.lang.String location, java.io.InputStream is) throws java.lang.Exception
This constructor is used for creating new archives when a bundle is installed into the framework. Each archive receives a logger, a root directory, its associated bundle identifier, the associated bundle location string, and an input stream from which to read the bundle content. The root directory is where any required state can be stored. The input stream may be null, in which case the location is used as an URL to the bundle content.
logger
- the logger to be used by the archive.archiveRootDir
- the archive root directory for storing state.id
- the bundle identifier associated with the archive.location
- the bundle location string associated with the archive.is
- input stream from which to read the bundle content.
java.lang.Exception
- if any error occurs.public BundleArchive(Logger logger, java.io.File archiveRootDir) throws java.lang.Exception
This constructor is called when an archive for a bundle is being reconstructed when the framework is restarted. Each archive receives a logger, a root directory, and its associated bundle identifier. The root directory is where any required state can be stored.
logger
- the logger to be used by the archive.archiveRootDir
- the archive root directory for storing state.id
- the bundle identifier associated with the archive.
java.lang.Exception
- if any error occurs.Method Detail |
---|
public long getId() throws java.lang.Exception
Returns the bundle identifier associated with this archive.
java.lang.Exception
- if any error occurs.public java.lang.String getLocation() throws java.lang.Exception
Returns the location string associated with this archive.
java.lang.Exception
- if any error occurs.public int getPersistentState() throws java.lang.Exception
Returns the persistent state of this archive. The value returned is one of the following: Bundle.INSTALLED, Bundle.ACTIVE, or Bundle.UNINSTALLED.
java.lang.Exception
- if any error occurs.public void setPersistentState(int state) throws java.lang.Exception
Sets the persistent state of this archive. The value is one of the following: Bundle.INSTALLED, Bundle.ACTIVE, or Bundle.UNINSTALLED.
state
- the persistent state value to set for this archive.
java.lang.Exception
- if any error occurs.public int getStartLevel() throws java.lang.Exception
Returns the start level of this archive.
java.lang.Exception
- if any error occurs.public void setStartLevel(int level) throws java.lang.Exception
Sets the the start level of this archive this archive.
level
- the start level to set for this archive.
java.lang.Exception
- if any error occurs.public long getLastModified() throws java.lang.Exception
Returns the last modification time of this archive.
java.lang.Exception
- if any error occurs.public void setLastModified(long lastModified) throws java.lang.Exception
Sets the the last modification time of this archive.
lastModified
- The time of the last modification to set for
this archive. According to the OSGi specification this time is
set each time a bundle is installed, updated or uninstalled.
java.lang.Exception
- if any error occurs.public java.io.File getDataFile(java.lang.String fileName) throws java.lang.Exception
Returns a File object corresponding to the data file of the relative path of the specified string.
java.lang.Exception
- if any error occurs.public int getRevisionCount()
Returns the number of revisions available for this archive.
public BundleRevision getRevision(int i)
Returns the revision object for the specified revision.
public void revise(java.lang.String location, java.io.InputStream is) throws java.lang.Exception
This method adds a revision to the archive. The revision is created based on the specified location and/or input stream.
location
- the location string associated with the revision.
java.lang.Exception
- if any error occurs.public boolean rollbackRevise() throws java.lang.Exception
This method undoes the previous revision to the archive; this method will remove the latest revision from the archive. This method is only called when there are problems during an update after the revision has been created, such as errors in the update bundle's manifest. This method can only be called if there is more than one revision, otherwise there is nothing to undo.
java.lang.Exception
- if any error occurs.public void purge() throws java.lang.Exception
This method removes all old revisions associated with the archive and keeps only the current revision.
java.lang.Exception
- if any error occurs.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |