org.apache.pulsar.io.mongodb.MongoConfig Maven / Gradle / Ivy

Go to download
/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.pulsar.io.mongodb;

import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.dataformat.yaml.YAMLFactory;
import com.google.common.base.Preconditions;
import java.io.File;
import java.io.IOException;
import java.io.Serializable;
import java.util.Map;
import lombok.Data;
import lombok.experimental.Accessors;
import org.apache.commons.lang3.StringUtils;
import org.apache.pulsar.io.core.annotations.FieldDoc;

/**
 * Configuration class for the MongoDB Connectors.
 */
@Data
@Accessors(chain = true)
public class MongoConfig implements Serializable {

    private static final long serialVersionUID = 1L;

    public static final int DEFAULT_BATCH_SIZE = 100;

    public static final long DEFAULT_BATCH_TIME_MS = 1000;

    @FieldDoc(
        required = true,
        defaultValue = "",
        help = "The uri of mongodb that the connector connects to"
                + " (see: https://docs.mongodb.com/manual/reference/connection-string/)"
    )
    private String mongoUri;

    @FieldDoc(
        defaultValue = "",
        help = "The database name to which the collection belongs and which must be watched for the source connector"
                + " (required for the sink connector)"
    )
    private String database;

    @FieldDoc(
        defaultValue = "",
        help = "The collection name where the messages are written or which is watched for the source connector"
                + " (required for the sink connector)"
    )
    private String collection;

    @FieldDoc(
        defaultValue = "" + DEFAULT_BATCH_SIZE,
        help = "The batch size of write to or read from the database"
    )
    private int batchSize = DEFAULT_BATCH_SIZE;

    @FieldDoc(
        defaultValue = "" + DEFAULT_BATCH_TIME_MS,
        help = "The batch operation interval in milliseconds")
    private long batchTimeMs = DEFAULT_BATCH_TIME_MS;


    public static MongoConfig load(String yamlFile) throws IOException {
        final ObjectMapper mapper = new ObjectMapper(new YAMLFactory());
        final MongoConfig cfg = mapper.readValue(new File(yamlFile), MongoConfig.class);

        return cfg;
    }

    public static MongoConfig load(Map map) throws IOException {
        final ObjectMapper mapper = new ObjectMapper();
        final MongoConfig cfg = mapper.readValue(new ObjectMapper().writeValueAsString(map), MongoConfig.class);

        return cfg;
    }

    public void validate(boolean dbRequired, boolean collectionRequired) {
        if (StringUtils.isEmpty(getMongoUri())
                || (dbRequired && StringUtils.isEmpty(getDatabase()))
                || (collectionRequired && StringUtils.isEmpty(getCollection()))) {

            throw new IllegalArgumentException("Required property not set.");
        }

        Preconditions.checkArgument(getBatchSize() > 0, "batchSize must be a positive integer.");
        Preconditions.checkArgument(getBatchTimeMs() > 0, "batchTimeMs must be a positive long.");
    }
}