IP Intelligence services for 51Degrees Pipeline

fiftyone.ipintelligence.shared.testhelpers.FileUtils Class Reference

Static Public Member Functions

static String getHashFileName ()
 Helper to find the location of an Enterprise or Lite IPI file in the default search scope.
static File getHashFile ()
 Helper to find the location of an Enterprise or Lite IPI file in the default search scope.
static File getEvidenceFile ()
static File jarFileHelper (String file)
 Search the classpath for a resource.

Static Public Attributes

static final String IPI_PATH_VARIABLE = "_51DEGREES_IPI_PATH"
 Name of the aligned environment variable or system property which can supply an explicit path to the IPI data file.
static final String IPI_PATH_ENV_VAR = "51DEGREES_IPI_PATH"
 The old name of IPI_PATH_VARIABLE, read only when that one is not set.
static final String ENTERPRISE_IPI_DATA_FILE_NAME = "Enterprise-IpIntelligenceV41.ipi"
static final String ENTERPRISE_IPI_V41_DATA_FILE_NAME = "51Degrees-EnterpriseIpiV41.ipi"
static final String LITE_IPI_DATA_FILE_NAME = "51Degrees-LiteV41.ipi"
static final String IP_ADDRESSES_FILE_NAME = "evidence.csv"
static final String EVIDENCE_FILE_NAME = "evidence.yml"
static String TEMP_FILE_PREFIX = "IPITempFile"
 Prefix for temp files that are created by jarFileHelper(String).

Member Function Documentation

◆ getHashFile()

File fiftyone.ipintelligence.shared.testhelpers.FileUtils.getHashFile ( )
static

Helper to find the location of an Enterprise or Lite IPI file in the default search scope.

Returns
a file or empty if not found

◆ getHashFileName()

String fiftyone.ipintelligence.shared.testhelpers.FileUtils.getHashFileName ( )
static

Helper to find the location of an Enterprise or Lite IPI file in the default search scope.

Returns
a file or null if not found

◆ jarFileHelper()

File fiftyone.ipintelligence.shared.testhelpers.FileUtils.jarFileHelper ( String file)
static

Search the classpath for a resource.

If it doesn't exist throw an exception. If the file is in a jar then copy it to a temp file, so it can be used as an actual file.

Callers might wish to delete the temp file created when one is created and can assess whether this is the case as the name of the filename created will start with TEMP_FILE_PREFIX which they can alter to suit their needs.

Files created here have the property deleteOnExit;

Parameters
filea filename
Returns
a File representing the resource

Member Data Documentation

◆ IPI_PATH_ENV_VAR

final String fiftyone.ipintelligence.shared.testhelpers.FileUtils.IPI_PATH_ENV_VAR = "51DEGREES_IPI_PATH"
static

The old name of IPI_PATH_VARIABLE, read only when that one is not set.

Deprecated
use IPI_PATH_VARIABLE, and set the variable it names in place of this one.

◆ IPI_PATH_VARIABLE

final String fiftyone.ipintelligence.shared.testhelpers.FileUtils.IPI_PATH_VARIABLE = "_51DEGREES_IPI_PATH"
static

Name of the aligned environment variable or system property which can supply an explicit path to the IPI data file.

When set and the file exists it is used in preference to searching the project space.