apps/kafka-integration/api/src/main/java/org/onosproject/kafkaintegration/api/KafkaEventStorageService.java

/*
 * Copyright 2016-present Open Networking Foundation
 *
 * 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.onosproject.kafkaintegration.api;

import org.onosproject.kafkaintegration.api.dto.OnosEvent;

/**
 * APIs to insert and delete into a local store. This store is used to keep
 * track of events that are being published.
 */
public interface KafkaEventStorageService {

    /**
     * Inserts the Onos Event into Distributed Work Queue.
     *
     * @param e the ONOS Event
     */
    void publishEvent(OnosEvent event);

    /**
     * Removes the Onos Event from the Distributed Work Queue.
     *
     * @return the Onos Event
     */
    OnosEvent consumeEvent();
}