IP Intelligence services for 51Degrees Pipeline

fiftyone.ipintelligence.IPIntelligencePipelineBuilder Class Reference

Detailed Description

Builder used to create a Pipeline with a IP Intelligence engine.

Public Member Functions

 IPIntelligencePipelineBuilder ()
 Constructor.
 IPIntelligencePipelineBuilder (ILoggerFactory loggerFactory)
 Constructor.
 IPIntelligencePipelineBuilder (ILoggerFactory loggerFactory, HttpClient httpClient)
 Constructor.
 IPIntelligencePipelineBuilder (ILoggerFactory loggerFactory, HttpClient httpClient, DataUpdateService dataUpdateService)
 Constructor.
IPIntelligenceOnPremisePipelineBuilder useOnPremise (String datafile, boolean createTempDataCopy) throws Exception
 Use a 51Degrees on-premise IP Intelligence engine to perform IP Intelligence.
IPIntelligenceCloudPipelineBuilder useCloud (String resourceKey)
 Use the 51Degrees Cloud service to perform IP Intelligence.

Protected Attributes

final ILoggerFactory loggerFactory

Constructor & Destructor Documentation

◆ IPIntelligencePipelineBuilder() [1/3]

fiftyone.ipintelligence.IPIntelligencePipelineBuilder.IPIntelligencePipelineBuilder ( ILoggerFactory loggerFactory)

Constructor.

Parameters
loggerFactoryThe factory to use for creating loggers within the pipeline.

◆ IPIntelligencePipelineBuilder() [2/3]

fiftyone.ipintelligence.IPIntelligencePipelineBuilder.IPIntelligencePipelineBuilder ( ILoggerFactory loggerFactory,
HttpClient httpClient )

Constructor.

Parameters
loggerFactoryThe factory to use for creating loggers within the pipeline.
httpClientThe HTTP Client to use within the pipeline.

◆ IPIntelligencePipelineBuilder() [3/3]

fiftyone.ipintelligence.IPIntelligencePipelineBuilder.IPIntelligencePipelineBuilder ( ILoggerFactory loggerFactory,
HttpClient httpClient,
DataUpdateService dataUpdateService )

Constructor.

Parameters
loggerFactoryThe factory to use for creating loggers within the pipeline.
httpClientThe HTTP Client to use within the pipeline.
dataUpdateServiceThe DataUpdateService to use when checking for data updates.

Member Function Documentation

◆ useCloud()

IPIntelligenceCloudPipelineBuilder fiftyone.ipintelligence.IPIntelligencePipelineBuilder.useCloud ( String resourceKey)

Use the 51Degrees Cloud service to perform IP Intelligence.

Parameters
resourceKeyThe resource key to use when querying the Cloud service. Obtain one from https://configure.51degrees.com?utm_source=code&utm_medium=comment&utm_campaign=51degrees-java&utm_content=ip-intelligence-src-main-java-fiftyone-ipintelligence-ipintelligencepipelinebuilder.java&utm_term=usecloud
Returns
A builder that can be used to configure and build a pipeline that will use the Cloud IP Intelligence engine.

◆ useOnPremise()

IPIntelligenceOnPremisePipelineBuilder fiftyone.ipintelligence.IPIntelligencePipelineBuilder.useOnPremise ( String datafile,
boolean createTempDataCopy ) throws Exception

Use a 51Degrees on-premise IP Intelligence engine to perform IP Intelligence.

Parameters
datafileThe full path to the IP Intelligence data file.
createTempDataCopyIf true, the engine will create a temporary copy of the data file rather than using the data file directly.
Returns
A builder that can be used to configure and build a pipeline that will use the on-premise IP intelligence engine.
Exceptions
ExceptionThrown if a required parameter is null.