org.nuxeo.segment.io

Class SegmentIOComponent

java.lang.Object

org.nuxeo.runtime.model.DefaultComponent

org.nuxeo.segment.io.SegmentIOComponent

All Implemented Interfaces:

Adaptable, Component, Extensible, TimestampedService, SegmentIO

public class SegmentIOComponent
extends DefaultComponent
implements SegmentIO

Author:

Tiry

Nested Class Summary

Nested classes/interfaces inherited from interface org.nuxeo.segment.io.SegmentIO

SegmentIO.ACTIONS

Field Summary

Fields

Modifier and Type	Field and Description
protected org.osgi.framework.Bundle	bundle
protected SegmentIOConfig	config
static String	CONFIG_EP
protected boolean	debugMode
protected static String	DEFAULT_DEBUG_KEY
protected Map<String,List<SegmentIOMapper>>	event2Mappers
static String	FILTERS_EP
protected com.github.segmentio.flush.Flusher	flusher
static String	INTEGRATIONS_EP
protected SegmentIOIntegrations	integrationsConfig
protected static org.apache.commons.logging.Log	log
static String	MAPPER_EP
protected Map<String,SegmentIOMapper>	mappers
protected List<Map<String,Object>>	testData
protected SegmentIOUserFilter	userFilters
static String	WRITE_KEY

Fields inherited from class org.nuxeo.runtime.model.DefaultComponent

lastModified, name

Constructor Summary

Constructors

Constructor and Description
SegmentIOComponent()

Method Summary

Modifier and Type	Method and Description
void	activate(ComponentContext context) Activates the component.
void	applicationStarted(ComponentContext context) Notify the component that Nuxeo Framework finished starting all Nuxeo bundles.
protected com.github.segmentio.models.Options	buildOptions() Build common options for identify and track calls.
protected void	computeEvent2Mappers()
void	deactivate(ComponentContext context) Deactivates the component.
void	flush()
protected com.github.segmentio.models.Props	generateProperties(SegmentIODataWrapper wrapper, String action, String name) Generates a Analytics Props object.
Map<String,List<SegmentIOMapper>>	getAllMappers()
org.osgi.framework.Bundle	getBundle()
protected com.github.segmentio.flush.Flusher	getFlusher()
Map<String,String>	getGlobalParameters()
Map<String,Boolean>	getIntegrations()
Set<String>	getMappedEvents()
Map<String,List<SegmentIOMapper>>	getMappers(List<String> events)
List<Map<String,Object>>	getTestData()
SegmentIOUserFilter	getUserFilters()
String	getWriteKey()
protected void	group(String groupId, String userId, com.github.segmentio.models.Traits traits, com.github.segmentio.models.Options options)
void	identify(NuxeoPrincipal principal)
void	identify(NuxeoPrincipal principal, Map<String,Serializable> metadata)
boolean	isDebugMode()
boolean	mustTrackprincipal(String principalName)
void	page(NuxeoPrincipal principal, String name, Map<String,Serializable> metadata)
void	page(NuxeoPrincipal principal, String name, String category, Map<String,Serializable> metadata)
protected Map<String,Object>	pushForTest(String action, String userId, Map<String,Object> metadata, com.github.segmentio.models.Options options)
protected void	pushForTest(String action, String userId, String eventName, Map<String,Object> metadata, com.github.segmentio.models.Options options)
void	registerContribution(Object contribution, String extensionPoint, ComponentInstance contributor)
void	screen(NuxeoPrincipal principal, String screen, Map<String,Serializable> metadata)
void	track(NuxeoPrincipal principal, String eventName, Map<String,Serializable> metadata)

Methods inherited from class org.nuxeo.runtime.model.DefaultComponent

getAdapter, getDescriptor, getDescriptors, getLastModified, getRegistry, register, registerExtension, setLastModified, setModifiedNow, setName, start, stop, unregister, unregisterContribution, unregisterExtension

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.nuxeo.runtime.model.Component

getApplicationStartedOrder

Field Detail

log

protected static org.apache.commons.logging.Log log

DEFAULT_DEBUG_KEY

protected static final String DEFAULT_DEBUG_KEY

See Also:

Constant Field Values

WRITE_KEY

public static final String WRITE_KEY

See Also:

Constant Field Values

CONFIG_EP

public static final String CONFIG_EP

See Also:

Constant Field Values

MAPPER_EP

public static final String MAPPER_EP

See Also:

Constant Field Values

INTEGRATIONS_EP

public static final String INTEGRATIONS_EP

See Also:

Constant Field Values

FILTERS_EP

public static final String FILTERS_EP

See Also:

Constant Field Values

debugMode

protected boolean debugMode

mappers

protected Map<String,SegmentIOMapper> mappers

event2Mappers

protected Map<String,List<SegmentIOMapper>> event2Mappers

testData

protected List<Map<String,Object>> testData

config

protected SegmentIOConfig config

integrationsConfig

protected SegmentIOIntegrations integrationsConfig

userFilters

protected SegmentIOUserFilter userFilters

bundle

protected org.osgi.framework.Bundle bundle

flusher

protected com.github.segmentio.flush.Flusher flusher

Constructor Detail

SegmentIOComponent

public SegmentIOComponent()

Method Detail

getBundle

public org.osgi.framework.Bundle getBundle()

activate

public void activate(ComponentContext context)

Description copied from interface: Component

Activates the component.

This method is called by the runtime when a component is activated.

Specified by:

activate in interface Component

Overrides:

activate in class DefaultComponent

Parameters:

context - the runtime context

deactivate

public void deactivate(ComponentContext context)

Description copied from interface: Component

Deactivates the component.

This method is called by the runtime when a component is deactivated.

Specified by:

deactivate in interface Component

Overrides:

deactivate in class DefaultComponent

Parameters:

context - the runtime context

registerContribution

public void registerContribution(Object contribution,
                                 String extensionPoint,
                                 ComponentInstance contributor)

Overrides:

registerContribution in class DefaultComponent

applicationStarted

public void applicationStarted(ComponentContext context)

Description copied from interface: Component

Notify the component that Nuxeo Framework finished starting all Nuxeo bundles. Implementors must migrate the code of the applicationStarted and move it to Component.start(ComponentContext) and Component.stop(ComponentContext) methods

Specified by:

applicationStarted in interface Component

computeEvent2Mappers

protected void computeEvent2Mappers()

getWriteKey

public String getWriteKey()

Specified by:

getWriteKey in interface SegmentIO

getGlobalParameters

public Map<String,String> getGlobalParameters()

Specified by:

getGlobalParameters in interface SegmentIO

getFlusher

protected com.github.segmentio.flush.Flusher getFlusher()

identify

public void identify(NuxeoPrincipal principal)

Specified by:

identify in interface SegmentIO

getIntegrations

public Map<String,Boolean> getIntegrations()

Specified by:

getIntegrations in interface SegmentIO

buildOptions

protected com.github.segmentio.models.Options buildOptions()

Build common options for identify and track calls. These options contains the configured integrations values and the current timestamp.

Returns:

the builded Options object

identify

public void identify(NuxeoPrincipal principal,
                     Map<String,Serializable> metadata)

Specified by:

identify in interface SegmentIO

group

protected void group(String groupId,
                     String userId,
                     com.github.segmentio.models.Traits traits,
                     com.github.segmentio.models.Options options)

pushForTest

protected Map<String,Object> pushForTest(String action,
                                         String userId,
                                         Map<String,Object> metadata,
                                         com.github.segmentio.models.Options options)

pushForTest

protected void pushForTest(String action,
                           String userId,
                           String eventName,
                           Map<String,Object> metadata,
                           com.github.segmentio.models.Options options)

getTestData

public List<Map<String,Object>> getTestData()

mustTrackprincipal

public boolean mustTrackprincipal(String principalName)

Specified by:

mustTrackprincipal in interface SegmentIO

track

public void track(NuxeoPrincipal principal,
                  String eventName,
                  Map<String,Serializable> metadata)

Specified by:

track in interface SegmentIO

generateProperties

protected com.github.segmentio.models.Props generateProperties(SegmentIODataWrapper wrapper,
                                                               String action,
                                                               String name)

Generates a Analytics Props object. If user is ignored, or the execution in a test context the return is null and has been handled as app log.

Returns:

a filled Props object if the object has to be send for real.

screen

public void screen(NuxeoPrincipal principal,
                   String screen,
                   Map<String,Serializable> metadata)

Specified by:

screen in interface SegmentIO

page

public void page(NuxeoPrincipal principal,
                 String name,
                 Map<String,Serializable> metadata)

Specified by:

page in interface SegmentIO

page

public void page(NuxeoPrincipal principal,
                 String name,
                 String category,
                 Map<String,Serializable> metadata)

Specified by:

page in interface SegmentIO

flush

public void flush()

Specified by:

flush in interface SegmentIO

getMappers

public Map<String,List<SegmentIOMapper>> getMappers(List<String> events)

Specified by:

getMappers in interface SegmentIO

getMappedEvents

public Set<String> getMappedEvents()

Specified by:

getMappedEvents in interface SegmentIO

getAllMappers

public Map<String,List<SegmentIOMapper>> getAllMappers()

Specified by:

getAllMappers in interface SegmentIO

getUserFilters

public SegmentIOUserFilter getUserFilters()

Specified by:

getUserFilters in interface SegmentIO

isDebugMode

public boolean isDebugMode()

Specified by:

isDebugMode in interface SegmentIO

Returns:

true if the service is in debug mode