com.mparticle.sdk.model.registration.EventProcessingRegistration Maven / Gradle / Ivy

package com.mparticle.sdk.model.registration;

import com.fasterxml.jackson.annotation.JsonProperty;
import com.mparticle.sdk.model.eventprocessing.Event;
import com.mparticle.sdk.model.eventprocessing.RuntimeEnvironment;
import com.mparticle.sdk.model.eventprocessing.notification.SystemNotification;
import com.mparticle.sdk.model.registration.authentication.AuthenticationConfiguration;
import java.util.List;

/**
 * The EventProcessingRegistration object should be constructed by Firehose integrations that wish to function
 * as event-integrations within the mParticle platform. Upon receiving a {@link com.mparticle.sdk.model.registration.ModuleRegistrationRequest},
 * it's up to the Firehose integration to response with a populated {@link ModuleRegistrationResponse}.
 */
public final class EventProcessingRegistration {

    @JsonProperty("account_settings")
    private List accountSettings;

    @JsonProperty("event_connection_settings")
    private List connectionSettings;

    @JsonProperty("supported_event_types")
    private List supportedEventTypes;

    @JsonProperty("supported_runtime_environments")
    private List supportedRuntimeEnvironments;

    @JsonProperty("supported_system_notification_types")
    private List supportedSystemNotifications;

    @JsonProperty("max_data_age_hours")
    private int maxDataAgeHours = 24;

    @JsonProperty("push_messaging_provider_id")
    private String pushMessagingProviderId;

    @JsonProperty("authentication")
    private AuthenticationConfiguration authentication;

    /**
     * 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.
     *
     * @see #getConnectionSettings()  to get the integration-specific settings registered for this integration
     * @return account settings registered by the integration
     */
    public List getAccountSettings() {
        return 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.
     *
     * @see #setConnectionSettings(List)  to register integration-specific settings for this integration
     *
     * @param accountSettings account-level settings to register for this integration
     * @return returns this EventProcessingRegistration object for method chaining
     */
    public EventProcessingRegistration setAccountSettings(List accountSettings) {
        this.accountSettings = accountSettings;
        return this;
    }

    /**
     * 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.
     *
     * @see #getAccountSettings() to get the account-level settings registered for this integration
     * @return account settings registered by the integration
     */
    public List getConnectionSettings() {
        return 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.
     *
     * @see  #setAccountSettings(List) to register account-level settings for this integration
     *
     * @param connectionSettings subscription-level settings to register for this integration
     * @return returns this EventProcessingRegistration object for method chaining
     */
    public EventProcessingRegistration setConnectionSettings(List connectionSettings) {
        this.connectionSettings = connectionSettings;
        return this;
    }

    /**
     *
     * @return requested event types
     */
    public List getSupportedEventTypes() {
        return supportedEventTypes;
    }

    /**
     *
     * @param supportedEventTypes requested event types
     * @return returns this EventProcessingRegistration object for method chaining
     */
    public EventProcessingRegistration setSupportedEventTypes(List supportedEventTypes) {
        this.supportedEventTypes = supportedEventTypes;
        return this;
    }

    /**
     *
     * @return acceptable age of the incoming events
     */
    public int getMaxDataAgeHours() {
        return maxDataAgeHours;
    }

    /**
     *
     * @param maxDataAgeHours acceptable age of the incoming events
     * @return returns this EventProcessingRegistration object for method chaining
     */
    public EventProcessingRegistration setMaxDataAgeHours(int maxDataAgeHours) {
        this.maxDataAgeHours = maxDataAgeHours;
        return this;
    }

    /**
     *
     * @return supported mobile platforms
     */
    public List getSupportedRuntimeEnvironments() {
        return supportedRuntimeEnvironments;
    }

    /**
     *
     *
     *
     * @param supportedRuntimeEnvironments supported mobile platforms
     * @return returns this EventProcessingRegistration object for method chaining
     */
    public EventProcessingRegistration setSupportedRuntimeEnvironments(List supportedRuntimeEnvironments) {
        this.supportedRuntimeEnvironments = supportedRuntimeEnvironments;
        return this;
    }

    public List getSupportedSystemNotifications() {
        return supportedSystemNotifications;
    }

    public EventProcessingRegistration setSupportedSystemNotifications(List supportedSystemNotifications) {
        this.supportedSystemNotifications = supportedSystemNotifications;
        return this;
    }

    /**
     * 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.
     *
     * @return
     */
    public String getPushMessagingProviderId() {
        return 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.
     *
     * @param pushMessagingProviderId
     * @return
     */
    public EventProcessingRegistration setPushMessagingProviderId(String pushMessagingProviderId) {
        this.pushMessagingProviderId = pushMessagingProviderId;
        return this;
    }

    /**
     *
     * @return authentication
     */
    public AuthenticationConfiguration getAuthentication() { return authentication; }

    /**
     *
     * @param authentication event authentication settings
     * @return this
     */
    public EventProcessingRegistration setAuthentication(AuthenticationConfiguration authentication) {
        this.authentication = authentication;
        return this;
    }
}