FlumeEventBuilder.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.appenders.flume.appender;

import org.apache.flume.Event;
import org.kaaproject.kaa.server.appenders.flume.config.gen.FlumeConfig;
import org.kaaproject.kaa.server.common.log.shared.appender.LogEvent;
import org.kaaproject.kaa.server.common.log.shared.appender.LogEventPack;
import org.kaaproject.kaa.server.common.log.shared.appender.LogSchema;
import org.kaaproject.kaa.server.common.log.shared.appender.data.ProfileInfo;
import org.kaaproject.kaa.server.common.log.shared.avro.gen.RecordHeader;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.util.List;


public abstract class FlumeEventBuilder {

  private static final Logger LOG = LoggerFactory.getLogger(FlumeEventBuilder.class);

  public abstract void init(FlumeConfig configuration);

  public abstract List<Event> generateEvents(String appToken, LogSchema schema,
                                             List<LogEvent> logEvents,
                                             ProfileInfo clientProfile,
                                             ProfileInfo serverProfile, RecordHeader header);

  /**
   * This method generate flume events from own data structure <code>LogEventPack</code>.
   *
   * @param eventPack the event pack
   * @param header    the record header
   * @param appToken  the application token
   * @return the list of build flume events
   */
  public List<Event> generateEvents(LogEventPack eventPack, RecordHeader header, String appToken) {
    LOG.debug("Build flume event object from LogEventPack object {}", eventPack);
    List<Event> events = null;
    LogSchema schema = eventPack.getLogSchema();
    if (schema != null) {
      List<LogEvent> logEvents = eventPack.getEvents();
      ProfileInfo clientProfile = eventPack.getClientProfile();
      ProfileInfo serverProfile = eventPack.getServerProfile();
      if (logEvents != null && !logEvents.isEmpty()) {
        events = generateEvents(appToken, schema, logEvents, clientProfile, serverProfile, header);
      } else {
        LOG.warn("Can't build flume events. Empty Log events.");
      }
    } else {
      LOG.warn("Can't build flume events. LogSchema object is null.");
    }
    return events;
  }

}