org.opendaylight.netvirt.aclservice

Class AbstractAclServiceImpl

java.lang.Object

org.opendaylight.netvirt.aclservice.AbstractAclServiceImpl

All Implemented Interfaces:

AclServiceListener

Direct Known Subclasses:

AbstractEgressAclServiceImpl, AbstractIngressAclServiceImpl

public abstract class AbstractAclServiceImpl
extends Object
implements AclServiceListener

Field Summary

Fields

Modifier and Type	Field and Description
protected AclDataUtil	aclDataUtil
protected AclServiceUtils	aclServiceUtils
protected org.opendaylight.controller.md.sal.binding.api.DataBroker	dataBroker
protected org.opendaylight.genius.mdsalutil.interfaces.IMdsalApiManager	mdsalManager
protected Class<? extends org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.ServiceModeBase>	serviceMode

Constructor Summary

Constructors

Constructor and Description

AbstractAclServiceImpl(Class<? extends org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.ServiceModeBase> serviceMode, org.opendaylight.controller.md.sal.binding.api.DataBroker dataBroker, org.opendaylight.genius.mdsalutil.interfaces.IMdsalApiManager mdsalManager, AclDataUtil aclDataUtil, AclServiceUtils aclServiceUtils) Initialize the member variables.

Method Summary

Modifier and Type	Method and Description
boolean	applyAce(AclInterface port, String aclName, org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160218.access.lists.acl.access.list.entries.Ace ace)
boolean	applyAcl(AclInterface port)
boolean	bindAcl(AclInterface port)
abstract void	bindService(AclInterface aclInterface) Bind service.
protected Set<BigInteger>	collectDpns(Map<String,Set<AclInterface>> mapAclWithPortSet)
protected int	getAclFlowPriority(String poolName, String flowName, int addOrRemove) Gets the priority of acl flow which is to be either removed or added.
protected List<org.opendaylight.genius.mdsalutil.InstructionInfo>	getDispatcherTableResubmitInstructions(List<org.opendaylight.genius.mdsalutil.ActionInfo> actionsInfos) Gets the dispatcher table resubmit instructions based on ingress/egress service mode w.r.t switch.
protected char[]	getIpPrefixOrAddress(AllowedAddressPairs ip)
protected String	getOperAsString(int flowOper)
protected abstract void	programAceRule(AclInterface port, int addOrRemove, String aclName, org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160218.access.lists.acl.access.list.entries.Ace ace, List<AllowedAddressPairs> syncAllowedAddresses) Programs the ace custom rule.
protected abstract boolean	programAclRules(AclInterface port, List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid> aclUuidList, int addOrRemove) Programs the acl custom rules.
protected abstract void	programBroadcastRules(AclInterface port, int addOrRemove) Programs broadcast rules.
protected abstract void	programGeneralFixedRules(AclInterface port, String dhcpMacAddress, List<AllowedAddressPairs> allowedAddresses, AclServiceManager.Action action, int addOrRemove) Program the default anti-spoofing rules.
protected abstract void	programSpecificFixedRules(BigInteger dpid, String dhcpMacAddress, List<AllowedAddressPairs> allowedAddresses, int lportTag, String portId, AclServiceManager.Action action, int addOrRemove) Program the default specific rules.
boolean	rebindAcl(AclInterface portBefore, AclInterface portAfter)
boolean	removeAce(AclInterface port, String aclName, org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160218.access.lists.acl.access.list.entries.Ace ace)
boolean	removeAcl(AclInterface port)
protected void	syncFlow(BigInteger dpId, short tableId, String flowId, int priority, String flowName, int idleTimeOut, int hardTimeOut, BigInteger cookie, List<? extends org.opendaylight.genius.mdsalutil.MatchInfoBase> matches, List<org.opendaylight.genius.mdsalutil.InstructionInfo> instructions, int addOrRemove) Writes/remove the flow to/from the datastore.
boolean	unbindAcl(AclInterface port)
protected abstract void	unbindService(AclInterface aclInterface) Unbind service.
boolean	updateAcl(AclInterface portBefore, AclInterface portAfter)
protected abstract void	updateArpForAllowedAddressPairs(BigInteger dpId, int lportTag, List<AllowedAddressPairs> deletedAAP, List<AllowedAddressPairs> addedAAP) Update arp for allowed address pairs.
protected abstract void	updateRemoteAclTableForPort(AclInterface port, org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid acl, int addOrRemove, AllowedAddressPairs ip, BigInteger aclId, BigInteger dpId)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

mdsalManager

protected final org.opendaylight.genius.mdsalutil.interfaces.IMdsalApiManager mdsalManager

dataBroker

protected final org.opendaylight.controller.md.sal.binding.api.DataBroker dataBroker

serviceMode

protected final Class<? extends org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.ServiceModeBase> serviceMode

aclDataUtil

protected final AclDataUtil aclDataUtil

aclServiceUtils

protected final AclServiceUtils aclServiceUtils

Constructor Detail

AbstractAclServiceImpl

public AbstractAclServiceImpl(Class<? extends org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.ServiceModeBase> serviceMode,
                              org.opendaylight.controller.md.sal.binding.api.DataBroker dataBroker,
                              org.opendaylight.genius.mdsalutil.interfaces.IMdsalApiManager mdsalManager,
                              AclDataUtil aclDataUtil,
                              AclServiceUtils aclServiceUtils)

Initialize the member variables.

Parameters:

serviceMode - the service mode

dataBroker - the data broker instance.

mdsalManager - the mdsal manager instance.

aclDataUtil - the acl data util.

aclServiceUtils - the acl service util.

Method Detail

applyAcl

public boolean applyAcl(AclInterface port)

Specified by:

applyAcl in interface AclServiceListener

bindAcl

public boolean bindAcl(AclInterface port)

Specified by:

bindAcl in interface AclServiceListener

rebindAcl

public boolean rebindAcl(AclInterface portBefore,
                         AclInterface portAfter)

Specified by:

rebindAcl in interface AclServiceListener

unbindAcl

public boolean unbindAcl(AclInterface port)

Specified by:

unbindAcl in interface AclServiceListener

updateAcl

public boolean updateAcl(AclInterface portBefore,
                         AclInterface portAfter)

Specified by:

updateAcl in interface AclServiceListener

removeAcl

public boolean removeAcl(AclInterface port)

Specified by:

removeAcl in interface AclServiceListener

applyAce

public boolean applyAce(AclInterface port,
                        String aclName,
                        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160218.access.lists.acl.access.list.entries.Ace ace)

Specified by:

applyAce in interface AclServiceListener

removeAce

public boolean removeAce(AclInterface port,
                         String aclName,
                         org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160218.access.lists.acl.access.list.entries.Ace ace)

Specified by:

removeAce in interface AclServiceListener

bindService

public abstract void bindService(AclInterface aclInterface)

Bind service.

Parameters:

aclInterface - the acl interface

unbindService

protected abstract void unbindService(AclInterface aclInterface)

Unbind service.

Parameters:

aclInterface - the acl interface

programGeneralFixedRules

protected abstract void programGeneralFixedRules(AclInterface port,
                                                 String dhcpMacAddress,
                                                 List<AllowedAddressPairs> allowedAddresses,
                                                 AclServiceManager.Action action,
                                                 int addOrRemove)

Program the default anti-spoofing rules.

Parameters:

port - the acl interface

dhcpMacAddress - the dhcp mac address.

allowedAddresses - the allowed addresses

action - add/modify/remove action

addOrRemove - addorRemove

updateArpForAllowedAddressPairs

protected abstract void updateArpForAllowedAddressPairs(BigInteger dpId,
                                                        int lportTag,
                                                        List<AllowedAddressPairs> deletedAAP,
                                                        List<AllowedAddressPairs> addedAAP)

Update arp for allowed address pairs.

Parameters:

dpId - the dp id

lportTag - the lport tag

deletedAAP - the deleted allowed address pairs

addedAAP - the added allowed address pairs

programSpecificFixedRules

protected abstract void programSpecificFixedRules(BigInteger dpid,
                                                  String dhcpMacAddress,
                                                  List<AllowedAddressPairs> allowedAddresses,
                                                  int lportTag,
                                                  String portId,
                                                  AclServiceManager.Action action,
                                                  int addOrRemove)

Program the default specific rules.

Parameters:

dpid - the dpid

dhcpMacAddress - the dhcp mac address.

allowedAddresses - the allowed addresses

lportTag - the lport tag

portId - the port id

action - add/modify/remove action

addOrRemove - addorRemove

programAclRules

protected abstract boolean programAclRules(AclInterface port,
                                           List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid> aclUuidList,
                                           int addOrRemove)

Programs the acl custom rules.

Parameters:

port - acl interface

aclUuidList - the list of acl uuid to be applied

addOrRemove - whether to delete or add flow

Returns:

program succeeded

programAceRule

protected abstract void programAceRule(AclInterface port,
                                       int addOrRemove,
                                       String aclName,
                                       org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160218.access.lists.acl.access.list.entries.Ace ace,
                                       List<AllowedAddressPairs> syncAllowedAddresses)

Programs the ace custom rule.

Parameters:

port - acl interface

addOrRemove - whether to delete or add flow

aclName - the acl name

ace - rule to be program

syncAllowedAddresses - the allowed addresses

programBroadcastRules

protected abstract void programBroadcastRules(AclInterface port,
                                              int addOrRemove)

Programs broadcast rules.

Parameters:

port - the Acl Interface port

addOrRemove - whether to delete or add flow

syncFlow

protected void syncFlow(BigInteger dpId,
                        short tableId,
                        String flowId,
                        int priority,
                        String flowName,
                        int idleTimeOut,
                        int hardTimeOut,
                        BigInteger cookie,
                        List<? extends org.opendaylight.genius.mdsalutil.MatchInfoBase> matches,
                        List<org.opendaylight.genius.mdsalutil.InstructionInfo> instructions,
                        int addOrRemove)

Writes/remove the flow to/from the datastore.

Parameters:

dpId - the dpId

tableId - the tableId

flowId - the flowId

priority - the priority

flowName - the flow name

idleTimeOut - the idle timeout

hardTimeOut - the hard timeout

cookie - the cookie

matches - the list of matches to be writted

instructions - the list of instruction to be written.

addOrRemove - add or remove the entries.

getDispatcherTableResubmitInstructions

protected List<org.opendaylight.genius.mdsalutil.InstructionInfo> getDispatcherTableResubmitInstructions(List<org.opendaylight.genius.mdsalutil.ActionInfo> actionsInfos)

Gets the dispatcher table resubmit instructions based on ingress/egress service mode w.r.t switch.

Parameters:

actionsInfos - the actions infos

Returns:

the instructions for dispatcher table resubmit

updateRemoteAclTableForPort

protected abstract void updateRemoteAclTableForPort(AclInterface port,
                                                    org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid acl,
                                                    int addOrRemove,
                                                    AllowedAddressPairs ip,
                                                    BigInteger aclId,
                                                    BigInteger dpId)

getOperAsString

protected String getOperAsString(int flowOper)

collectDpns

protected Set<BigInteger> collectDpns(Map<String,Set<AclInterface>> mapAclWithPortSet)

getIpPrefixOrAddress

protected char[] getIpPrefixOrAddress(AllowedAddressPairs ip)

getAclFlowPriority

protected int getAclFlowPriority(String poolName,
                                 String flowName,
                                 int addOrRemove)

Gets the priority of acl flow which is to be either removed or added.

Parameters:

poolName - the acl pool name

flowName - the flow name

addOrRemove - add or remove the entries.

Returns:

the acl flow priority