com.mparticle.sdk

Class MessageProcessor

java.lang.Object

com.mparticle.sdk.MessageProcessor

public abstract class MessageProcessor
extends java.lang.Object

Provides basic structure for implementing a custom message processing module.

A typical module

1. Implements processRegistrationRequest to return registration information about the module.
2. Adds custom logic to processEventProcessingRequest and/or event-specific handlers.
3. Implements processAudienceMembershipChangeRequest if the module subscribes to the audience data stream.
4. Implements processAudienceSubscriptionRequest if the module needs to handle audience subscription updates.

Constructor Summary

Constructors

Constructor and Description
MessageProcessor()

Method Summary

Modifier and Type	Method and Description
protected void	log(java.lang.String message) Logs a message.
void	processApplicationStateTransitionEvent(ApplicationStateTransitionEvent event) Handler for processing ApplicationStateTransitionEvent.
AudienceMembershipChangeResponse	processAudienceMembershipChangeRequest(AudienceMembershipChangeRequest request) Handler for processing audience membership changes.
AudienceSubscriptionResponse	processAudienceSubscriptionRequest(AudienceSubscriptionRequest request) Handler for processing audience subscriptions.
void	processCustomEvent(CustomEvent event) Handler for processing CustomEvent.
void	processErrorEvent(ErrorEvent event) Handler for processing ErrorEvent.
EventProcessingResponse	processEventProcessingRequest(EventProcessingRequest request) Handler for processing event processing request.
Message	processMessage(Message request) Parses the message and invokes specific handler.
void	processPrivacySettingChangeEvent(PrivacySettingChangeEvent event) Handler for processing PrivacySettingChangeEvent.
void	processProductActionEvent(ProductActionEvent event) Handler for processing ProductActionEvent.
void	processPushMessageReceiptEvent(PushMessageReceiptEvent event) Handler for processing PushMessageReceiptEvent.
void	processPushSubscriptionEvent(PushSubscriptionEvent event) Handler for processing PushSubscriptionEvent.
abstract ModuleRegistrationResponse	processRegistrationRequest(ModuleRegistrationRequest request) Handler for processing module registration request.
void	processScreenViewEvent(ScreenViewEvent event) Handler for processing ScreenViewEvent.
void	processSessionEndEvent(SessionEndEvent event) Handler for processing SessionEndEvent.
void	processSessionStartEvent(SessionStartEvent event) Handler for processing SessionStartEvent.
void	processUserAttributeChangeEvent(UserAttributeChangeEvent event) Handler for processing UserAttributeChangeEvent.
void	processUserIdentityChangeEvent(UserIdentityChangeEvent event) Handler for processing UserIdentityChangeEvent.
void	setLogger(Logger logger) Sets logger.

Methods inherited from class java.lang.Object

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

Constructor Detail

MessageProcessor

public MessageProcessor()

Method Detail

processMessage

public final Message processMessage(Message request)
                             throws java.io.IOException

Parses the message and invokes specific handler.

Parameters:

request - Request message

Returns:

Response message

Throws:

java.io.IOException

processRegistrationRequest

public abstract ModuleRegistrationResponse processRegistrationRequest(ModuleRegistrationRequest request)

Handler for processing module registration request.

Every module is required to specify description, user settings, supported events, and request access to specific user and device identifiers.

Parameters:

request - request

Returns:

response

processEventProcessingRequest

public EventProcessingResponse processEventProcessingRequest(EventProcessingRequest request)
                                                      throws java.io.IOException

Handler for processing event processing request.

Base implementation parses the request and calls individual event handlers.

Parameters:

request - request

Returns:

response

Throws:

java.io.IOException

processProductActionEvent

public void processProductActionEvent(ProductActionEvent event)
                               throws java.io.IOException

Handler for processing ProductActionEvent.

Parameters:

event - event

Throws:

java.io.IOException

processPushMessageReceiptEvent

public void processPushMessageReceiptEvent(PushMessageReceiptEvent event)
                                    throws java.io.IOException

Handler for processing PushMessageReceiptEvent.

Parameters:

event - event

Throws:

java.io.IOException

processApplicationStateTransitionEvent

public void processApplicationStateTransitionEvent(ApplicationStateTransitionEvent event)
                                            throws java.io.IOException

Handler for processing ApplicationStateTransitionEvent.

Parameters:

event - event

Throws:

java.io.IOException

processPushSubscriptionEvent

public void processPushSubscriptionEvent(PushSubscriptionEvent event)
                                  throws java.io.IOException

Handler for processing PushSubscriptionEvent.

Parameters:

event - event

Throws:

java.io.IOException

processUserIdentityChangeEvent

public void processUserIdentityChangeEvent(UserIdentityChangeEvent event)
                                    throws java.io.IOException

Handler for processing UserIdentityChangeEvent.

Parameters:

event - event

Throws:

java.io.IOException

processUserAttributeChangeEvent

public void processUserAttributeChangeEvent(UserAttributeChangeEvent event)
                                     throws java.io.IOException

Handler for processing UserAttributeChangeEvent.

Parameters:

event - event

Throws:

java.io.IOException

processSessionStartEvent

public void processSessionStartEvent(SessionStartEvent event)
                              throws java.io.IOException

Handler for processing SessionStartEvent.

Parameters:

event - event

Throws:

java.io.IOException

processSessionEndEvent

public void processSessionEndEvent(SessionEndEvent event)
                            throws java.io.IOException

Handler for processing SessionEndEvent.

Parameters:

event - event

Throws:

java.io.IOException

processCustomEvent

public void processCustomEvent(CustomEvent event)
                        throws java.io.IOException

Handler for processing CustomEvent.

Parameters:

event - event

Throws:

java.io.IOException

processErrorEvent

public void processErrorEvent(ErrorEvent event)
                       throws java.io.IOException

Handler for processing ErrorEvent.

Parameters:

event - event

Throws:

java.io.IOException

processScreenViewEvent

public void processScreenViewEvent(ScreenViewEvent event)
                            throws java.io.IOException

Handler for processing ScreenViewEvent.

Parameters:

event - event

Throws:

java.io.IOException

processPrivacySettingChangeEvent

public void processPrivacySettingChangeEvent(PrivacySettingChangeEvent event)
                                      throws java.io.IOException

Handler for processing PrivacySettingChangeEvent.

Parameters:

event - event

Throws:

java.io.IOException

processAudienceMembershipChangeRequest

public AudienceMembershipChangeResponse processAudienceMembershipChangeRequest(AudienceMembershipChangeRequest request)
                                                                        throws java.io.IOException

Handler for processing audience membership changes.

Parameters:

request - request

Returns:

response

Throws:

java.io.IOException

processAudienceSubscriptionRequest

public AudienceSubscriptionResponse processAudienceSubscriptionRequest(AudienceSubscriptionRequest request)
                                                                throws java.io.IOException

Handler for processing audience subscriptions.

Parameters:

request - request

Returns:

response

Throws:

java.io.IOException

setLogger

public void setLogger(Logger logger)

Sets logger.

Parameters:

logger - logger

log

protected final void log(java.lang.String message)

Logs a message.

Parameters:

message -