org.onosproject.common.app

Class ApplicationArchive

java.lang.Object

org.onosproject.store.AbstractStore<org.onosproject.app.ApplicationEvent,org.onosproject.app.ApplicationStoreDelegate>

org.onosproject.common.app.ApplicationArchive

All Implemented Interfaces:

org.onosproject.store.Store<org.onosproject.app.ApplicationEvent,org.onosproject.app.ApplicationStoreDelegate>

public class ApplicationArchive
extends org.onosproject.store.AbstractStore<org.onosproject.app.ApplicationEvent,org.onosproject.app.ApplicationStoreDelegate>

Facility for reading application archive stream and managing application directory structure.

Field Summary

Fields inherited from class org.onosproject.store.AbstractStore

delegate

Constructor Summary

Constructors

Constructor and Description
ApplicationArchive()

Method Summary

Modifier and Type	Method and Description
protected boolean	clearActive(java.lang.String appName) Clears the app as active by deleting token file in the app directory.
org.onosproject.app.ApplicationDescription	getApplicationDescription(java.lang.String appName) Loads the application descriptor from the specified application archive stream and saves the stream in the appropriate application archive directory.
java.io.InputStream	getApplicationInputStream(java.lang.String appName) Returns application archive stream for the specified application.
java.util.Set<java.lang.String>	getApplicationNames() Returns the set of installed application names.
org.onosproject.core.ApplicationRole	getRole(java.lang.String value)
java.lang.String	getRootPath() Returns the root directory where apps directory is contained.
long	getUpdateTime(java.lang.String appName) Returns the timestamp in millis since start of epoch, of when the specified application was last modified or changed state.
protected boolean	isActive(java.lang.String appName) Indicates whether the app was marked as active by checking for token file.
void	purgeApplication(java.lang.String appName) Purges the application archive directory.
org.onosproject.app.ApplicationDescription	saveApplication(java.io.InputStream stream) Loads the application descriptor from the specified application archive stream and saves the stream in the appropriate application archive directory.
protected boolean	setActive(java.lang.String appName) Marks the app as active by creating token file in the app directory.
protected void	setRootPath(java.lang.String root) Sets the root directory where apps directory is contained.
protected boolean	updateTime(java.lang.String appName) Updates the time-stamp of the app descriptor file.

Methods inherited from class org.onosproject.store.AbstractStore

hasDelegate, notifyDelegate, notifyDelegate, setDelegate, unsetDelegate

Methods inherited from class java.lang.Object

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

Constructor Detail

ApplicationArchive

public ApplicationArchive()

Method Detail

setRootPath

protected void setRootPath(java.lang.String root)

Sets the root directory where apps directory is contained.

Parameters:

root - top-level directory path

getRootPath

public java.lang.String getRootPath()

Returns the root directory where apps directory is contained.

Returns:

top-level directory path

getApplicationNames

public java.util.Set<java.lang.String> getApplicationNames()

Returns the set of installed application names.

Returns:

installed application names

getUpdateTime

public long getUpdateTime(java.lang.String appName)

Returns the timestamp in millis since start of epoch, of when the specified application was last modified or changed state.

Parameters:

appName - application name

Returns:

number of millis since start of epoch

getApplicationDescription

public org.onosproject.app.ApplicationDescription getApplicationDescription(java.lang.String appName)

Loads the application descriptor from the specified application archive stream and saves the stream in the appropriate application archive directory.

Parameters:

appName - application name

Returns:

application descriptor

Throws:

org.onosproject.app.ApplicationException - if unable to read application description

saveApplication

public org.onosproject.app.ApplicationDescription saveApplication(java.io.InputStream stream)

Loads the application descriptor from the specified application archive stream and saves the stream in the appropriate application archive directory.

Parameters:

stream - application archive stream

Returns:

application descriptor

Throws:

org.onosproject.app.ApplicationException - if unable to read the archive stream or store the application archive

purgeApplication

public void purgeApplication(java.lang.String appName)

Purges the application archive directory.

Parameters:

appName - application name

getApplicationInputStream

public java.io.InputStream getApplicationInputStream(java.lang.String appName)

Returns application archive stream for the specified application. This will be either the application OAR file, JAR file or the plain XML file.

Parameters:

appName - application name

Returns:

application archive stream

setActive

protected boolean setActive(java.lang.String appName)

Marks the app as active by creating token file in the app directory.

Parameters:

appName - application name

Returns:

true if file was created

clearActive

protected boolean clearActive(java.lang.String appName)

Clears the app as active by deleting token file in the app directory.

Parameters:

appName - application name

Returns:

true if file was deleted

updateTime

protected boolean updateTime(java.lang.String appName)

Updates the time-stamp of the app descriptor file.

Parameters:

appName - application name

Returns:

true if the app descriptor was updated

isActive

protected boolean isActive(java.lang.String appName)

Indicates whether the app was marked as active by checking for token file.

Parameters:

appName - application name

Returns:

true if the app is marked as active

getRole

public org.onosproject.core.ApplicationRole getRole(java.lang.String value)