javax.batch.api.SplitCollector Maven / Gradle / Ivy
/*
* Copyright 2012 International Business Machines Corp.
*
* See the NOTICE file distributed with this work for additional information
* regarding copyright ownership. 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 javax.batch.api;
import java.io.Externalizable;
/**
* SplitCollector provides a way to send data from individual split flows with
* to single point of control belonging to the parent split. The SplitAnalyzer
* is used to receive and process this data.
*/
public interface SplitCollector {
/**
* The collectSplitData method receives control when a split flow ends. This
* method receives control on each thread processing a split flow. The
* FlowContext is in scope when this method receives control.
*
* @return payload to send to SplitAnalyzer.
* @throws Exception
* is thrown if an error occurs.
*/
public Externalizable collectSplitData() throws Exception;
}