\r\n

51Degrees IP Intelligence Java  4.4

IP Intelligence services for 51Degrees Pipeline

fiftyone.ipintelligence.IPIntelligenceOnPremisePipelineBuilder Class Reference

Detailed Description

Builder used to create pipelines with an on-premise IP Intelligence engine.

Inheritance diagram for fiftyone.ipintelligence.IPIntelligenceOnPremisePipelineBuilder:

[legend]

Collaboration diagram for fiftyone.ipintelligence.IPIntelligenceOnPremisePipelineBuilder:

[legend]

Public Member Functions

IPIntelligenceOnPremisePipelineBuilder  setShareUsage (boolean enabled)
Set share usage enabled/disabled. More...
IPIntelligenceOnPremisePipelineBuilder  setAutoUpdate (boolean enabled)
Enable/Disable auto update. More...
IPIntelligenceOnPremisePipelineBuilder  setDataFileSystemWatcher (boolean enabled)
The DataUpdateService has the ability to watch a file on disk and refresh the engine as soon as that file is updated. More...
IPIntelligenceOnPremisePipelineBuilder  setDataUpdateService (DataUpdateService dataUpdateService)
Automatic updates require a DataUpdateService. More...
IPIntelligenceOnPremisePipelineBuilder  setDataUpdateOnStartup (boolean enabled)
Enable/Disable update on startup. More...
IPIntelligenceOnPremisePipelineBuilder  setUpdatePollingInterval (int pollingIntervalSeconds)
Set the time between checks for a new data file made by the DataUpdateService in seconds. More...
IPIntelligenceOnPremisePipelineBuilder  setUpdatePollingIntervalMillis (long pollingIntervalMillis)
Set the time between checks for a new data file made by the DataUpdateService in milliseconds. More...
IPIntelligenceOnPremisePipelineBuilder  setUpdateRandomisationMax (int randomisationMaxSeconds)
A random element can be added to the DataUpdateService polling interval. More...
IPIntelligenceOnPremisePipelineBuilder  setUpdateRandomisationMaxMillis (long randomisationMaxMillis)
A random element can be added to the DataUpdateService polling interval. More...
IPIntelligenceOnPremisePipelineBuilder  setDataUpdateLicenseKey (String key)
Set the license key used when checking for new IP Intelligence data files. More...
IPIntelligenceOnPremisePipelineBuilder  setPerformanceProfile (Constants.PerformanceProfiles profile)
Set the performance profile for the IP Intelligence engine. More...
IPIntelligenceOnPremisePipelineBuilder  setConcurrency (int concurrency)
Set the expected number of concurrent operations using the engine. More...
IPIntelligenceOnPremisePipelineBuilder  setProperty (String property)
Add a property to the list of properties that the engine will populate in the response. More...
IPIntelligenceOnPremisePipelineBuilder  setDataUpdateUrl (String url)
Configure the engine to use the specified URL when looking for an updated data file. More...
IPIntelligenceOnPremisePipelineBuilder  setDataUpdateVerifyMd5 (Boolean verify)
Set a value indicating if the DataUpdateService should expect the response from the data update URL to contain a 'content-md5' HTTP header that can be used to verify the integrity of the content. More...
IPIntelligenceOnPremisePipelineBuilder  setDataUpdateUrlFormatter (DataUpdateUrlFormatter formatter)
Specify a DataUpdateUrlFormatter to be used by the DataUpdateService when building the complete URL to query for updated data. More...
Pipeline  build () throws Exception
Build and return a pipeline that can perform IP Intelligence. More...

Protected Attributes

boolean  shareUsageEnabled = true

Member Function Documentation

◆ build()

Pipeline fiftyone.ipintelligence.IPIntelligenceOnPremisePipelineBuilder.build ( ) throws Exception

Build and return a pipeline that can perform IP Intelligence.

Returns
the built pipeline
Exceptions
Exception - on error

◆ setAutoUpdate()

IPIntelligenceOnPremisePipelineBuilder fiftyone.ipintelligence.IPIntelligenceOnPremisePipelineBuilder.setAutoUpdate ( boolean   enabled )

Enable/Disable auto update.

Defaults to enabled. If enabled, the auto update system will automatically download and apply new data files for IP Intelligence.

Parameters
enabled - True to enable auto update. False to disable.
Returns
This builder instance.

◆ setConcurrency()

IPIntelligenceOnPremisePipelineBuilder fiftyone.ipintelligence.IPIntelligenceOnPremisePipelineBuilder.setConcurrency ( int   concurrency )

Set the expected number of concurrent operations using the engine.

This sets the concurrency of the internal caches to avoid excessive locking.

Parameters
concurrency - expected concurrent accesses
Returns
this builder

◆ setDataFileSystemWatcher()

IPIntelligenceOnPremisePipelineBuilder fiftyone.ipintelligence.IPIntelligenceOnPremisePipelineBuilder.setDataFileSystemWatcher ( boolean   enabled )

The DataUpdateService has the ability to watch a file on disk and refresh the engine as soon as that file is updated.

This setting enables/disables that feature.

Parameters
enabled - True to enable file system watcher. False to disable.
Returns
This builder instance.

◆ setDataUpdateLicenseKey()

IPIntelligenceOnPremisePipelineBuilder fiftyone.ipintelligence.IPIntelligenceOnPremisePipelineBuilder.setDataUpdateLicenseKey ( String   key )

Set the license key used when checking for new IP Intelligence data files.

Defaults to null.

Parameters
key - The license key.
Returns
This builder instance.

◆ setDataUpdateOnStartup()

IPIntelligenceOnPremisePipelineBuilder fiftyone.ipintelligence.IPIntelligenceOnPremisePipelineBuilder.setDataUpdateOnStartup ( boolean   enabled )

Enable/Disable update on startup.

Defaults to enabled. If enabled, the auto update system will be used to check for an update before the IP Intelligence engine is created. If an update is available, it will be downloaded and applied before the pipeline is built and returned for use so this may take some time.

Parameters
enabled - True to enable update on startup. False to disable.
Returns
This builder instance.

◆ setDataUpdateService()

IPIntelligenceOnPremisePipelineBuilder fiftyone.ipintelligence.IPIntelligenceOnPremisePipelineBuilder.setDataUpdateService ( DataUpdateService   dataUpdateService )

Automatic updates require a DataUpdateService.

Parameters
dataUpdateService - an instance of a dataUpdateService
Returns
This builder instance.

◆ setDataUpdateUrl()

IPIntelligenceOnPremisePipelineBuilder fiftyone.ipintelligence.IPIntelligenceOnPremisePipelineBuilder.setDataUpdateUrl ( String   url )

Configure the engine to use the specified URL when looking for an updated data file.

Default is the 51Degrees update URL

Parameters
url - the URL to check for a new data file
Returns
this builder

◆ setDataUpdateVerifyMd5()

IPIntelligenceOnPremisePipelineBuilder fiftyone.ipintelligence.IPIntelligenceOnPremisePipelineBuilder.setDataUpdateVerifyMd5 ( Boolean   verify )

Set a value indicating if the DataUpdateService should expect the response from the data update URL to contain a 'content-md5' HTTP header that can be used to verify the integrity of the content.

Default true

Parameters
verify - true if the content should be verified with the Md5 hash. False otherwise
Returns
this builder

◆ setPerformanceProfile()

IPIntelligenceOnPremisePipelineBuilder fiftyone.ipintelligence.IPIntelligenceOnPremisePipelineBuilder.setPerformanceProfile ( Constants.PerformanceProfiles   profile )

Set the performance profile for the IP Intelligence engine.

Defaults to balanced.

Parameters
profile - The performance profile to use.
Returns
This builder instance.

◆ setProperty()

IPIntelligenceOnPremisePipelineBuilder fiftyone.ipintelligence.IPIntelligenceOnPremisePipelineBuilder.setProperty ( String   property )

Add a property to the list of properties that the engine will populate in the response.

By default all properties will be populated.

Parameters
property - the property that we want the engine to populate
Returns
this builder

◆ setShareUsage()

IPIntelligenceOnPremisePipelineBuilder fiftyone.ipintelligence.IPIntelligenceOnPremisePipelineBuilder.setShareUsage ( boolean   enabled )

Set share usage enabled/disabled.

Defaults to enabled.

Parameters
enabled - True to enable usage sharing. False to disable.
Returns
This builder instance.

◆ setUpdatePollingInterval()

IPIntelligenceOnPremisePipelineBuilder fiftyone.ipintelligence.IPIntelligenceOnPremisePipelineBuilder.setUpdatePollingInterval ( int   pollingIntervalSeconds )

Set the time between checks for a new data file made by the DataUpdateService in seconds.

Default = 30 minutes.

Parameters
pollingIntervalSeconds - The number of seconds between checks.
Returns
This builder instance.

◆ setUpdatePollingIntervalMillis()

IPIntelligenceOnPremisePipelineBuilder fiftyone.ipintelligence.IPIntelligenceOnPremisePipelineBuilder.setUpdatePollingIntervalMillis ( long   pollingIntervalMillis )

Set the time between checks for a new data file made by the DataUpdateService in milliseconds.

Parameters
pollingIntervalMillis - The number of milliseconds between checks.
Returns
This builder instance.

◆ setUpdateRandomisationMax()

IPIntelligenceOnPremisePipelineBuilder fiftyone.ipintelligence.IPIntelligenceOnPremisePipelineBuilder.setUpdateRandomisationMax ( int   randomisationMaxSeconds )

A random element can be added to the DataUpdateService polling interval.

This option sets the maximum length of this random addition. Default = 10 minutes.

Parameters
randomisationMaxSeconds - The maximum time added to the data update polling interval in seconds.
Returns
This builder instance.

◆ setUpdateRandomisationMaxMillis()

IPIntelligenceOnPremisePipelineBuilder fiftyone.ipintelligence.IPIntelligenceOnPremisePipelineBuilder.setUpdateRandomisationMaxMillis ( long   randomisationMaxMillis )

A random element can be added to the DataUpdateService polling interval.

This option sets the maximum length of this random addition. Default = 10 minutes.

Parameters
randomisationMaxMillis - The maximum time added to the data update polling interval in milliseconds.
Returns
This builder instance.
On This Page

Generated by doxygen 1.8.15