org.thales.punch.libraries.punchlang.operator

Class IpRangeOperator

java.lang.Object

org.thales.punch.libraries.punchlang.operator.FetchOperator<IpRangeOperator>

org.thales.punch.libraries.punchlang.operator.IpRangeOperator

All Implemented Interfaces:

IResourceBuilder

public class IpRangeOperator
extends FetchOperator<IpRangeOperator>
implements IResourceBuilder

Using the IpRangeOperator, you can perform efficient lookups to check if an IP address belongs to an IP range. The IpRangeOperator is an efficient and more powerful implementation of the CidrRangeOperator.

Here is a basic example. Say you have a CSV resource files containing the following :

 network;geo_point;cc;country_name
 1.0.0.0/24;-34.9281,138.5999;AU;Australia
 1.0.1.0/24;34.7725,113.7266;CN;China
 223.255.255.0/24;-33.494,143.2104;AU;Australia
 

The following example checks for the ""223.255.255.1" ip address.

  if (ipRange().ipv4().url("file:/etc/geoipv4.csv")
       // indicate which CSV field is the one containing the CIDR range
       .cidrField("network")
       // this is the ip you look for
      .on("223.255.255.1")
      .into([match]) {
        // there is a match. What you have in [match] is :
        // "match": {
        //   "geo_point": "-34.9281,138.5999",
        //   "cc": "AU",
        //   "country_name": "Australia",
        //  }
        //
  }
 

Remote Resources

The cidrRange operator has the same capabilities for fetching remote resource files than the FetchCsvOperator. That is, you can write:

 if (ipRange().ipv4().url("https://your.resource.server/cidrs.csv")
         ... .into([match]) {
         // handle the match ...
 }
 

You can add CRON expression to periodically re-fetch the remote resource file.

Cron Expression Examples

Check the FetchOperator class for examples.

Author:

dimi

Nested Class Summary

Nested classes/interfaces inherited from interface org.thales.punch.libraries.punchlang.api.IResourceBuilder

IResourceBuilder.CompactionType

Field Summary

Fields inherited from class org.thales.punch.libraries.punchlang.operator.FetchOperator

compactionType, hashKey, logger, lowerCaseKeys, requiredResource, runtimeContext, s3Bucket, s3endpoint, s3KeyPath, s3Object, s3SecretPath, silent, url, uuid

Constructor Summary

Constructors

Constructor and Description
IpRangeOperator(RuntimeContext r) Constructor.
IpRangeOperator(RuntimeContext r, String url) Deprecated.

Method Summary

Modifier and Type	Method and Description
IpRangeOperator	cidrField(String cidrField) Set the csv field to be used as the cidr range.
IpRangeOperator	columns(String... columns)
IResourceBuilder	getResourceBuilder() Implemented by subclasses to return the adequate resource builder.
boolean	into(Tuple result) Fire the operator and store the result in the provided tuple.
IpRangeOperator	ipv4() Make the operator work assuming ipv4 ip address format.
IpRangeOperator	ipv6()
IpRangeOperator	matchFields(String... cidrMatchFields) Set the csv field to be used as the cidr range.
IpRangeOperator	on(String ip) Set the input value you want to match.
IpRangeOperator	on(Tuple ip) Set the input ip value you want to match.
Tuple	onEnd() Callback that tells you the scan is done.
void	onStart() Callback to tell you you are about to receive new lines.
void	onStream(Reader reader) Callback for you to stream the remote resource file.

Methods inherited from class org.thales.punch.libraries.punchlang.operator.FetchOperator

bestEffort, compact, compactDirect, compactInPlace, getResource, hashKey, loadAtStartup, lowerCaseKeys, refresh, required, s3AccessKey, s3AccessKeyPath, s3Bucket, s3Endpoint, s3Object, s3Secret, silent, url

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.thales.punch.libraries.punchlang.api.IResourceBuilder

prepare

Constructor Detail

IpRangeOperator

public IpRangeOperator(RuntimeContext r)

Constructor.

Parameters:

r - the punchlet runtime context

IpRangeOperator

@Deprecated
public IpRangeOperator(RuntimeContext r,
                                   String url)

Deprecated.

Parameters:

r -

url -

Method Detail

cidrField

public IpRangeOperator cidrField(String cidrField)

Set the csv field to be used as the cidr range.

Parameters:

cidrField - the cidr field name.

Returns:

this operator

matchFields

public IpRangeOperator matchFields(String... cidrMatchFields)

Set the csv field to be used as the cidr range.

Parameters:

cidrMatchFields - the matched field names.

Returns:

this operator

on

public IpRangeOperator on(String ip)

Set the input value you want to match.

Parameters:

ip - the ip input value as a String

Returns:

this operator

on

public IpRangeOperator on(Tuple ip)

Set the input ip value you want to match.

Parameters:

ip - the ip as a Tuple. This only works if the tuple contains a String leaf value.

Returns:

this operator

into

public boolean into(Tuple result)

Fire the operator and store the result in the provided tuple.

Parameters:

result -

Returns:

columns

public IpRangeOperator columns(String... columns)

ipv4

public IpRangeOperator ipv4()

Make the operator work assuming ipv4 ip address format.

This is the defult mode.

Returns:

this operator

ipv6

public IpRangeOperator ipv6()

onStart

public void onStart()

Description copied from interface: IResourceBuilder

Callback to tell you you are about to receive new lines.

Specified by:

onStart in interface IResourceBuilder

onStream

public void onStream(Reader reader)
              throws IOException

Description copied from interface: IResourceBuilder

Callback for you to stream the remote resource file.

Specified by:

onStream in interface IResourceBuilder

Parameters:

reader - the input stream to consume the resource file

Throws:

IOException - in case of IO error

onEnd

public Tuple onEnd()

Description copied from interface: IResourceBuilder

Callback that tells you the scan is done. You can safely terminate and return the building of your resource.

You should typically free any temporary storage, if any, used to build your resource.

Specified by:

onEnd in interface IResourceBuilder

Returns:

the built resource.

getResourceBuilder

public IResourceBuilder getResourceBuilder()

Description copied from class: FetchOperator

Implemented by subclasses to return the adequate resource builder. For example the FetchCsvOperator returns a builder to construct a tuple from a CSV document while the FetchJsonOperator returns builders to deal with JSON files.

This is called only once at init time.

Specified by:

getResourceBuilder in class FetchOperator<IpRangeOperator>

Returns:

the target resource builder