org.onosproject.acl

Interface AclStore

All Superinterfaces:

org.onosproject.store.Store

All Known Implementing Classes:

DistributedAclStore

public interface AclStore
extends org.onosproject.store.Store

Service interface exported by ACL distributed store.

Method Summary

Modifier and Type	Method and Description
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.
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 interface org.onosproject.store.Store

hasDelegate, setDelegate, unsetDelegate

Method Detail

getAclRules

List<AclRule> getAclRules()

Gets a list containing all ACL rules.

Returns:

a list containing all ACL rules

addAclRule

void addAclRule(AclRule rule)

Adds a new ACL rule.

Parameters:

rule - new ACL rule

getAclRule

AclRule getAclRule(RuleId ruleId)

Gets an existing ACL rule.

Parameters:

ruleId - ACL rule id

Returns:

ACL rule with the given id

removeAclRule

void removeAclRule(RuleId ruleId)

Removes an existing ACL rule by rule id.

Parameters:

ruleId - ACL rule id

clearAcl

void clearAcl()

Clears ACL and reset all.

getPriorityByDevice

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

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

Parameters:

deviceId - device id

Returns:

new ACL flow rule's priority in the given device

getFlowByRule

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

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

Parameters:

ruleId - ACL rule id

Returns:

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

addRuleToFlowMapping

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

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

Parameters:

ruleId - ACL rule id

flowRule - ACL flow rule

removeRuleToFlowMapping

void removeRuleToFlowMapping(RuleId ruleId)

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

Parameters:

ruleId - ACL rule id

getAllowingRuleByDenyingRule

List<RuleId> getAllowingRuleByDenyingRule(RuleId denyingRuleId)

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

Parameters:

denyingRuleId - denying ACL rule id

Returns:

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

addDenyToAllowMapping

void addDenyToAllowMapping(RuleId denyingRuleId,
                           RuleId allowingRuleId)

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

Parameters:

denyingRuleId - denying ACL rule id

allowingRuleId - allowing ACL rule id

removeDenyToAllowMapping

void removeDenyToAllowMapping(RuleId denyingRuleId)

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

Parameters:

denyingRuleId - denying ACL rule id

checkIfRuleWorksInDevice

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

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

Parameters:

ruleId - ACL rule id

deviceId - devide id

Returns:

true if the given ACL rule works in the given device

addRuleToDeviceMapping

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

Adds a new mapping from ACL rule to device.

Parameters:

ruleId - ACL rule id

deviceId - device id

removeRuleToDeviceMapping

void removeRuleToDeviceMapping(RuleId ruleId)

Removes an existing mapping from ACL rule to device.

Parameters:

ruleId - ACL rule id