Class/Object

com.snowplowanalytics.snowplow.enrich.common.enrichments.registry

IpLookupsEnrichment

Related Docs: object IpLookupsEnrichment | package registry

Permalink

case class IpLookupsEnrichment(geoTuple: Option[(String, URI, String)], ispTuple: Option[(String, URI, String)], orgTuple: Option[(String, URI, String)], domainTuple: Option[(String, URI, String)], netspeedTuple: Option[(String, URI, String)], localMode: Boolean) extends Enrichment with Product with Serializable

Contains enrichments based on IP address.

geoTuple

(Full URI to the geo lookup MaxMind data file, database name)

ispTuple

(Full URI to the ISP lookup MaxMind data file, database name)

orgTuple

(Full URI to the organization lookup MaxMind data file

domainTuple

(Full URI to the domain lookup MaxMind data file, database name)

netspeedTuple

(Full URI to the netspeed lookup MaxMind data file, database name)

localMode

Whether to use the local MaxMind data file. Enabled for tests.

Linear Supertypes
Serializable, Serializable, Product, Equals, Enrichment, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. IpLookupsEnrichment
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. Enrichment
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new IpLookupsEnrichment(geoTuple: Option[(String, URI, String)], ispTuple: Option[(String, URI, String)], orgTuple: Option[(String, URI, String)], domainTuple: Option[(String, URI, String)], netspeedTuple: Option[(String, URI, String)], localMode: Boolean)

    Permalink

    geoTuple

    (Full URI to the geo lookup MaxMind data file, database name)

    ispTuple

    (Full URI to the ISP lookup MaxMind data file, database name)

    orgTuple

    (Full URI to the organization lookup MaxMind data file

    domainTuple

    (Full URI to the domain lookup MaxMind data file, database name)

    netspeedTuple

    (Full URI to the netspeed lookup MaxMind data file, database name)

    localMode

    Whether to use the local MaxMind data file. Enabled for tests.

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  6. val dbsToCache: List[(URI, FinalPath)]

    Permalink

  7. val domainTuple: Option[(String, URI, String)]

    Permalink

    (Full URI to the domain lookup MaxMind data file, database name)

  8. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  9. def extractIpInformation(ip: String): Validation[String, IpLookupResult]

    Permalink

    Extract the geo-location using the client IP address.

    Extract the geo-location using the client IP address.

    Note we wrap the getLocation call in a try catch block. At the time of writing, no valid or invalid IP address can make getLocation throw an Exception, but we keep this protection in case this situation changes in the future (as we don't control the functionality of the underlying MaxMind Java API).

    ip

    The client's IP address to use to lookup the client's geo-location

    returns

    a MaybeIpLocation (Option-boxed IpLocation), or an error message, boxed in a Scalaz Validation

  10. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  11. val geoTuple: Option[(String, URI, String)]

    Permalink

    (Full URI to the geo lookup MaxMind data file, database name)

  12. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  13. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  14. val ispTuple: Option[(String, URI, String)]

    Permalink

    (Full URI to the ISP lookup MaxMind data file, database name)

  15. val localMode: Boolean

    Permalink

    Whether to use the local MaxMind data file.

    Whether to use the local MaxMind data file. Enabled for tests.

  16. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  17. val netspeedTuple: Option[(String, URI, String)]

    Permalink

    (Full URI to the netspeed lookup MaxMind data file, database name)

  18. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  19. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  20. val orgTuple: Option[(String, URI, String)]

    Permalink

    (Full URI to the organization lookup MaxMind data file

  21. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  22. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  23. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  24. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Enrichment

Inherited from AnyRef

Inherited from Any

Ungrouped