TransportConfig.java

/*
 * Copyright 2014-2016 CyberVision, Inc.
 *
 * Licensed 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.kaaproject.kaa.server.transport;

import org.apache.avro.Schema;

/**
 * Represents configuration of particular {@link Transport}.
 *
 * @author Andrew Shvayka
 */
public interface TransportConfig {

  /**
   * Returns the transport id. The transport id must be unique.
   *
   * @return the transport id
   */
  int getId();

  /**
   * Returns the transport name. There is no strict rule for this
   * name to be unique.
   *
   * @return the transport name
   */
  String getName();

  /**
   * Returns the class name of the {@link Transport} implementation..
   *
   * @return the class name of the {@link Transport} implementation
   */
  String getTransportClass();

  /**
   * Returns the avro schema of the {@link Transport} configuration.
   *
   * @return the avro schema of the {@link Transport} configuration
   */
  Schema getConfigSchema();

  /**
   * Returns the configuration file name. This configuration file may
   * be used by {@link TransportService} to initialize and configure
   * the corresponding {@link Transport}
   *
   * @return the configuration file name
   */
  String getConfigFileName();

}