org.onosproject.acl.impl

Class DistributedAclStore

java.lang.Object

org.onosproject.store.AbstractStore

org.onosproject.acl.impl.DistributedAclStore

All Implemented Interfaces:

AclStore, org.onosproject.store.Store

@Service
public class DistributedAclStore
extends org.onosproject.store.AbstractStore
implements AclStore

Implementation of the ACL store service.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.onosproject.core.CoreService	coreService
protected org.onosproject.store.service.StorageService	storageService

Fields inherited from class org.onosproject.store.AbstractStore

delegate

Constructor Summary

Constructors

Constructor and Description
DistributedAclStore()

Method Summary

Modifier and Type	Method and Description
void	activate()
void	addAclRule(AclRule rule) Adds a new ACL rule.
void	addDenyToAllowMapping(RuleId denyingRuleId, RuleId allowingRuleId) Adds a new mapping from denying ACL rule to allowing ACL rule.
void	addRuleToDeviceMapping(RuleId ruleId, org.onosproject.net.DeviceId deviceId) Adds a new mapping from ACL rule to device.
void	addRuleToFlowMapping(RuleId ruleId, org.onosproject.net.flow.FlowRule flowRule) Adds a new mapping from ACL rule to ACL flow rule.
boolean	checkIfRuleWorksInDevice(RuleId ruleId, org.onosproject.net.DeviceId deviceId) Checks if an existing ACL rule already works in a given device.
void	clearAcl() Clears ACL and reset all.
void	deactive()
AclRule	getAclRule(RuleId ruleId) Gets an existing ACL rule.
List<AclRule>	getAclRules() Gets a list containing all ACL rules.
List<RuleId>	getAllowingRuleByDenyingRule(RuleId denyingRuleId) Gets a list containing all allowing ACL rules matching a given denying ACL rule.
Set<org.onosproject.net.flow.FlowRule>	getFlowByRule(RuleId ruleId) Gets a set containing all ACL flow rules belonging to a given ACL rule.
int	getPriorityByDevice(org.onosproject.net.DeviceId deviceId) Gets the current priority for new ACL flow rule by device id.
void	removeAclRule(RuleId ruleId) Removes an existing ACL rule by rule id.
void	removeDenyToAllowMapping(RuleId denyingRuleId) Removes an exsiting mapping from denying ACL rule to allowing ACL rule.
void	removeRuleToDeviceMapping(RuleId ruleId) Removes an existing mapping from ACL rule to device.
void	removeRuleToFlowMapping(RuleId ruleId) Removes an existing mapping from ACL rule to ACL flow rule.

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

Methods inherited from interface org.onosproject.store.Store

hasDelegate, setDelegate, unsetDelegate

Field Detail

storageService

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

coreService

@Reference(cardinality=MANDATORY_UNARY)
protected org.onosproject.core.CoreService coreService

Constructor Detail

DistributedAclStore

public DistributedAclStore()

Method Detail

activate

@Activate
public void activate()

deactive

@Deactivate
public void deactive()

getAclRules

public List<AclRule> getAclRules()

Description copied from interface: AclStore

Gets a list containing all ACL rules.

Specified by:

getAclRules in interface AclStore

Returns:

a list containing all ACL rules

addAclRule

public void addAclRule(AclRule rule)

Description copied from interface: AclStore

Adds a new ACL rule.

Specified by:

addAclRule in interface AclStore

Parameters:

rule - new ACL rule

getAclRule

public AclRule getAclRule(RuleId ruleId)

Description copied from interface: AclStore

Gets an existing ACL rule.

Specified by:

getAclRule in interface AclStore

Parameters:

ruleId - ACL rule id

Returns:

ACL rule with the given id

removeAclRule

public void removeAclRule(RuleId ruleId)

Description copied from interface: AclStore

Removes an existing ACL rule by rule id.

Specified by:

removeAclRule in interface AclStore

Parameters:

ruleId - ACL rule id

clearAcl

public void clearAcl()

Description copied from interface: AclStore

Clears ACL and reset all.

Specified by:

clearAcl in interface AclStore

getPriorityByDevice

public int getPriorityByDevice(org.onosproject.net.DeviceId deviceId)

Description copied from interface: AclStore

Gets the current priority for new ACL flow rule by device id.

Specified by:

getPriorityByDevice in interface AclStore

Parameters:

deviceId - device id

Returns:

new ACL flow rule's priority in the given device

getFlowByRule

public Set<org.onosproject.net.flow.FlowRule> getFlowByRule(RuleId ruleId)

Description copied from interface: AclStore

Gets a set containing all ACL flow rules belonging to a given ACL rule.

Specified by:

getFlowByRule in interface AclStore

Parameters:

ruleId - ACL rule id

Returns:

a set containing all ACL flow rules belonging to the given ACL rule

addRuleToFlowMapping

public void addRuleToFlowMapping(RuleId ruleId,
                                 org.onosproject.net.flow.FlowRule flowRule)

Description copied from interface: AclStore

Adds a new mapping from ACL rule to ACL flow rule.

Specified by:

addRuleToFlowMapping in interface AclStore

Parameters:

ruleId - ACL rule id

flowRule - ACL flow rule

removeRuleToFlowMapping

public void removeRuleToFlowMapping(RuleId ruleId)

Description copied from interface: AclStore

Removes an existing mapping from ACL rule to ACL flow rule.

Specified by:

removeRuleToFlowMapping in interface AclStore

Parameters:

ruleId - ACL rule id

getAllowingRuleByDenyingRule

public List<RuleId> getAllowingRuleByDenyingRule(RuleId denyingRuleId)

Description copied from interface: AclStore

Gets a list containing all allowing ACL rules matching a given denying ACL rule.

Specified by:

getAllowingRuleByDenyingRule in interface AclStore

Parameters:

denyingRuleId - denying ACL rule id

Returns:

a list containing all allowing ACL rules matching the given denying ACL rule

addDenyToAllowMapping

public void addDenyToAllowMapping(RuleId denyingRuleId,
                                  RuleId allowingRuleId)

Description copied from interface: AclStore

Adds a new mapping from denying ACL rule to allowing ACL rule.

Specified by:

addDenyToAllowMapping in interface AclStore

Parameters:

denyingRuleId - denying ACL rule id

allowingRuleId - allowing ACL rule id

removeDenyToAllowMapping

public void removeDenyToAllowMapping(RuleId denyingRuleId)

Description copied from interface: AclStore

Removes an exsiting mapping from denying ACL rule to allowing ACL rule.

Specified by:

removeDenyToAllowMapping in interface AclStore

Parameters:

denyingRuleId - denying ACL rule id

checkIfRuleWorksInDevice

public boolean checkIfRuleWorksInDevice(RuleId ruleId,
                                        org.onosproject.net.DeviceId deviceId)

Description copied from interface: AclStore

Checks if an existing ACL rule already works in a given device.

Specified by:

checkIfRuleWorksInDevice in interface AclStore

Parameters:

ruleId - ACL rule id

deviceId - devide id

Returns:

true if the given ACL rule works in the given device

addRuleToDeviceMapping

public void addRuleToDeviceMapping(RuleId ruleId,
                                   org.onosproject.net.DeviceId deviceId)

Description copied from interface: AclStore

Adds a new mapping from ACL rule to device.

Specified by:

addRuleToDeviceMapping in interface AclStore

Parameters:

ruleId - ACL rule id

deviceId - device id

removeRuleToDeviceMapping

public void removeRuleToDeviceMapping(RuleId ruleId)

Description copied from interface: AclStore

Removes an existing mapping from ACL rule to device.

Specified by:

removeRuleToDeviceMapping in interface AclStore

Parameters:

ruleId - ACL rule id