\r\n

51Degrees IP Intelligence Java  4.4

IP Intelligence services for 51Degrees Pipeline

fiftyone.ipintelligence.IPIntelligencePipelineBuilder Class Reference

Detailed Description

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

Collaboration diagram for fiftyone.ipintelligence.IPIntelligencePipelineBuilder:

[legend]

Public Member Functions

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

Protected Attributes

final ILoggerFactory  loggerFactory

Constructor & Destructor Documentation

◆ IPIntelligencePipelineBuilder() [1/3]

fiftyone.ipintelligence.IPIntelligencePipelineBuilder.IPIntelligencePipelineBuilder ( ILoggerFactory   loggerFactory )

Constructor.

Parameters
loggerFactory - The factory to use for creating loggers within the pipeline.

◆ IPIntelligencePipelineBuilder() [2/3]

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

Constructor.

Parameters
loggerFactory - The factory to use for creating loggers within the pipeline.
httpClient - The HTTP Client to use within the pipeline.

◆ IPIntelligencePipelineBuilder() [3/3]

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

Constructor.

Parameters
loggerFactory - The factory to use for creating loggers within the pipeline.
httpClient - The HTTP Client to use within the pipeline.
dataUpdateService - The 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
resourceKey - The resource key to use when querying the cloud service. Obtain one from https://configure.51degrees.com
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
datafile - The full path to the IP Intelligence data file.
createTempDataCopy - If 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 detection engine.
Exceptions
Exception - Thrown if a required parameter is null.