Package org.onosproject.app

Interface ApplicationAdminService

All Superinterfaces:

ApplicationService, ListenerService<ApplicationEvent,ApplicationListener>

public interface ApplicationAdminService
extends ApplicationService

Service for managing network control applications.

Method Summary

Modifier and Type	Method	Description
void	activate(ApplicationId appId)	Activates the specified application.
void	deactivate(ApplicationId appId)	Deactivates the specified application.
Application	install(java.io.InputStream appDescStream)	Installs the application contained in the specified application archive input stream.
void	setPermissions(ApplicationId appId, java.util.Set<Permission> permissions)	Updates the permissions granted to the applications.
void	uninstall(ApplicationId appId)	Uninstalls the specified application.

Methods inherited from interface org.onosproject.app.ApplicationService

getApplication, getApplicationArchive, getApplications, getId, getPermissions, getRegisteredApplications, getState, registerDeactivateHook

Methods inherited from interface org.onosproject.event.ListenerService

addListener, removeListener

Method Detail

install

Application install(java.io.InputStream appDescStream)

Installs the application contained in the specified application archive input stream. This can be either a ZIP stream containing a compressed application archive or a plain XML stream containing just the app.xml application descriptor file.

Parameters:

appDescStream - application descriptor input stream

Returns:

installed application descriptor

Throws:

ApplicationException - if unable to read the app archive stream

uninstall

void uninstall(ApplicationId appId)

Uninstalls the specified application.

Parameters:

appId - application identifier

activate

void activate(ApplicationId appId)

Activates the specified application.

Parameters:

appId - application identifier

deactivate

void deactivate(ApplicationId appId)

Deactivates the specified application.

Parameters:

appId - application identifier

setPermissions

void setPermissions(ApplicationId appId,
                    java.util.Set<Permission> permissions)

Updates the permissions granted to the applications.

Parameters:

appId - application identifier

permissions - set of granted permissions