org.apache.camel.component.iec60870.server.ServerOptions Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of camel-iec60870 Show documentation
Camel IEC 60870-5-104 support
There is a newer version: 4.9.0
/*
 * 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.camel.component.iec60870.server;

import java.util.Objects;

import org.apache.camel.component.iec60870.BaseOptions;
import org.apache.camel.spi.UriParam;
import org.apache.camel.spi.UriParams;
import org.eclipse.neoscada.protocol.iec60870.ProtocolOptions;
import org.eclipse.neoscada.protocol.iec60870.server.data.DataModuleOptions;

@UriParams
public class ServerOptions extends BaseOptions {

    /**
     * Data module options
     */
    @UriParam(javaType = "DataModuleOptions", label = "data")
    private DataModuleOptions.Builder dataModuleOptions;

    /**
     * A time period in "ms" the protocol layer will buffer change events in order to send out aggregated change
     * messages
     */
    @UriParam(label = "data")
    private Integer bufferingPeriod;

    // dummy for doc generation
    /**
     * Send booleans with timestamps
     */
    @UriParam(label = "data", defaultValue = "true")
    private boolean booleansWithTimestamp;

    // dummy for doc generation
    /**
     * Send floats with timestamps
     */
    @UriParam(label = "data", defaultValue = "true")
    private boolean floatsWithTimestamp;

    // dummy for doc generation
    /**
     * Number of spontaneous events to keep in the buffer.
     * 
     * When there are more than this number of spontaneous in events in the buffer, then events will be dropped in order
     * to maintain the buffer size.
     * 
     */
    @UriParam(label = "data", defaultValue = "10")
    private int spontaneousDuplicates;

    // dummy for doc generation
    /**
     * The period in "ms" between background transmission cycles.
     * 
     * If this is set to zero or less, background transmissions will be disabled.
     * 
     */
    @UriParam(label = "data", defaultValue = "60000")
    private int backgroundScanPeriod;

    public ServerOptions() {
        this.dataModuleOptions = new DataModuleOptions.Builder();
    }

    public ServerOptions(final ServerOptions other) {
        this(other.getProtocolOptions(), other.getDataModuleOptions());
    }

    public ServerOptions(final ProtocolOptions protocolOptions, final DataModuleOptions dataModuleOptions) {
        super(protocolOptions);

        Objects.requireNonNull(dataModuleOptions);

        this.dataModuleOptions = new DataModuleOptions.Builder(dataModuleOptions);
    }

    @Override
    public ServerOptions copy() {
        return new ServerOptions(this);
    }

    public void setDataModuleOptions(final DataModuleOptions dataModuleOptions) {
        Objects.requireNonNull(dataModuleOptions);

        this.dataModuleOptions = new DataModuleOptions.Builder(dataModuleOptions);
    }

    public void setBufferingPeriod(final Integer bufferingPeriod) {
        this.bufferingPeriod = bufferingPeriod;
    }

    public Integer getBufferingPeriod() {
        return this.bufferingPeriod;
    }

    // wrapper methods - DataModuleOptions

    public DataModuleOptions getDataModuleOptions() {
        return this.dataModuleOptions.build();
    }

    public void setBooleansWithTimestamp(final boolean booleansWithTimestamp) {
        this.dataModuleOptions.setBooleansWithTimestamp(booleansWithTimestamp);
    }

    public boolean isBooleansWithTimestamp() {
        return this.dataModuleOptions.isBooleansWithTimestamp();
    }

    public void setFloatsWithTimestamp(final boolean floatsWithTimestamp) {
        this.dataModuleOptions.setFloatsWithTimestamp(floatsWithTimestamp);
    }

    public boolean isFloatsWithTimestamp() {
        return this.dataModuleOptions.isFloatsWithTimestamp();
    }

    public void setSpontaneousDuplicates(final int spontaneousDuplicates) {
        this.dataModuleOptions.setSpontaneousDuplicates(spontaneousDuplicates);
    }

    public int getSpontaneousDuplicates() {
        return this.dataModuleOptions.getSpontaneousDuplicates();
    }

    public void setBackgroundScanPeriod(final int backgroundScanPeriod) {
        this.dataModuleOptions.setBackgroundScanPeriod(backgroundScanPeriod);
    }

    public int getBackgroundScanPeriod() {
        return this.dataModuleOptions.getBackgroundScanPeriod();
    }

}