com.mparticle.sdk.model.registration

Class EventProcessingRegistration

java.lang.Object

com.mparticle.sdk.model.registration.EventProcessingRegistration

public final class EventProcessingRegistration
extends java.lang.Object

The EventProcessingRegistration object should be constructed by Firehose integrations that wish to function as event-integrations within the mParticle platform. Upon receiving a ModuleRegistrationRequest, it's up to the Firehose integration to response with a populated ModuleRegistrationResponse.

Constructor Summary

Constructors

Constructor and Description
EventProcessingRegistration()

Method Summary

Modifier and Type	Method and Description
java.util.List<Setting>	getAccountSettings() Gets the account-level settings registered by this integration.
AuthenticationConfiguration	getAuthentication()
java.util.List<Setting>	getConnectionSettings() Gets the subscription-level settings registered by this integration.
int	getMaxDataAgeHours()
java.lang.String	getPushMessagingProviderId() Get the push messaging provider ID.
java.util.List<Event.Type>	getSupportedEventTypes()
java.util.List<RuntimeEnvironment.Type>	getSupportedRuntimeEnvironments()
java.util.List<SystemNotification.Type>	getSupportedSystemNotifications()
EventProcessingRegistration	setAccountSettings(java.util.List<Setting> accountSettings) Register the account-level settings of this integration.
EventProcessingRegistration	setAuthentication(AuthenticationConfiguration authentication)
EventProcessingRegistration	setConnectionSettings(java.util.List<Setting> connectionSettings) Register the specific connection-level settings of this integration.
EventProcessingRegistration	setMaxDataAgeHours(int maxDataAgeHours)
EventProcessingRegistration	setPushMessagingProviderId(java.lang.String pushMessagingProviderId) Set the push messaging provider ID.
EventProcessingRegistration	setSupportedEventTypes(java.util.List<Event.Type> supportedEventTypes)
EventProcessingRegistration	setSupportedRuntimeEnvironments(java.util.List<RuntimeEnvironment.Type> supportedRuntimeEnvironments)
EventProcessingRegistration	setSupportedSystemNotifications(java.util.List<SystemNotification.Type> supportedSystemNotifications)

Methods inherited from class java.lang.Object

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

Constructor Detail

EventProcessingRegistration

public EventProcessingRegistration()

Method Detail

getAccountSettings

public java.util.List<Setting> getAccountSettings()

Gets the account-level settings registered by this integration. mParticle integrations may be configured with two different sets of settings: - Account-level settings, meant to be reused across platforms and/or apps - Subscription-level settings, meant to change specific behaviors for each instance of an output/integration As a Firehose integration developer, it's up to *you* to define which settings should be account-level, and which should be configured on a per-integration-instance basis.

Returns:

account settings registered by the integration

See Also:

to get the integration-specific settings registered for this integration

setAccountSettings

public EventProcessingRegistration setAccountSettings(java.util.List<Setting> accountSettings)

Register the account-level settings of this integration. mParticle integrations may be configured with two different sets of settings: - Account-level settings, meant to be reused across platforms and/or apps - Subscription-level settings, meant to change specific behaviors for each instance of an output/integration As a Firehose integration developer, it's up to *you* to define which settings should be account-level, and which should be configured on a per-integration-instance basis.

Parameters:

accountSettings - account-level settings to register for this integration

Returns:

returns this EventProcessingRegistration object for method chaining

See Also:

to register integration-specific settings for this integration

getConnectionSettings

public java.util.List<Setting> getConnectionSettings()

Gets the subscription-level settings registered by this integration. mParticle integrations may be configured with two different sets of settings: - Account-level settings, meant to be reused across platforms and/or apps - Subscription-level settings, meant to change specific behaviors for each instance of an output/integration As a Firehose integration developer, it's up to *you* to define which settings should be account-level, and which should be configured on a per-integration-instance basis.

Returns:

account settings registered by the integration

See Also:

to get the account-level settings registered for this integration

setConnectionSettings

public EventProcessingRegistration setConnectionSettings(java.util.List<Setting> connectionSettings)

Register the specific connection-level settings of this integration. mParticle integrations may be configured with two different sets of settings: - Account-level settings, meant to be reused across platforms and/or apps - Connection-level settings, meant to change specific behaviors for each instance of an output/integration As a Firehose integration developer, it's up to *you* to define which settings should be account-level, and which should be configured on a per-integration-instance basis.

Parameters:

connectionSettings - subscription-level settings to register for this integration

Returns:

returns this EventProcessingRegistration object for method chaining

See Also:

to register account-level settings for this integration

getSupportedEventTypes

public java.util.List<Event.Type> getSupportedEventTypes()

Returns:

requested event types

setSupportedEventTypes

public EventProcessingRegistration setSupportedEventTypes(java.util.List<Event.Type> supportedEventTypes)

Parameters:

supportedEventTypes - requested event types

Returns:

returns this EventProcessingRegistration object for method chaining

getMaxDataAgeHours

public int getMaxDataAgeHours()

Returns:

acceptable age of the incoming events

setMaxDataAgeHours

public EventProcessingRegistration setMaxDataAgeHours(int maxDataAgeHours)

Parameters:

maxDataAgeHours - acceptable age of the incoming events

Returns:

returns this EventProcessingRegistration object for method chaining

getSupportedRuntimeEnvironments

public java.util.List<RuntimeEnvironment.Type> getSupportedRuntimeEnvironments()

Returns:

supported mobile platforms

setSupportedRuntimeEnvironments

public EventProcessingRegistration setSupportedRuntimeEnvironments(java.util.List<RuntimeEnvironment.Type> supportedRuntimeEnvironments)

Parameters:

supportedRuntimeEnvironments - supported mobile platforms

Returns:

returns this EventProcessingRegistration object for method chaining

getSupportedSystemNotifications

public java.util.List<SystemNotification.Type> getSupportedSystemNotifications()

setSupportedSystemNotifications

public EventProcessingRegistration setSupportedSystemNotifications(java.util.List<SystemNotification.Type> supportedSystemNotifications)

getPushMessagingProviderId

public java.lang.String getPushMessagingProviderId()

Get the push messaging provider ID. The push messaging provider ID is required as a security measure to ensure that integrations only receive push receipts originally sent by their service. For example, the company Acme Inc., when sending a push notification to either Apple's push messaging service or Google GCM/FCM, must include a unique key, such as "acme-id", within the payload of the push message. In that case, Acme Inc., should register for a push messaging provider id of "acme-id". When forwarding push message receipts, the mParticle platform will only send push receipt messages that contain your push messaging provider id to your Firehose integration.

Returns:

setPushMessagingProviderId

public EventProcessingRegistration setPushMessagingProviderId(java.lang.String pushMessagingProviderId)

Set the push messaging provider ID. The push messaging provider ID is required as a security measure to ensure that integrations only receive push receipts originally sent by their service. For example, the company Acme Inc., when sending a push notification to either Apple's push messaging service or Google GCM/FCM, must include a unique key, such as "acme-id", within the payload of the push message. In that case, Acme Inc., should register for a push messaging provider id of "acme-id". When forwarding push message receipts, the mParticle platform will only send push receipt messages that contain your push messaging provider id to your Firehose integration.

Parameters:

pushMessagingProviderId -

Returns:

getAuthentication

public AuthenticationConfiguration getAuthentication()

Returns:

authentication

setAuthentication

public EventProcessingRegistration setAuthentication(AuthenticationConfiguration authentication)

Parameters:

authentication - event authentication settings

Returns:

this