\r\n

51Degrees IP Intelligence Java  4.5

IP Intelligence services for 51Degrees Pipeline

fiftyone.ipintelligence.shared.IPIntelligenceData Interface Reference

Detailed Description

Interface exposing typed accessors for properties related to an IP.

This includes the network, and location.

Inheritance diagram for fiftyone.ipintelligence.shared.IPIntelligenceData:

[legend]

Collaboration diagram for fiftyone.ipintelligence.shared.IPIntelligenceData:

[legend]

Public Member Functions

AspectPropertyValue< Integer >  getAccuracyRadiusMax ()
Radius in kilometers of the circle centred around the most probable location that encompasses the entire area(s). More...
AspectPropertyValue< Integer >  getAccuracyRadiusMin ()
Radius in kilometers of the largest circle centred around the most probable location that fits within the area. More...
AspectPropertyValue< String >  getAreas ()
Any shapes associated with the location. More...
AspectPropertyValue< String >  getAsn ()
Autonomous System Number associated with the IP address.
AspectPropertyValue< String >  getAsnName ()
The name registered to the Asn associated with the IP address.
AspectPropertyValue< String >  getConnectionType ()
Indicates the type of connection being used. More...
AspectPropertyValue< String >  getContinentCode2 ()
The 3-character ISO 3166-1 continent code for the supplied location.
AspectPropertyValue< String >  getContinentName ()
The name of the continent the supplied location is in.
AspectPropertyValue< String >  getCountry ()
The name of the country that the supplied location is in.
AspectPropertyValue< String >  getCountryCode ()
The 2-character ISO 3166-1 code of the country that the supplied location is in.
AspectPropertyValue< String >  getCountryCode3 ()
The 3-character ISO 3166-1 alpha-3 code of the country that the supplied location is in.
AspectPropertyValue< String >  getCounty ()
The name of the county that the supplied location is in. More...
AspectPropertyValue< String >  getCurrencyCode ()
The Alpha-3 ISO 4217 code of the currency associated with the supplied location.
AspectPropertyValue< String >  getDialCode ()
ITU international telephone numbering plan code for the country.
AspectPropertyValue< Integer >  getHumanProbability ()
The confidence that the IP address is a human user versus associated with hosting. More...
AspectPropertyValue< InetAddress >  getIpRangeEnd ()
End of the IP range to which the evidence IP belongs.
AspectPropertyValue< InetAddress >  getIpRangeStart ()
Start of the IP range to which the evidence IP belongs.
AspectPropertyValue< Boolean >  getIsBroadband ()
Indicates whether the IP address is associated with a broadband connection. More...
AspectPropertyValue< Boolean >  getIsCellular ()
Indicates whether the IP address is associated with a cellular network.
AspectPropertyValue< Boolean >  getIsEu ()
Indicates whether the country of the supplied location is within the European Union.
AspectPropertyValue< Boolean >  getIsHosted ()
Indicates whether the IP address is associated with hosting. More...
AspectPropertyValue< Boolean >  getIsProxy ()
Indicates whether the IP address is associated with a Proxy server.
AspectPropertyValue< Boolean >  getIsPublicRouter ()
Indicates whether the IP address is associated with a public router.
AspectPropertyValue< Boolean >  getIsTor ()
Indicates whether the IP address is associated with a TOR server.
AspectPropertyValue< Boolean >  getIsVPN ()
Indicates whether the IP address is associated with a VPN server.
AspectPropertyValue< String >  getLanguageCode ()
The Alpha-2 ISO 639 Language code associated with the supplied location.
AspectPropertyValue< Float >  getLatitude ()
Average latitude of the IP. More...
AspectPropertyValue< String >  getLocationConfidence ()
The confidence in the town and country provided.
AspectPropertyValue< Float >  getLongitude ()
Average longitude of the IP. More...
AspectPropertyValue< List< IWeightedValue< String > > >  getMcc ()
The mobile country code of the network the device is connected to.
AspectPropertyValue< String >  getRegion ()
The name of the geographical region that the supplied location is in.
AspectPropertyValue< String >  getRegisteredCountry ()
Country code of the registered range.
AspectPropertyValue< String >  getRegisteredName ()
Name of the IP range. More...
AspectPropertyValue< String >  getRegisteredOwner ()
Registered owner of the range.
AspectPropertyValue< String >  getState ()
The name of the state that the supplied location is in.
AspectPropertyValue< String >  getSuburb ()
The name of the suburb that the supplied location is in.
AspectPropertyValue< String >  getTimeZoneIana ()
The time zone at the supplied location in the IANA Time Zone format.
AspectPropertyValue< Integer >  getTimeZoneOffset ()
The offset from UTC in minutes in the supplied location, at the time that the value is produced.
AspectPropertyValue< String >  getTown ()
The name of the town that the supplied location is in.
AspectPropertyValue< String >  getZipCode ()
The zip or postal code that the supplied location falls under.

Member Function Documentation

◆ getAccuracyRadiusMax()

AspectPropertyValue<Integer> fiftyone.ipintelligence.shared.IPIntelligenceData.getAccuracyRadiusMax ( )

Radius in kilometers of the circle centred around the most probable location that encompasses the entire area(s).

See Areas property. This will likely be a very large distance. It is recommend to use the AccuracyRadiusMin property.

Implemented in fiftyone.ipintelligence.shared.IPIntelligenceDataBase.

◆ getAccuracyRadiusMin()

AspectPropertyValue<Integer> fiftyone.ipintelligence.shared.IPIntelligenceData.getAccuracyRadiusMin ( )

Radius in kilometers of the largest circle centred around the most probable location that fits within the area.

Where multiple areas are returned, only the area that the most probable location falls within is considered. See Areas property.

Implemented in fiftyone.ipintelligence.shared.IPIntelligenceDataBase.

◆ getAreas()

AspectPropertyValue<String> fiftyone.ipintelligence.shared.IPIntelligenceData.getAreas ( )

Any shapes associated with the location.

Usually this is the area which the IP range covers. This is returned as a WKT String stored as a reduced format of WKB.

Implemented in fiftyone.ipintelligence.shared.IPIntelligenceDataBase.

◆ getConnectionType()

AspectPropertyValue<String> fiftyone.ipintelligence.shared.IPIntelligenceData.getConnectionType ( )

Indicates the type of connection being used.

Returns either Broadband, Cellular, or Hosting and Anonymous.

Implemented in fiftyone.ipintelligence.shared.IPIntelligenceDataBase.

◆ getCounty()

AspectPropertyValue<String> fiftyone.ipintelligence.shared.IPIntelligenceData.getCounty ( )

The name of the county that the supplied location is in.

In this case, a county is defined as an administrative sub-section of a country or state.

Implemented in fiftyone.ipintelligence.shared.IPIntelligenceDataBase.

◆ getHumanProbability()

AspectPropertyValue<Integer> fiftyone.ipintelligence.shared.IPIntelligenceData.getHumanProbability ( )

The confidence that the IP address is a human user versus associated with hosting.

A 1-10 value where; 1-3: Low confidence the user is human, 4-6: Medium confidence, 7-10: High confidence.

Implemented in fiftyone.ipintelligence.shared.IPIntelligenceDataBase.

◆ getIsBroadband()

AspectPropertyValue<Boolean> fiftyone.ipintelligence.shared.IPIntelligenceData.getIsBroadband ( )

Indicates whether the IP address is associated with a broadband connection.

Includes DSL, Cable, Fibre, and Satellite connections.

Implemented in fiftyone.ipintelligence.shared.IPIntelligenceDataBase.

◆ getIsHosted()

AspectPropertyValue<Boolean> fiftyone.ipintelligence.shared.IPIntelligenceData.getIsHosted ( )

Indicates whether the IP address is associated with hosting.

Includes both hosting and anonymised connections such as hosting networks, hosting ASNs, VPNs, proxies, TOR networks, and unreachable IP addresses.

Implemented in fiftyone.ipintelligence.shared.IPIntelligenceDataBase.

◆ getLatitude()

AspectPropertyValue<Float> fiftyone.ipintelligence.shared.IPIntelligenceData.getLatitude ( )

Average latitude of the IP.

For privacy, this is randomized within around 1 kilometer of the result. Randomized result will change only once per day.

Implemented in fiftyone.ipintelligence.shared.IPIntelligenceDataBase.

◆ getLongitude()

AspectPropertyValue<Float> fiftyone.ipintelligence.shared.IPIntelligenceData.getLongitude ( )

Average longitude of the IP.

For privacy, this is randomized within around 1 kilometer of the result. Randomized result will change only once per day.

Implemented in fiftyone.ipintelligence.shared.IPIntelligenceDataBase.