LogCollector.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.client.logging;

import org.kaaproject.kaa.client.logging.future.RecordFuture;
import org.kaaproject.kaa.schema.base.Log;

import javax.annotation.Generated;

/**
 * <p>Interface for a log collector.</p>
 *
 * <p>Adds new log record to a local storage.</p>
 *
 * <p>May be configured by setting user defined log record storage,
 * storage status, upload configuration and log upload strategy.
 * Each of them may be set independently of others.</p>
 *
 * <p>Reference implementation of each module used by default.</p>
 *
 * <p>This interface is auto-generated.</p>
 *
 * @see GenericLogCollector
 * @see BucketInfo
 */
@Generated("LogCollector.java.template")
public interface LogCollector extends GenericLogCollector {

  /**
   * Adds a log record to a log storage.
   *
   * @param record A log record object.
   * @return The {@link RecordFuture} object which allows tracking a delivery status of a log
   *         record.
   */
  RecordFuture addLogRecord(Log record);
}