org.thales.punch.libraries.punchlang.operator

Class CidrMatchOperator

java.lang.Object

org.thales.punch.libraries.punchlang.operator.CidrMatchOperator

public class CidrMatchOperator
extends Object

The cidrmatch operator lets you check that an IP address (dotted number notation) matches a subnet. In its simplest form you can use it to only perform a check.

 if (cidrmatch("10.10.1.32/27").on("10.10.1.44").check()) {
  // "10.10.1.44" belongs to "10.10.1.32/27"
  ...
 }
 

You can use 'into' to store the check result in some tuple.

 cidrmatch("10.10.1.32/27").on("10.10.1.44").into([check]);
 

That will create a [check] field with value 'true'.

A cidrmatch operator can be created with a map of subnets instead of just one subnet. For example say you define a json resource file subnets.json containing:

 {
        "10.10.1.32/27" : "domain0",
        "11.10.1.32/27" : "domain1"
 }
 

cidrmatch(subnets).on("10.10.1.44").check()) will return true. Using into will give you back all the matched values. I.e cidrmatch(subnets).on("10.10.1.44").into([matches])); produces

 { "matches" : ["domain0"] }
 

The cidrmatch operator is not efficient, if you have many entries and need to find matching subnets using an interval search, use the FindByIntervalOperator operator instead.

Constructor Summary

Constructors

Constructor and Description
CidrMatchOperator(Map<org.apache.commons.net.util.SubnetUtils,String> map) Ctor.
CidrMatchOperator(org.apache.commons.net.util.SubnetUtils subnet) Ctor.
CidrMatchOperator(Tuple tupleMap) Ctor.

Method Summary

Modifier and Type	Method and Description
boolean	check() Final action, return true or false if the given IP matches the subnet.
CidrMatchOperator	firstMatch() Make the operator only match the first element.
boolean	into(Tuple tuple) Fire the operator and put the result into the provided tuple
CidrMatchOperator	on(String input) Make the operator ready to act on the provided String.
CidrMatchOperator	on(Tuple tuple) Make the operator ready to act on the provided tuple.
List<String>	run() Fire the operator.

Methods inherited from class java.lang.Object

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

Constructor Detail

CidrMatchOperator

public CidrMatchOperator(Tuple tupleMap)

Ctor.

Parameters:

tupleMap - the provided resource tuple.

CidrMatchOperator

public CidrMatchOperator(Map<org.apache.commons.net.util.SubnetUtils,String> map)

Ctor.

Parameters:

map - the provided resource map.

CidrMatchOperator

public CidrMatchOperator(org.apache.commons.net.util.SubnetUtils subnet)

Ctor.

Parameters:

subnet - an apache subnet utils.

Method Detail

on

public CidrMatchOperator on(Tuple tuple)

Make the operator ready to act on the provided tuple. That tuple must contain a string value.

Parameters:

tuple - the input tuple

Returns:

this operator.

on

public CidrMatchOperator on(String input)

Make the operator ready to act on the provided String.

Parameters:

input - the input string

Returns:

this operator.

run

public List<String> run()

Fire the operator. This method is public only for test visibility

Returns:

the list

into

public boolean into(Tuple tuple)

Fire the operator and put the result into the provided tuple

Parameters:

tuple - the output tuple

Returns:

true if there are some matches.

check

public boolean check()

Final action, return true or false if the given IP matches the subnet.

This can be used only for a cidrmatch operator working on a single subnet.

Returns:

true or false

firstMatch

public CidrMatchOperator firstMatch()

Make the operator only match the first element.

Returns:

this operator