com.yahoo.bullet.dsl.connector.BulletConnector Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of bullet-dsl Show documentation

This library provides a code-less way to get your data into Bullet without

The newest version!

/*
 *  Copyright 2018, Yahoo Inc.
 *  Licensed under the terms of the Apache License, Version 2.0.
 *  See the LICENSE file associated with the project for terms.
 */
package com.yahoo.bullet.dsl.connector;

import com.yahoo.bullet.common.BulletConfig;
import com.yahoo.bullet.dsl.BulletDSLConfig;
import com.yahoo.bullet.dsl.BulletDSLException;
import lombok.AccessLevel;
import lombok.Getter;

import java.io.Serializable;
import java.util.List;

/**
 * A BulletConnector is used to read objects from a data source such as Kafka or Pulsar. Connectors should extend this
 * class and expect configuration though {@link BulletDSLConfig}.
 */
public abstract class BulletConnector implements AutoCloseable, Serializable {

    private static final long serialVersionUID = -8131977808756978941L;

    // Exposed for testing
    @Getter(AccessLevel.PACKAGE)
    protected BulletDSLConfig config;

    /**
     * Constructor that takes a configuration containing the settings relevant for this connector.
     *
     * @param bulletConfig The {@link BulletConfig} to use.
     */
    public BulletConnector(BulletConfig bulletConfig) {
        this.config = new BulletDSLConfig(bulletConfig);
    }

    /**
     * Initializes the BulletConnector. Must be called before read().
     *
     * @throws BulletDSLException if there is an initialization error.
     */
    public abstract void initialize() throws BulletDSLException;

    /**
     * Reads and deserializes messages from a data source. A timeout duration can be set in the configuration.
     *
     * @return A list of deserialized objects.
     * @throws BulletDSLException if there is a connection or reading error.
     */
    public abstract List