org.opendaylight.netvirt.aclservice.utils

Class AclServiceUtils

java.lang.Object

org.opendaylight.netvirt.aclservice.utils.AclServiceUtils

@Singleton
public final class AclServiceUtils
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static AclserviceConfig.DefaultBehavior	DEFAULT_ALLOW
static AclserviceConfig.DefaultBehavior	DEFAULT_DENY

Constructor Summary

Constructors

Constructor and Description
AclServiceUtils(org.opendaylight.controller.md.sal.binding.api.DataBroker dataBroker, AclDataUtil aclDataUtil, AclserviceConfig config, org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.IdManagerService idManager, org.opendaylight.infrautils.jobcoordinator.JobCoordinator jobCoordinator)

Method Summary

Modifier and Type	Method and Description
static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<AclPortsByIp>	aclPortsByIpPath(String aclName)
void	addAclPortsLookup(AclInterface port, List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid> aclList, List<AllowedAddressPairs> allowedAddresses)
void	addAclPortsLookupForInterfaceUpdate(AclInterface portBefore, AclInterface portAfter)
static void	addLportTagMetadataMatch(int lportTag, List<org.opendaylight.genius.mdsalutil.MatchInfoBase> flowMatches, Class<? extends org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.ServiceModeBase> serviceMode)
Integer	allocateAclTag(String aclName) Allocate ACL tag.
static Integer	allocateId(org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.IdManagerService idManager, String poolName, String idKey, Integer defaultId)
static org.opendaylight.genius.mdsalutil.MatchInfoBase	buildAclConntrackClassifierTypeMatch(AclConntrackClassifierType conntrackSupportedType)
static List<org.opendaylight.genius.mdsalutil.MatchInfoBase>	buildArpIpMatches(IpPrefixOrAddress ipPrefixOrAddress) Builds the arp ip matches.
static List<org.opendaylight.genius.mdsalutil.MatchInfoBase>	buildBroadcastIpV4Matches(String ipAddr)
static List<org.opendaylight.genius.mdsalutil.MatchInfoBase>	buildDhcpMatches(int srcPort, int dstPort, int lportTag, Class<? extends org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.ServiceModeBase> serviceMode) Returns the DHCP match.
static List<org.opendaylight.genius.mdsalutil.MatchInfoBase>	buildDhcpV6Matches(int srcPort, int dstPort, int lportTag, Class<? extends org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.ServiceModeBase> serviceMode) Returns the DHCPv6 match.
static List<org.opendaylight.genius.mdsalutil.MatchInfoBase>	buildIcmpV6Matches(int icmpType, int icmpCode, int lportTag, Class<? extends org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.ServiceModeBase> serviceMode) Returns the ICMPv6 match.
static List<? extends org.opendaylight.genius.mdsalutil.MatchInfoBase>	buildIpAndDstServiceMatch(Integer aclTag, AllowedAddressPairs aap)
static List<? extends org.opendaylight.genius.mdsalutil.MatchInfoBase>	buildIpAndSrcServiceMatch(Integer aclTag, AllowedAddressPairs aap)
static List<org.opendaylight.genius.mdsalutil.MatchInfoBase>	buildIpMatches(IpPrefixOrAddress ipPrefixOrAddress, AclServiceManager.MatchCriteria matchCriteria) Builds the ip matches.
static List<org.opendaylight.genius.mdsalutil.MatchInfoBase>	buildIpProtocolMatches(org.opendaylight.genius.mdsalutil.matches.MatchEthernetType etherType, org.opendaylight.genius.mdsalutil.packet.IPProtocols protocol) Builds the ip protocol matches.
static List<org.opendaylight.genius.mdsalutil.MatchInfoBase>	buildL2BroadcastMatches()
static org.opendaylight.genius.mdsalutil.MatchInfoBase	buildLPortTagMatch(int lportTag, Class<? extends org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.ServiceModeBase> serviceMode) Gets the lport tag match.
static Collection<? extends org.opendaylight.genius.mdsalutil.MatchInfoBase>	buildMatchesForLPortTagAndConntrackClassifierType(int lportTag, AclConntrackClassifierType conntrackClassifierType, Class<? extends org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.ServiceModeBase> serviceMode)
static List<org.opendaylight.genius.mdsalutil.MatchInfoBase>	buildMatchesForLPortTagAndRemoteAclTag(Integer lportTag, Integer remoteAclTag, Class<? extends org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.ServiceModeBase> serviceMode)
static org.opendaylight.genius.mdsalutil.MatchInfoBase	buildRemoteAclTagMetadataMatch(Integer remoteAclTag)
static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.service.bindings.services.info.BoundServices>	buildServiceId(String interfaceName, short serviceIndex, Class<? extends org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.ServiceModeBase> serviceMode) Builds the service id.
static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface>	buildStateInterfaceId(String interfaceName) Build the interface state.
static boolean	containsMatchFieldType(List<org.opendaylight.genius.mdsalutil.MatchInfoBase> flows, Class<? extends org.opendaylight.genius.mdsalutil.NxMatchInfo> type)
static boolean	containsTcpMatchField(List<org.opendaylight.genius.mdsalutil.MatchInfoBase> flows)
static boolean	containsUdpMatchField(List<org.opendaylight.genius.mdsalutil.MatchInfoBase> flows)
static List<org.opendaylight.genius.mdsalutil.InstructionInfo>	createCtMarkInstructionForNewState(Short filterTable, Long elanId) This method creates and returns the ct_mark instruction when a ACL rule removed from the instance.
void	createRemoteAclIdPool() Creates remote the acl id pools.
void	deleteAcesFromConfigDS(String aclName, List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160218.access.lists.acl.access.list.entries.Ace> deletedAceRules)
void	deleteAclPortsLookup(AclInterface port, List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid> aclList, List<AllowedAddressPairs> allowedAddresses)
void	deleteAclPortsLookupForInterfaceUpdate(AclInterface portBefore, AclInterface portAfter)
void	deleteIdPool(String poolName) Delete id pool.
void	deleteRemoteAclIdPool() Delete remote the acl id pools.
void	deleteSubnetInfo(String portId)
static boolean	doesAceHaveRemoteGroupId(SecurityRuleAttr aceAttr) Does ACE have remote group id.
static boolean	doesIpv4AddressExists(List<AllowedAddressPairs> aaps) Does IPv4 address exists in the list of allowed address pair.
static boolean	doesIpv6AddressExists(List<AllowedAddressPairs> aaps) Does IPv6 address exists in the list of allowed address pair.
static List<AllowedAddressPairs>	excludeMulticastAAPs(List<AllowedAddressPairs> allowedAddresses)
static SecurityRuleAttr	getAccesssListAttributes(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160218.access.lists.acl.access.list.entries.Ace ace) Retrieves the security rule attribute augmentation from the access list.
Integer	getAceFlowPriority(String aclName) Gets the ace flow priority.
static org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160218.access.lists.Acl	getAcl(org.opendaylight.controller.md.sal.binding.api.DataBroker broker, String aclKey) Retrieves the acl matching the key from the data store.
static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160218.access.lists.Acl>	getAclInstanceIdentifier(String aclKey) Creates the Acl instance identifier.
static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<AclIpPrefixes>	getAclIpPrefixesPath(String aclName, IpPrefixOrAddress ipPrefix)
static String	getAclKeyForSynchronization(String key) Returns ACL specific key for synchronization.
Integer	getAclTag(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid aclId) Gets the ACL tag from cache.
static org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.service.bindings.services.info.BoundServices	getBoundServices(String serviceName, short servicePriority, int flowPriority, BigInteger cookie, List<org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.list.Instruction> instructions) Gets the bound services.
static String	getBroadcastAddressFromCidr(String cidr)
AclserviceConfig	getConfig()
static BigInteger	getDpIdFromIterfaceState(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface interfaceState)
static BigInteger	getDpnForInterface(org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rpcs.rev160406.OdlInterfaceRpcService interfaceManagerRpcService, String ifName) Get the data path number for the interface.
static BigInteger	getDropFlowCookie(int lport)
static Long	getElanIdFromInterface(String elanInterfaceName, org.opendaylight.controller.md.sal.binding.api.DataBroker broker)
static ElanInstance	getElanInstanceByName(String elanInstanceName, org.opendaylight.controller.md.sal.binding.api.DataBroker broker)
static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<ElanInstance>	getElanInstanceConfigurationDataPath(String elanInstanceName)
static ElanInterface	getElanInterfaceByElanInterfaceName(String elanInterfaceName, org.opendaylight.controller.md.sal.binding.api.DataBroker broker)
static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<ElanInterface>	getElanInterfaceConfigurationDataPathId(String interfaceName)
static Map<String,List<org.opendaylight.genius.mdsalutil.MatchInfoBase>>	getFlowForAllowedAddresses(List<AllowedAddressPairs> syncAllowedAddresses, Map<String,List<org.opendaylight.genius.mdsalutil.MatchInfoBase>> flowMatchesMap, boolean isSourceIpMacMatch)
static Integer	getHardTimoutForApplyStatefulChangeOnExistingTraffic(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160218.access.lists.acl.access.list.entries.Ace ace, AclServiceUtils aclServiceUtils) Returns the hard timeout based on the protocol when a ACL rule removed from the instance.
static com.google.common.base.Optional<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface>	getInterface(org.opendaylight.controller.md.sal.binding.api.DataBroker broker, String interfaceName) Retrieves the Interface from the datastore.
static List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid>	getInterfaceAcls(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface port) Checks whether port security is enabled for the port.
static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface>	getInterfaceIdentifier(String interfaceName) Builds the interface identifier.
static org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface	getInterfaceStateFromOperDS(org.opendaylight.controller.md.sal.binding.api.DataBroker dataBroker, String interfaceName) Retrieves the interface state.
static List<String>	getIpBroadcastAddresses(List<SubnetInfo> subnetInfoList)
static org.opendaylight.genius.mdsalutil.MatchInfoBase	getMatchInfoByType(List<org.opendaylight.genius.mdsalutil.MatchInfoBase> flows, Class<? extends org.opendaylight.genius.mdsalutil.NxMatchInfo> type)
static List<AllowedAddressPairs>	getPortAllowedAddresses(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface port)
static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<PortIds>	getPortIdsPathInAclPortsLookup(String ruleName, IpPrefixOrAddress ipPrefix, String portId)
static String	getRecoverServiceRegistryKey()
static Set<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid>	getRemoteAclIdsByDirection(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160218.access.lists.Acl acl, Class<? extends DirectionBase> direction)
Set<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid>	getRemoteAclIdsByDirection(List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid> aclIds, Class<? extends DirectionBase> direction)
static BigInteger	getRemoteAclTagMetadata(BigInteger remoteAclTag)
SortedSet<Integer>	getRemoteAclTags(List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid> aclIds, Class<? extends DirectionBase> direction)
static List<SubnetInfo>	getSubnetDiff(List<SubnetInfo> subnetInfo1, List<SubnetInfo> subnetInfo2) Gets the subnet difference by performing (subnetInfo1 - subnetInfo2).
List<SubnetInfo>	getSubnetInfo(String portId)
static List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid>	getUpdatedAclList(List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid> updatedAclList, List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid> currentAclList)
static List<AllowedAddressPairs>	getUpdatedAllowedAddressPairs(List<AllowedAddressPairs> updatedAllowedAddressPairs, List<AllowedAddressPairs> currentAllowedAddressPairs)
static org.opendaylight.genius.mdsalutil.instructions.InstructionWriteMetadata	getWriteMetadataForAclClassifierType(AclConntrackClassifierType conntrackClassifierType)
static org.opendaylight.genius.mdsalutil.instructions.InstructionWriteMetadata	getWriteMetadataForDropFlag()
static org.opendaylight.genius.mdsalutil.instructions.InstructionWriteMetadata	getWriteMetadataForRemoteAclTag(Integer remoteAclTag)
static boolean	isIPv4Address(AllowedAddressPairs aap)
static Boolean	isIpv6Subnet(List<SubnetInfo> subnetInfoList)
static boolean	isNotIpAllNetwork(AllowedAddressPairs aap)
static boolean	isNotIpv4AllNetwork(AllowedAddressPairs aap)
protected static boolean	isNotIpv6AllNetwork(AllowedAddressPairs aap)
static boolean	isOfAclInterest(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160218.access.lists.Acl acl)
static boolean	isOfInterest(AclInterface aclInterface) Indicates whether the interface has port security enabled.
static boolean	isPortSecurityEnabled(AclInterface port) Checks whether port security is enabled for the port.
static <T extends org.opendaylight.yangtools.yang.binding.DataObject> com.google.common.base.Optional<T>	read(org.opendaylight.controller.md.sal.binding.api.DataBroker broker, org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType datastoreType, org.opendaylight.yangtools.yang.binding.InstanceIdentifier<T> path) Retrieves the object from the datastore.
void	releaseAclTag(String aclName) Release ACL tag.
static void	releaseId(org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.IdManagerService idManager, String poolName, String idKey)
boolean	skipDeleteInCaseOfOverlappingIP(String portId, org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid remoteAclId, IpPrefixOrAddress ipPrefix, int addOrRemove) Skip delete in case of overlapping IP.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_DENY

public static final AclserviceConfig.DefaultBehavior DEFAULT_DENY

DEFAULT_ALLOW

public static final AclserviceConfig.DefaultBehavior DEFAULT_ALLOW

Constructor Detail

AclServiceUtils

@Inject
public AclServiceUtils(org.opendaylight.controller.md.sal.binding.api.DataBroker dataBroker,
                               AclDataUtil aclDataUtil,
                               AclserviceConfig config,
                               org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.IdManagerService idManager,
                               org.opendaylight.infrautils.jobcoordinator.JobCoordinator jobCoordinator)

Method Detail

getInterface

public static com.google.common.base.Optional<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface> getInterface(org.opendaylight.controller.md.sal.binding.api.DataBroker broker,
                                                                                                                                                                    String interfaceName)

Retrieves the Interface from the datastore.

Parameters:

broker - the data broker

interfaceName - the interface name

Returns:

the interface.

getInterfaceIdentifier

public static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface> getInterfaceIdentifier(String interfaceName)

Builds the interface identifier.

Parameters:

interfaceName - the interface name.

Returns:

the interface identifier.

read

public static <T extends org.opendaylight.yangtools.yang.binding.DataObject> com.google.common.base.Optional<T> read(org.opendaylight.controller.md.sal.binding.api.DataBroker broker,
                                                                                                                     org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType datastoreType,
                                                                                                                     org.opendaylight.yangtools.yang.binding.InstanceIdentifier<T> path)

Retrieves the object from the datastore.

Type Parameters:

T - type of DataObject

Parameters:

broker - the data broker.

datastoreType - the data store type.

path - the wild card path.

Returns:

the required object.

getAcl

public static org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160218.access.lists.Acl getAcl(org.opendaylight.controller.md.sal.binding.api.DataBroker broker,
                                                                                                                                  String aclKey)

Retrieves the acl matching the key from the data store.

Parameters:

broker - the data broker

aclKey - the acl key

Returns:

the acl

getAclInstanceIdentifier

public static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160218.access.lists.Acl> getAclInstanceIdentifier(String aclKey)

Creates the Acl instance identifier.

Parameters:

aclKey - the acl key

Returns:

the instance identifier

getDpnForInterface

public static BigInteger getDpnForInterface(org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rpcs.rev160406.OdlInterfaceRpcService interfaceManagerRpcService,
                                            String ifName)

Get the data path number for the interface.

Parameters:

interfaceManagerRpcService - interfaceManagerRpcService instance.

ifName - the interface name.

Returns:

the dpn.

getInterfaceStateFromOperDS

public static org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface getInterfaceStateFromOperDS(org.opendaylight.controller.md.sal.binding.api.DataBroker dataBroker,
                                                                                                                                                        String interfaceName)

Retrieves the interface state.

Parameters:

dataBroker - the data broker.

interfaceName - the interface name.

Returns:

the interface state.

buildStateInterfaceId

public static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface> buildStateInterfaceId(String interfaceName)

Build the interface state.

Parameters:

interfaceName - the interface name.

Returns:

the interface state.

isPortSecurityEnabled

public static boolean isPortSecurityEnabled(AclInterface port)

Checks whether port security is enabled for the port.

Parameters:

port - the port.

Returns:

the port security is enabled/not.

getInterfaceAcls

public static List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid> getInterfaceAcls(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface port)

Checks whether port security is enabled for the port.

Parameters:

port - the port.

Returns:

the list of security groups.

getAccesssListAttributes

public static SecurityRuleAttr getAccesssListAttributes(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160218.access.lists.acl.access.list.entries.Ace ace)

Retrieves the security rule attribute augmentation from the access list.

Parameters:

ace - the access list entry

Returns:

the security rule attributes

buildDhcpMatches

public static List<org.opendaylight.genius.mdsalutil.MatchInfoBase> buildDhcpMatches(int srcPort,
                                                                                     int dstPort,
                                                                                     int lportTag,
                                                                                     Class<? extends org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.ServiceModeBase> serviceMode)

Returns the DHCP match.

Parameters:

srcPort - the source port.

dstPort - the destination port.

lportTag - the lport tag

serviceMode - ingress or egress service

Returns:

list of matches.

buildDhcpV6Matches

public static List<org.opendaylight.genius.mdsalutil.MatchInfoBase> buildDhcpV6Matches(int srcPort,
                                                                                       int dstPort,
                                                                                       int lportTag,
                                                                                       Class<? extends org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.ServiceModeBase> serviceMode)

Returns the DHCPv6 match.

Parameters:

srcPort - the source port.

dstPort - the destination port.

lportTag - the lport tag

serviceMode - ingress or egress

Returns:

list of matches.

buildIcmpV6Matches

public static List<org.opendaylight.genius.mdsalutil.MatchInfoBase> buildIcmpV6Matches(int icmpType,
                                                                                       int icmpCode,
                                                                                       int lportTag,
                                                                                       Class<? extends org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.ServiceModeBase> serviceMode)

Returns the ICMPv6 match.

Parameters:

icmpType - the icmpv6-type.

icmpCode - the icmpv6-code.

lportTag - the lport tag

serviceMode - ingress or egress

Returns:

list of matches.

buildBroadcastIpV4Matches

public static List<org.opendaylight.genius.mdsalutil.MatchInfoBase> buildBroadcastIpV4Matches(String ipAddr)

buildL2BroadcastMatches

public static List<org.opendaylight.genius.mdsalutil.MatchInfoBase> buildL2BroadcastMatches()

buildServiceId

public static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.service.bindings.services.info.BoundServices> buildServiceId(String interfaceName,
                                                                                                                                                                                                                                     short serviceIndex,
                                                                                                                                                                                                                                     Class<? extends org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.ServiceModeBase> serviceMode)

Builds the service id.

Parameters:

interfaceName - the interface name

serviceIndex - the service index

serviceMode - the service mode

Returns:

the instance identifier

getBoundServices

public static org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.service.bindings.services.info.BoundServices getBoundServices(String serviceName,
                                                                                                                                                                           short servicePriority,
                                                                                                                                                                           int flowPriority,
                                                                                                                                                                           BigInteger cookie,
                                                                                                                                                                           List<org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.list.Instruction> instructions)

Gets the bound services.

Parameters:

serviceName - the service name

servicePriority - the service priority

flowPriority - the flow priority

cookie - the cookie

instructions - the instructions

Returns:

the bound services

getUpdatedAclList

public static List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid> getUpdatedAclList(List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid> updatedAclList,
                                                                                                                              List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid> currentAclList)

getUpdatedAllowedAddressPairs

public static List<AllowedAddressPairs> getUpdatedAllowedAddressPairs(List<AllowedAddressPairs> updatedAllowedAddressPairs,
                                                                      List<AllowedAddressPairs> currentAllowedAddressPairs)

getPortAllowedAddresses

public static List<AllowedAddressPairs> getPortAllowedAddresses(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface port)

getDpIdFromIterfaceState

public static BigInteger getDpIdFromIterfaceState(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface interfaceState)

getIpBroadcastAddresses

public static List<String> getIpBroadcastAddresses(List<SubnetInfo> subnetInfoList)

getBroadcastAddressFromCidr

public static String getBroadcastAddressFromCidr(String cidr)

buildIpMatches

public static List<org.opendaylight.genius.mdsalutil.MatchInfoBase> buildIpMatches(IpPrefixOrAddress ipPrefixOrAddress,
                                                                                   AclServiceManager.MatchCriteria matchCriteria)

Builds the ip matches.

Parameters:

ipPrefixOrAddress - the ip prefix or address

matchCriteria - the source_ip or destination_ip used for the match

Returns:

the list

buildArpIpMatches

public static List<org.opendaylight.genius.mdsalutil.MatchInfoBase> buildArpIpMatches(IpPrefixOrAddress ipPrefixOrAddress)

Builds the arp ip matches.

Parameters:

ipPrefixOrAddress - the ip prefix or address

Returns:

the MatchInfoBase list

buildRemoteAclTagMetadataMatch

public static org.opendaylight.genius.mdsalutil.MatchInfoBase buildRemoteAclTagMetadataMatch(Integer remoteAclTag)

getRemoteAclTagMetadata

public static BigInteger getRemoteAclTagMetadata(BigInteger remoteAclTag)

getDropFlowCookie

public static BigInteger getDropFlowCookie(int lport)

doesIpv4AddressExists

public static boolean doesIpv4AddressExists(List<AllowedAddressPairs> aaps)

Does IPv4 address exists in the list of allowed address pair.

Parameters:

aaps - the allowed address pairs

Returns:

true, if successful

doesIpv6AddressExists

public static boolean doesIpv6AddressExists(List<AllowedAddressPairs> aaps)

Does IPv6 address exists in the list of allowed address pair.

Parameters:

aaps - the allowed address pairs

Returns:

true, if successful

buildLPortTagMatch

public static org.opendaylight.genius.mdsalutil.MatchInfoBase buildLPortTagMatch(int lportTag,
                                                                                 Class<? extends org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.ServiceModeBase> serviceMode)

Gets the lport tag match. Ingress match is based on metadata and egress match is based on masked reg6

Parameters:

lportTag - the lport tag

serviceMode - ingress or egress service mode

Returns:

the lport tag match

buildMatchesForLPortTagAndRemoteAclTag

public static List<org.opendaylight.genius.mdsalutil.MatchInfoBase> buildMatchesForLPortTagAndRemoteAclTag(Integer lportTag,
                                                                                                           Integer remoteAclTag,
                                                                                                           Class<? extends org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.ServiceModeBase> serviceMode)

buildMatchesForLPortTagAndConntrackClassifierType

public static Collection<? extends org.opendaylight.genius.mdsalutil.MatchInfoBase> buildMatchesForLPortTagAndConntrackClassifierType(int lportTag,
                                                                                                                                      AclConntrackClassifierType conntrackClassifierType,
                                                                                                                                      Class<? extends org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.ServiceModeBase> serviceMode)

getWriteMetadataForAclClassifierType

public static org.opendaylight.genius.mdsalutil.instructions.InstructionWriteMetadata getWriteMetadataForAclClassifierType(AclConntrackClassifierType conntrackClassifierType)

getWriteMetadataForDropFlag

public static org.opendaylight.genius.mdsalutil.instructions.InstructionWriteMetadata getWriteMetadataForDropFlag()

getWriteMetadataForRemoteAclTag

public static org.opendaylight.genius.mdsalutil.instructions.InstructionWriteMetadata getWriteMetadataForRemoteAclTag(Integer remoteAclTag)

buildAclConntrackClassifierTypeMatch

public static org.opendaylight.genius.mdsalutil.MatchInfoBase buildAclConntrackClassifierTypeMatch(AclConntrackClassifierType conntrackSupportedType)

getConfig

public AclserviceConfig getConfig()

isIPv4Address

public static boolean isIPv4Address(AllowedAddressPairs aap)

getFlowForAllowedAddresses

public static Map<String,List<org.opendaylight.genius.mdsalutil.MatchInfoBase>> getFlowForAllowedAddresses(List<AllowedAddressPairs> syncAllowedAddresses,
                                                                                                           Map<String,List<org.opendaylight.genius.mdsalutil.MatchInfoBase>> flowMatchesMap,
                                                                                                           boolean isSourceIpMacMatch)

isNotIpv4AllNetwork

public static boolean isNotIpv4AllNetwork(AllowedAddressPairs aap)

isNotIpv6AllNetwork

protected static boolean isNotIpv6AllNetwork(AllowedAddressPairs aap)

isNotIpAllNetwork

public static boolean isNotIpAllNetwork(AllowedAddressPairs aap)

getElanIdFromInterface

public static Long getElanIdFromInterface(String elanInterfaceName,
                                          org.opendaylight.controller.md.sal.binding.api.DataBroker broker)

getElanInterfaceByElanInterfaceName

public static ElanInterface getElanInterfaceByElanInterfaceName(String elanInterfaceName,
                                                                org.opendaylight.controller.md.sal.binding.api.DataBroker broker)

getElanInterfaceConfigurationDataPathId

public static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<ElanInterface> getElanInterfaceConfigurationDataPathId(String interfaceName)

getElanInstanceByName

public static ElanInstance getElanInstanceByName(String elanInstanceName,
                                                 org.opendaylight.controller.md.sal.binding.api.DataBroker broker)

getElanInstanceConfigurationDataPath

public static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<ElanInstance> getElanInstanceConfigurationDataPath(String elanInstanceName)

getSubnetInfo

public List<SubnetInfo> getSubnetInfo(String portId)

deleteSubnetInfo

public void deleteSubnetInfo(String portId)

deleteAcesFromConfigDS

public void deleteAcesFromConfigDS(String aclName,
                                   List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160218.access.lists.acl.access.list.entries.Ace> deletedAceRules)

getMatchInfoByType

public static org.opendaylight.genius.mdsalutil.MatchInfoBase getMatchInfoByType(List<org.opendaylight.genius.mdsalutil.MatchInfoBase> flows,
                                                                                 Class<? extends org.opendaylight.genius.mdsalutil.NxMatchInfo> type)

containsMatchFieldType

public static boolean containsMatchFieldType(List<org.opendaylight.genius.mdsalutil.MatchInfoBase> flows,
                                             Class<? extends org.opendaylight.genius.mdsalutil.NxMatchInfo> type)

containsTcpMatchField

public static boolean containsTcpMatchField(List<org.opendaylight.genius.mdsalutil.MatchInfoBase> flows)

containsUdpMatchField

public static boolean containsUdpMatchField(List<org.opendaylight.genius.mdsalutil.MatchInfoBase> flows)

allocateId

public static Integer allocateId(org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.IdManagerService idManager,
                                 String poolName,
                                 String idKey,
                                 Integer defaultId)

releaseId

public static void releaseId(org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.IdManagerService idManager,
                             String poolName,
                             String idKey)

getAclTag

public Integer getAclTag(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid aclId)

Gets the ACL tag from cache. If not found in cache, tries to allocate and return the value.

Parameters:

aclId - the acl id

Returns:

the acl tag

allocateAclTag

public Integer allocateAclTag(String aclName)

Allocate ACL tag.

Parameters:

aclName - the ACL name

Returns:

the integer

releaseAclTag

public void releaseAclTag(String aclName)

Release ACL tag.

Parameters:

aclName - the ACL name

isOfInterest

public static boolean isOfInterest(AclInterface aclInterface)

Indicates whether the interface has port security enabled.

Parameters:

aclInterface - the interface.

Returns:

true if port is security enabled.

deleteIdPool

public void deleteIdPool(String poolName)

Delete id pool.

Parameters:

poolName - the pool name

createRemoteAclIdPool

public void createRemoteAclIdPool()

Creates remote the acl id pools.

deleteRemoteAclIdPool

public void deleteRemoteAclIdPool()

Delete remote the acl id pools.

buildIpAndSrcServiceMatch

public static List<? extends org.opendaylight.genius.mdsalutil.MatchInfoBase> buildIpAndSrcServiceMatch(Integer aclTag,
                                                                                                        AllowedAddressPairs aap)

buildIpAndDstServiceMatch

public static List<? extends org.opendaylight.genius.mdsalutil.MatchInfoBase> buildIpAndDstServiceMatch(Integer aclTag,
                                                                                                        AllowedAddressPairs aap)

isOfAclInterest

public static boolean isOfAclInterest(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160218.access.lists.Acl acl)

addLportTagMetadataMatch

public static void addLportTagMetadataMatch(int lportTag,
                                            List<org.opendaylight.genius.mdsalutil.MatchInfoBase> flowMatches,
                                            Class<? extends org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.ServiceModeBase> serviceMode)

getAclKeyForSynchronization

public static String getAclKeyForSynchronization(String key)

Returns ACL specific key for synchronization.

Parameters:

key - the generic key

Returns:

ACL key that can be used with synchronization

buildIpProtocolMatches

public static List<org.opendaylight.genius.mdsalutil.MatchInfoBase> buildIpProtocolMatches(org.opendaylight.genius.mdsalutil.matches.MatchEthernetType etherType,
                                                                                           org.opendaylight.genius.mdsalutil.packet.IPProtocols protocol)

Builds the ip protocol matches.

Parameters:

etherType - the ether type

protocol - the protocol

Returns:

the list of matches.

doesAceHaveRemoteGroupId

public static boolean doesAceHaveRemoteGroupId(SecurityRuleAttr aceAttr)

Does ACE have remote group id.

Parameters:

aceAttr - the ace attr

Returns:

true, if successful

getRemoteAclTags

public SortedSet<Integer> getRemoteAclTags(List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid> aclIds,
                                           Class<? extends DirectionBase> direction)

getRemoteAclIdsByDirection

public Set<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid> getRemoteAclIdsByDirection(List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid> aclIds,
                                                                                                                               Class<? extends DirectionBase> direction)

getRemoteAclIdsByDirection

public static Set<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid> getRemoteAclIdsByDirection(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160218.access.lists.Acl acl,
                                                                                                                                      Class<? extends DirectionBase> direction)

skipDeleteInCaseOfOverlappingIP

public boolean skipDeleteInCaseOfOverlappingIP(String portId,
                                               org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid remoteAclId,
                                               IpPrefixOrAddress ipPrefix,
                                               int addOrRemove)

Skip delete in case of overlapping IP.

When there are multiple ports (e.g., p1, p2, p3) having same AAP (e.g., 224.0.0.5) configured which are part of single SG, there would be single flow in remote ACL table. When one of these ports (say p1) is deleted, the single flow which is configured in remote ACL table shouldn't be deleted. It should be deleted only when there are no more references to it.

Parameters:

portId - the port id

remoteAclId - the remote Acl Id

ipPrefix - the ip prefix

addOrRemove - the add or remove

Returns:

true, if successful

aclPortsByIpPath

public static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<AclPortsByIp> aclPortsByIpPath(String aclName)

getAclIpPrefixesPath

public static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<AclIpPrefixes> getAclIpPrefixesPath(String aclName,
                                                                                                             IpPrefixOrAddress ipPrefix)

getPortIdsPathInAclPortsLookup

public static org.opendaylight.yangtools.yang.binding.InstanceIdentifier<PortIds> getPortIdsPathInAclPortsLookup(String ruleName,
                                                                                                                 IpPrefixOrAddress ipPrefix,
                                                                                                                 String portId)

addAclPortsLookupForInterfaceUpdate

public void addAclPortsLookupForInterfaceUpdate(AclInterface portBefore,
                                                AclInterface portAfter)

deleteAclPortsLookupForInterfaceUpdate

public void deleteAclPortsLookupForInterfaceUpdate(AclInterface portBefore,
                                                   AclInterface portAfter)

addAclPortsLookup

public void addAclPortsLookup(AclInterface port,
                              List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid> aclList,
                              List<AllowedAddressPairs> allowedAddresses)

deleteAclPortsLookup

public void deleteAclPortsLookup(AclInterface port,
                                 List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid> aclList,
                                 List<AllowedAddressPairs> allowedAddresses)

getAceFlowPriority

public Integer getAceFlowPriority(String aclName)

Gets the ace flow priority.

Parameters:

aclName - the acl name

Returns:

the ace flow priority

getHardTimoutForApplyStatefulChangeOnExistingTraffic

public static Integer getHardTimoutForApplyStatefulChangeOnExistingTraffic(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160218.access.lists.acl.access.list.entries.Ace ace,
                                                                           AclServiceUtils aclServiceUtils)

Returns the hard timeout based on the protocol when a ACL rule removed from the instance. It will returns the timeout configured in the AclserviceConfig class.

Parameters:

ace - the ace

aclServiceUtils - acl service utils

Returns:

the hard time out

createCtMarkInstructionForNewState

public static List<org.opendaylight.genius.mdsalutil.InstructionInfo> createCtMarkInstructionForNewState(Short filterTable,
                                                                                                         Long elanId)

This method creates and returns the ct_mark instruction when a ACL rule removed from the instance. This instruction will reset the ct_mark value and stops the existing traffics.

Parameters:

filterTable - the filterTable

elanId - the Elan id

Returns:

list of instruction

excludeMulticastAAPs

public static List<AllowedAddressPairs> excludeMulticastAAPs(List<AllowedAddressPairs> allowedAddresses)

getRecoverServiceRegistryKey

public static String getRecoverServiceRegistryKey()

isIpv6Subnet

public static Boolean isIpv6Subnet(List<SubnetInfo> subnetInfoList)

getSubnetDiff

public static List<SubnetInfo> getSubnetDiff(List<SubnetInfo> subnetInfo1,
                                             List<SubnetInfo> subnetInfo2)

Gets the subnet difference by performing (subnetInfo1 - subnetInfo2).

Parameters:

subnetInfo1 - the subnet info 1

subnetInfo2 - the subnet info 2

Returns:

the subnet diff