org.onosproject.store.app

Class DistributedApplicationStore

java.lang.Object

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

org.onosproject.common.app.ApplicationArchive

org.onosproject.store.app.DistributedApplicationStore

All Implemented Interfaces:

ApplicationStore, Store<ApplicationEvent,ApplicationStoreDelegate>

@Service
public class DistributedApplicationStore
extends ApplicationArchive
implements ApplicationStore

Manages inventory of applications in a distributed data store providing stronger consistency guarantees.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DistributedApplicationStore.InternalState

Field Summary

Fields

Modifier and Type	Field and Description
protected ClusterCommunicationService	clusterCommunicator
protected ClusterService	clusterService
protected ApplicationIdStore	idStore
protected StorageService	storageService
protected VersionService	versionService

Fields inherited from class org.onosproject.store.AbstractStore

delegate

Constructor Summary

Constructors

Constructor and Description
DistributedApplicationStore()

Method Summary

Modifier and Type	Method and Description
void	activate()
void	activate(ApplicationId appId) Mark the application as active.
Application	create(InputStream appDescStream) Creates the application from the specified application descriptor input stream.
void	deactivate()
void	deactivate(ApplicationId appId) Mark the application as deactivated.
Application	getApplication(ApplicationId appId) Returns the application with the supplied application identifier.
InputStream	getApplicationArchive(ApplicationId appId) Returns stream that contains the application OAR/JAR file contents.
Set<Application>	getApplications() Returns the set of all installed applications.
ApplicationId	getId(String name) Returns the registered id of the application with the given name.
Set<Permission>	getPermissions(ApplicationId appId) Returns the permissions granted to the applications.
ApplicationState	getState(ApplicationId appId) Returns the current application state.
void	remove(ApplicationId appId) Removes the specified application.
void	setDelegate(ApplicationStoreDelegate delegate) Sets the delegate on the store.
void	setPermissions(ApplicationId appId, Set<Permission> permissions) Updates the permissions granted to the applications.

Methods inherited from class org.onosproject.common.app.ApplicationArchive

clearActive, getApplicationDescription, getApplicationInputStream, getApplicationNames, getRole, getRootPath, getUpdateTime, isActive, purgeApplication, saveApplication, setActive, setRootPath, updateTime

Methods inherited from class org.onosproject.store.AbstractStore

hasDelegate, notifyDelegate, notifyDelegate, unsetDelegate

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.onosproject.store.Store

hasDelegate, unsetDelegate

Field Detail

clusterCommunicator

@Reference(cardinality=MANDATORY_UNARY)
protected ClusterCommunicationService clusterCommunicator

clusterService

@Reference(cardinality=MANDATORY_UNARY)
protected ClusterService clusterService

storageService

@Reference(cardinality=MANDATORY_UNARY)
protected StorageService storageService

idStore

@Reference(cardinality=MANDATORY_UNARY)
protected ApplicationIdStore idStore

versionService

@Reference(cardinality=MANDATORY_UNARY)
protected VersionService versionService

Constructor Detail

DistributedApplicationStore

public DistributedApplicationStore()

Method Detail

activate

@Activate
public void activate()

deactivate

@Deactivate
public void deactivate()

setDelegate

public void setDelegate(ApplicationStoreDelegate delegate)

Description copied from interface: Store

Sets the delegate on the store.

Specified by:

setDelegate in interface Store<ApplicationEvent,ApplicationStoreDelegate>

Overrides:

setDelegate in class AbstractStore<ApplicationEvent,ApplicationStoreDelegate>

Parameters:

delegate - new store delegate

getApplications

public Set<Application> getApplications()

Description copied from interface: ApplicationStore

Returns the set of all installed applications.

Specified by:

getApplications in interface ApplicationStore

Returns:

set of installed apps

getId

public ApplicationId getId(String name)

Description copied from interface: ApplicationStore

Returns the registered id of the application with the given name.

Specified by:

getId in interface ApplicationStore

Parameters:

name - application name

Returns:

registered application id

getApplication

public Application getApplication(ApplicationId appId)

Description copied from interface: ApplicationStore

Returns the application with the supplied application identifier.

Specified by:

getApplication in interface ApplicationStore

Parameters:

appId - application identifier

Returns:

application descriptor

getState

public ApplicationState getState(ApplicationId appId)

Description copied from interface: ApplicationStore

Returns the current application state.

Specified by:

getState in interface ApplicationStore

Parameters:

appId - application identifier

Returns:

application state

create

public Application create(InputStream appDescStream)

Description copied from interface: ApplicationStore

Creates the application from the specified application descriptor input stream.

Specified by:

create in interface ApplicationStore

Parameters:

appDescStream - application archive input stream

Returns:

application descriptor

remove

public void remove(ApplicationId appId)

Description copied from interface: ApplicationStore

Removes the specified application.

Specified by:

remove in interface ApplicationStore

Parameters:

appId - application identifier

activate

public void activate(ApplicationId appId)

Description copied from interface: ApplicationStore

Mark the application as active.

Specified by:

activate in interface ApplicationStore

Parameters:

appId - application identifier

deactivate

public void deactivate(ApplicationId appId)

Description copied from interface: ApplicationStore

Mark the application as deactivated.

Specified by:

deactivate in interface ApplicationStore

Parameters:

appId - application identifier

getPermissions

public Set<Permission> getPermissions(ApplicationId appId)

Description copied from interface: ApplicationStore

Returns the permissions granted to the applications.

Specified by:

getPermissions in interface ApplicationStore

Parameters:

appId - application identifier

Returns:

set of granted permissions

setPermissions

public void setPermissions(ApplicationId appId,
                           Set<Permission> permissions)

Description copied from interface: ApplicationStore

Updates the permissions granted to the applications.

Specified by:

setPermissions in interface ApplicationStore

Parameters:

appId - application identifier

permissions - set of granted permissions

getApplicationArchive

public InputStream getApplicationArchive(ApplicationId appId)

Description copied from interface: ApplicationStore

Returns stream that contains the application OAR/JAR file contents.

Specified by:

getApplicationArchive in interface ApplicationStore

Parameters:

appId - application identifier

Returns:

input stream containing the app OAR/JAR file