org.ametys.plugins.newsletter.workflow

Class SendGAEventsEngine

java.lang.Object

org.ametys.plugins.newsletter.workflow.SendGAEventsEngine

All Implemented Interfaces:

Runnable

public class SendGAEventsEngine
extends Object
implements Runnable

Send a google analytics event for every newsletter e-mail sent.

Field Summary

Fields

Modifier and Type	Field and Description
private Category	_category
protected CategoryProviderExtensionPoint	_categoryProviderEP The category provider extension point.
protected Context	_context The avalon context.
private static DateFormat	_DATE_FORMAT
protected Context	_environmentContext The cocoon environment context.
private int	_eventCount
protected GAUriBuilder	_gaUriBuilder The google analytics URI builder.
protected I18nUtils	_i18nUtils The i18n utils component.
protected boolean	_initialized Is the engine initialized ?
private static Logger	_LOGGER
protected ServiceManager	_manager The service manager.
private Date	_newsletterDate
private long	_newsletterNumber
private String	_newsletterTitle
private boolean	_parametrized
protected SiteConfigurationExtensionPoint	_siteConf The site configuration extension point.
private String	_siteName

Constructor Summary

Constructors

Constructor and Description
SendGAEventsEngine()

Method Summary

Modifier and Type	Method and Description
private void	_checkInitialization()
protected String	computeEventIdentifier() Compute the event identifier for the newsletter sending.
protected void	consumeQuietly(InputStream input) Consume a stream, reading all its data and ignoring errors.
void	initialize(ServiceManager manager, Context context) Initialize the engine.
void	parametrize(String siteName, WebContent newsletterContent, Category category, int eventCount) Parametrize engine
void	run()
protected void	sendEvent(String eventUrl) Send the event request, given the full GIF URL.
protected void	sendEvents(String gaWebId) Send GA events for a given GA user account.

Methods inherited from class java.lang.Object

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

Field Detail

_LOGGER

private static final Logger _LOGGER

_DATE_FORMAT

private static final DateFormat _DATE_FORMAT

_context

protected Context _context

The avalon context.

_environmentContext

protected Context _environmentContext

The cocoon environment context.

_manager

protected ServiceManager _manager

The service manager.

_initialized

protected boolean _initialized

Is the engine initialized ?

_gaUriBuilder

protected GAUriBuilder _gaUriBuilder

The google analytics URI builder.

_categoryProviderEP

protected CategoryProviderExtensionPoint _categoryProviderEP

The category provider extension point.

_siteConf

protected SiteConfigurationExtensionPoint _siteConf

The site configuration extension point.

_i18nUtils

protected I18nUtils _i18nUtils

The i18n utils component.

_parametrized

private boolean _parametrized

_siteName

private String _siteName

_newsletterDate

private Date _newsletterDate

_newsletterNumber

private long _newsletterNumber

_newsletterTitle

private String _newsletterTitle

_category

private Category _category

_eventCount

private int _eventCount

Constructor Detail

SendGAEventsEngine

public SendGAEventsEngine()

Method Detail

initialize

public void initialize(ServiceManager manager,
                       Context context)
                throws ContextException,
                       ServiceException

Initialize the engine.

Parameters:

manager - the avalon service manager.

context - the avalon context.

Throws:

ContextException - if an error occurred during initialization

ServiceException - if an error occurred during initialization

parametrize

public void parametrize(String siteName,
                        WebContent newsletterContent,
                        Category category,
                        int eventCount)

Parametrize engine

Parameters:

siteName - The site name

newsletterContent - the newsletter content

category - the newsletter category

eventCount - the number of events

_checkInitialization

private void _checkInitialization()

run

public void run()

Specified by:

run in interface Runnable

sendEvents

protected void sendEvents(String gaWebId)

Send GA events for a given GA user account.

Parameters:

gaWebId - the google web ID.

sendEvent

protected void sendEvent(String eventUrl)
                  throws IOException

Send the event request, given the full GIF URL.

Parameters:

eventUrl - the full event GIF URL (with parameters).

Throws:

IOException - if an error occurs sending the GIF HTTP request.

computeEventIdentifier

protected String computeEventIdentifier()

Compute the event identifier for the newsletter sending.

Returns:

the event identifier.

consumeQuietly

protected void consumeQuietly(InputStream input)

Consume a stream, reading all its data and ignoring errors.

Parameters:

input - the input stream to consume.