Package com.mparticle.sdk

Class MessageProcessor

java.lang.Object

com.mparticle.sdk.MessageProcessor

public abstract class MessageProcessor
extends 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	Description
MessageProcessor()

Method Summary

Modifier and Type	Method	Description
protected final void	log(String message)	Logs a message.
void	processApplicationStateTransitionEvent(ApplicationStateTransitionEvent event)	Handler for processing ApplicationStateTransitionEvent.
void	processAttributionEvent(AttributionEvent event)
AudienceMembershipChangeResponse	processAudienceMembershipChangeRequest(AudienceMembershipChangeRequest request)	Handler for processing audience membership changes.
AudienceSubscriptionResponse	processAudienceSubscriptionRequest(AudienceSubscriptionRequest request)	Handler for processing audience subscriptions.
void	processCCPAConsentStateNotification(CCPAConsentStateNotification notification)	Handler for processing CCPA Consent State system notifications
void	processCustomEvent(CustomEvent event)	Handler for processing CustomEvent.
DsrProcessingResponse	processDsrProcessingRequest(DsrProcessingRequest request)	Handler for processing data subject requests.
void	processErrorEvent(ErrorEvent event)	Handler for processing ErrorEvent.
EventProcessingResponse	processEventProcessingRequest(EventProcessingRequest request)	Handler for processing event processing request.
void	processGDPRConsentStateNotification(GDPRConsentStateNotification notification)	Handler for processing GDPR Consent State system notifications
void	processImpressionEvent(ImpressionEvent event)	Handler for processing ImpressionEvents.
final 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	processPromotionActionEvent(PromotionActionEvent event)	Handler for processing PromotionActionEvents.
void	processPushMessageOpenEvent(PushMessageOpenEvent event)	Handler for processing PushMessageOpenEvent.
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 Details

MessageProcessor

public MessageProcessor()

Method Details

processMessage

public final Message processMessage(Message request)
                             throws IOException

Parses the message and invokes specific handler.

Parameters:

request - Request message

Returns:

Response message

Throws:

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 IOException

Handler for processing event processing request.

Base implementation parses the request and calls individual event and system notification handlers.

Parameters:

request - request

Returns:

response

Throws:

IOException

processGDPRConsentStateNotification

public void processGDPRConsentStateNotification(GDPRConsentStateNotification notification)
                                         throws IOException

Handler for processing GDPR Consent State system notifications

Parameters:

notification -

Throws:

IOException

processCCPAConsentStateNotification

public void processCCPAConsentStateNotification(CCPAConsentStateNotification notification)
                                         throws IOException

Handler for processing CCPA Consent State system notifications

Parameters:

notification -

Throws:

IOException

processAttributionEvent

public void processAttributionEvent(AttributionEvent event)
                             throws IOException

Parameters:

event -

Throws:

IOException

processImpressionEvent

public void processImpressionEvent(ImpressionEvent event)
                            throws IOException

Handler for processing ImpressionEvents.

Parameters:

event -

Throws:

IOException

processPromotionActionEvent

public void processPromotionActionEvent(PromotionActionEvent event)
                                 throws IOException

Handler for processing PromotionActionEvents.

Parameters:

event -

Throws:

IOException

processProductActionEvent

public void processProductActionEvent(ProductActionEvent event)
                               throws IOException

Handler for processing ProductActionEvent.

Parameters:

event - event

Throws:

IOException

processPushMessageReceiptEvent

public void processPushMessageReceiptEvent(PushMessageReceiptEvent event)
                                    throws IOException

Handler for processing PushMessageReceiptEvent.

Parameters:

event - event

Throws:

IOException

processPushMessageOpenEvent

public void processPushMessageOpenEvent(PushMessageOpenEvent event)
                                 throws IOException

Handler for processing PushMessageOpenEvent.

Parameters:

event - event

Throws:

IOException

processApplicationStateTransitionEvent

public void processApplicationStateTransitionEvent(ApplicationStateTransitionEvent event)
                                            throws IOException

Handler for processing ApplicationStateTransitionEvent.

Parameters:

event - event

Throws:

IOException

processPushSubscriptionEvent

public void processPushSubscriptionEvent(PushSubscriptionEvent event)
                                  throws IOException

Handler for processing PushSubscriptionEvent.

Parameters:

event - event

Throws:

IOException

processUserIdentityChangeEvent

public void processUserIdentityChangeEvent(UserIdentityChangeEvent event)
                                    throws IOException

Handler for processing UserIdentityChangeEvent.

Parameters:

event - event

Throws:

IOException

processUserAttributeChangeEvent

public void processUserAttributeChangeEvent(UserAttributeChangeEvent event)
                                     throws IOException

Handler for processing UserAttributeChangeEvent.

Parameters:

event - event

Throws:

IOException

processSessionStartEvent

public void processSessionStartEvent(SessionStartEvent event)
                              throws IOException

Handler for processing SessionStartEvent.

Parameters:

event - event

Throws:

IOException

processSessionEndEvent

public void processSessionEndEvent(SessionEndEvent event)
                            throws IOException

Handler for processing SessionEndEvent.

Parameters:

event - event

Throws:

IOException

processCustomEvent

public void processCustomEvent(CustomEvent event)
                        throws IOException

Handler for processing CustomEvent.

Parameters:

event - event

Throws:

IOException

processErrorEvent

public void processErrorEvent(ErrorEvent event)
                       throws IOException

Handler for processing ErrorEvent.

Parameters:

event - event

Throws:

IOException

processScreenViewEvent

public void processScreenViewEvent(ScreenViewEvent event)
                            throws IOException

Handler for processing ScreenViewEvent.

Parameters:

event - event

Throws:

IOException

processPrivacySettingChangeEvent

public void processPrivacySettingChangeEvent(PrivacySettingChangeEvent event)
                                      throws IOException

Handler for processing PrivacySettingChangeEvent.

Parameters:

event - event

Throws:

IOException

processDsrProcessingRequest

public DsrProcessingResponse processDsrProcessingRequest(DsrProcessingRequest request)
                                                  throws IOException

Handler for processing data subject requests.

Parameters:

request - request

Returns:

response

Throws:

IOException

processAudienceMembershipChangeRequest

public AudienceMembershipChangeResponse processAudienceMembershipChangeRequest(AudienceMembershipChangeRequest request)
                                                                        throws IOException

Handler for processing audience membership changes.

Parameters:

request - request

Returns:

response

Throws:

IOException

processAudienceSubscriptionRequest

public AudienceSubscriptionResponse processAudienceSubscriptionRequest(AudienceSubscriptionRequest request)
                                                                throws IOException

Handler for processing audience subscriptions.

Parameters:

request - request

Returns:

response

Throws:

IOException

setLogger

public void setLogger(Logger logger)

Sets logger.

Parameters:

logger - logger

log

protected final void log(String message)

Logs a message.

Parameters:

message -