org.onosproject.security.store

Class DistributedSecurityModeStore

java.lang.Object

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

org.onosproject.security.store.DistributedSecurityModeStore

All Implemented Interfaces:

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

@Service
public class DistributedSecurityModeStore
extends org.onosproject.store.AbstractStore<SecurityModeEvent,SecurityModeStoreDelegate>
implements SecurityModeStore

Manages application permissions granted/requested to applications. Uses both gossip-based and RAFT-based distributed data store.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.onosproject.app.ApplicationAdminService	applicationAdminService
protected org.onosproject.store.service.LogicalClockService	clockService
protected org.apache.karaf.features.FeaturesService	featuresService
protected org.onosproject.store.service.StorageService	storageService

Fields inherited from class org.onosproject.store.AbstractStore

delegate

Constructor Summary

Constructors

Constructor and Description
DistributedSecurityModeStore()

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.
void	activate()
void	deactivate()
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	setDelegate(SecurityModeStoreDelegate delegate)
void	unregisterApplication(org.onosproject.core.ApplicationId appId) Removes application info from the local bundle-application directories.
void	unsetDelegate(SecurityModeStoreDelegate delegate)

Methods inherited from class org.onosproject.store.AbstractStore

hasDelegate, notifyDelegate, notifyDelegate

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

Field Detail

storageService

@Reference(cardinality=MANDATORY_UNARY)
protected org.onosproject.store.service.StorageService storageService

clockService

@Reference(cardinality=MANDATORY_UNARY)
protected org.onosproject.store.service.LogicalClockService clockService

applicationAdminService

@Reference(cardinality=MANDATORY_UNARY)
protected org.onosproject.app.ApplicationAdminService applicationAdminService

featuresService

@Reference(cardinality=MANDATORY_UNARY)
protected org.apache.karaf.features.FeaturesService featuresService

Constructor Detail

DistributedSecurityModeStore

public DistributedSecurityModeStore()

Method Detail

activate

@Activate
public void activate()

deactivate

@Deactivate
public void deactivate()

getBundleLocations

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

Description copied from interface: SecurityModeStore

Returns bundle locations of specified application.

Specified by:

getBundleLocations in interface SecurityModeStore

Parameters:

appId - application identifier

Returns:

set of bundle location strings

getApplicationIds

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

Description copied from interface: SecurityModeStore

Returns application identifiers that are associated with given bundle location.

Specified by:

getApplicationIds in interface SecurityModeStore

Parameters:

location - OSGi bundle location

Returns:

set of application identifiers

getRequestedPermissions

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

Description copied from interface: SecurityModeStore

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

Specified by:

getRequestedPermissions in interface SecurityModeStore

Parameters:

appId - application identifier

Returns:

list of permissions

getGrantedPermissions

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

Description copied from interface: SecurityModeStore

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

Specified by:

getGrantedPermissions in interface SecurityModeStore

Parameters:

appId - application identifier

Returns:

array of permissionInfo

requestPermission

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

Description copied from interface: SecurityModeStore

Request permission that is required to run given application.

Specified by:

requestPermission in interface SecurityModeStore

Parameters:

appId - application identifier

permission - permission

isSecured

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

Description copied from interface: SecurityModeStore

Returns true if given application has been secured.

Specified by:

isSecured in interface SecurityModeStore

Parameters:

appId - application identifier

Returns:

true indicates secured

reviewPolicy

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

Description copied from interface: SecurityModeStore

Notifies SM-ONOS that operator has reviewed the policy.

Specified by:

reviewPolicy in interface SecurityModeStore

Parameters:

appId - application identifier

acceptPolicy

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

Description copied from interface: SecurityModeStore

Accept the current security policy of given application.

Specified by:

acceptPolicy in interface SecurityModeStore

Parameters:

appId - application identifier

permissionSet - array of PermissionInfo

registerApplication

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

Description copied from interface: SecurityModeStore

Updates the local bundle-application directories.

Specified by:

registerApplication in interface SecurityModeStore

Parameters:

appId - application identifier

Returns:

true if successfully registered.

unregisterApplication

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

Description copied from interface: SecurityModeStore

Removes application info from the local bundle-application directories.

Specified by:

unregisterApplication in interface SecurityModeStore

Parameters:

appId - application identifier

getState

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

Description copied from interface: SecurityModeStore

Returns state of the specified application.

Specified by:

getState in interface SecurityModeStore

Parameters:

appId - application identifier

Returns:

Security-Mode State of application

setDelegate

public void setDelegate(SecurityModeStoreDelegate delegate)

Specified by:

setDelegate in interface org.onosproject.store.Store<SecurityModeEvent,SecurityModeStoreDelegate>

Overrides:

setDelegate in class org.onosproject.store.AbstractStore<SecurityModeEvent,SecurityModeStoreDelegate>

unsetDelegate

public void unsetDelegate(SecurityModeStoreDelegate delegate)

Specified by:

unsetDelegate in interface org.onosproject.store.Store<SecurityModeEvent,SecurityModeStoreDelegate>

Overrides:

unsetDelegate in class org.onosproject.store.AbstractStore<SecurityModeEvent,SecurityModeStoreDelegate>