org.jbpm.persistence.api.integration.EventEmitter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jbpm-persistence-api Show documentation
jBPM Persistence API
The newest version!
/*
 * Copyright 2017 Red Hat, Inc. and/or its affiliates.
 *
 * 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.jbpm.persistence.api.integration;

import java.util.Collection;

/**
 * Emitter is the main integration point with external systems.
 * It will be called first to get implementation of the EventCollection
 * next depending on the PersistenceEventManager implementation will provide the 
 * actual events on three phases:
 * 
 * 
 *  deliver - is the first phase that gives complete view of events before persistence is completed
 *  apply - is kind of confirmation that persistence is completed and events can be safely transferred
 *  drop - is kind of rejection that persistence failed and events should be discarded
 * 
 *
 */
public interface EventEmitter extends AutoCloseable {

    /**
     * Invoked just before persistence layer is completed - e.g. beforeCompletion in JTA transaction
     * @param data complete view of events
     */
    void deliver(Collection> data);
    
    /**
     * Indicates that given collection of events can be safely transferred to external systems
     * @param data complete view of events
     */
    void apply(Collection> data);
    
    /**
     * Indicates that given collection of events should be discarded
     * @param data complete view of events
     */
    void drop(Collection> data);
    
    /**
     * Returns new instance of EventCollection to be used while collecting events
     * @return instance of EventCollection implementation
     */
    EventCollection newCollection();
    
    /**
     * Closes any resources used by emitter to interact with external system
     */
    void close();
}