Detailed Description
The IP intelligence cloud engine requires the 51Degrees CloudRequestEngine to be placed in a pipeline before it.
It takes the raw JSON response produced by the CloudRequestEngine and parses out the IP intelligence segment, which is keyed "ip" - matching ip-intelligence-dotnet's IpiCloudEngine.ElementDataKey and the cloud service JSON.
Weighted properties (for example Mcc, CountryCodesGeographical and CountryCodesPopulation) are returned as a list of {"value": ..., "rawweighting": ...} objects, wrapped verbatim in an AspectPropertyValue by the base CloudEngine.
Inheritance diagram for fiftyone\pipeline\ipintelligence\IpIntelligenceCloud:
Collaboration diagram for fiftyone\pipeline\ipintelligence\IpIntelligenceCloud:
Public Member Functions | |
| processInternal (FlowData $flowData) | |
| Process the cloud response for IP intelligence. | |
Public Member Functions inherited from fiftyone\pipeline\cloudrequestengine\CloudEngine | |
| onRegistration (Pipeline $pipeline) | |
| Callback called when an engine is added to a pipeline. | |
| getEvidenceKeyFilter () | |
| A cloud engine reads only the Cloud Request Engine's response, so it accepts no Evidence. | |
Public Member Functions inherited from fiftyone\pipeline\engines\Engine | |
| getDataSourceTier () | |
| Get the tier to which the current data source belongs. | |
| setCache (DataKeyedCache $cache) | |
| Add a cache to an engine. | |
| setRestrictedProperties (array $propertiesList) | |
| Add a subset of properties. | |
| inCache (FlowData $flowData) | |
| A method to check if a flowData's evidence is in the cache. | |
| process (FlowData $flowData) | |
| Engine's core process function. | |
Public Member Functions inherited from fiftyone\pipeline\core\FlowElement | |
| __construct () | |
| A default dummy constructor is needed for there are classes inheriting this class deeper than 1-level of inheritance and calling parent::__construct() in their explicit constructors. | |
| filterEvidence (FlowData $flowData) | |
| Filter FlowData evidence using the FlowElement's EvidenceKeyFilter. | |
| filterEvidenceKey (string $key) | |
| Filter FlowData evidence using the FlowElement's EvidenceKeyFilter. | |
| getProperties () | |
| Get properties Usually overridden by specific FlowElements. | |
| updatePropertyList () | |
| Update a FlowElement's property list This is used by elements that are only aware of their properties at a later stage, such as cloud request based FlowElements or FlowElements that change their properties later based on new datafiles. | |
Data Fields | |
| string | $dataKey = Constants::ELEMENT_DATA_KEY |
Data Fields inherited from fiftyone\pipeline\cloudrequestengine\CloudEngine | |
| string | $dataKey = 'CloudEngineBase' |
| array | $aspectProperties |
Data Fields inherited from fiftyone\pipeline\engines\Engine | |
| array | $restrictedProperties |
Data Fields inherited from fiftyone\pipeline\core\FlowElement | |
| string | $dataKey |
| array | $properties = [] |
| array | $pipelines = [] |
Additional Inherited Members | |
Protected Member Functions inherited from fiftyone\pipeline\cloudrequestengine\CloudEngine | |
| logMissingProduct (FlowData $flowData) | |
| Log once, at warning level, when the products the Cloud Request Engine found hold nothing for this engine's Data Key. | |
Protected Member Functions inherited from fiftyone\pipeline\engines\Engine | |
| holdsValueForOneRequest (ElementData $data) | |
| Whether a result holds a value created for the one request that asked for it, such as a 51Did. | |
Member Function Documentation
◆ processInternal()
| fiftyone\pipeline\ipintelligence\IpIntelligenceCloud::processInternal | ( | FlowData | $flowData | ) |
Process the cloud response for IP intelligence.
- Exceptions
-
Exception
Reimplemented from fiftyone\pipeline\cloudrequestengine\CloudEngine.