org.onosproject.security.store

Interface SecurityModeStore

All Superinterfaces:

org.onosproject.store.Store<SecurityModeEvent,SecurityModeStoreDelegate>

All Known Implementing Classes:

DistributedSecurityModeStore

public interface SecurityModeStore
extends org.onosproject.store.Store<SecurityModeEvent,SecurityModeStoreDelegate>

Security-Mode ONOS distributed store service.

Method Summary

Modifier and Type	Method and Description
void	acceptPolicy(org.onosproject.core.ApplicationId appId, Set<org.onosproject.security.Permission> permissionSet) Accept the current security policy of given application.
Set<org.onosproject.core.ApplicationId>	getApplicationIds(String location) Returns application identifiers that are associated with given bundle location.
Set<String>	getBundleLocations(org.onosproject.core.ApplicationId appId) Returns bundle locations of specified application.
Set<org.onosproject.security.Permission>	getGrantedPermissions(org.onosproject.core.ApplicationId appId) Returns an array of permissions that have been granted to given application.
Set<org.onosproject.security.Permission>	getRequestedPermissions(org.onosproject.core.ApplicationId appId) Returns a list of permissions that have been requested by given application.
SecurityModeState	getState(org.onosproject.core.ApplicationId appId) Returns state of the specified application.
boolean	isSecured(org.onosproject.core.ApplicationId appId) Returns true if given application has been secured.
boolean	registerApplication(org.onosproject.core.ApplicationId appId) Updates the local bundle-application directories.
void	requestPermission(org.onosproject.core.ApplicationId appId, org.onosproject.security.Permission permission) Request permission that is required to run given application.
void	reviewPolicy(org.onosproject.core.ApplicationId appId) Notifies SM-ONOS that operator has reviewed the policy.
void	unregisterApplication(org.onosproject.core.ApplicationId appId) Removes application info from the local bundle-application directories.

Methods inherited from interface org.onosproject.store.Store

hasDelegate, setDelegate, unsetDelegate

Method Detail

registerApplication

boolean registerApplication(org.onosproject.core.ApplicationId appId)

Updates the local bundle-application directories.

Parameters:

appId - application identifier

Returns:

true if successfully registered.

unregisterApplication

void unregisterApplication(org.onosproject.core.ApplicationId appId)

Removes application info from the local bundle-application directories.

Parameters:

appId - application identifier

getState

SecurityModeState getState(org.onosproject.core.ApplicationId appId)

Returns state of the specified application.

Parameters:

appId - application identifier

Returns:

Security-Mode State of application

getBundleLocations

Set<String> getBundleLocations(org.onosproject.core.ApplicationId appId)

Returns bundle locations of specified application.

Parameters:

appId - application identifier

Returns:

set of bundle location strings

getApplicationIds

Set<org.onosproject.core.ApplicationId> getApplicationIds(String location)

Returns application identifiers that are associated with given bundle location.

Parameters:

location - OSGi bundle location

Returns:

set of application identifiers

getRequestedPermissions

Set<org.onosproject.security.Permission> getRequestedPermissions(org.onosproject.core.ApplicationId appId)

Returns a list of permissions that have been requested by given application.

Parameters:

appId - application identifier

Returns:

list of permissions

getGrantedPermissions

Set<org.onosproject.security.Permission> getGrantedPermissions(org.onosproject.core.ApplicationId appId)

Returns an array of permissions that have been granted to given application.

Parameters:

appId - application identifier

Returns:

array of permissionInfo

requestPermission

void requestPermission(org.onosproject.core.ApplicationId appId,
                       org.onosproject.security.Permission permission)

Request permission that is required to run given application.

Parameters:

appId - application identifier

permission - permission

isSecured

boolean isSecured(org.onosproject.core.ApplicationId appId)

Returns true if given application has been secured.

Parameters:

appId - application identifier

Returns:

true indicates secured

reviewPolicy

void reviewPolicy(org.onosproject.core.ApplicationId appId)

Notifies SM-ONOS that operator has reviewed the policy.

Parameters:

appId - application identifier

acceptPolicy

void acceptPolicy(org.onosproject.core.ApplicationId appId,
                  Set<org.onosproject.security.Permission> permissionSet)

Accept the current security policy of given application.

Parameters:

appId - application identifier

permissionSet - array of PermissionInfo