001    /*
002     * Licensed to the Apache Software Foundation (ASF) under one or more
003     * contributor license agreements.  See the NOTICE file distributed with
004     * this work for additional information regarding copyright ownership.
005     * The ASF licenses this file to You under the Apache License, Version 2.0
006     * (the "License"); you may not use this file except in compliance with
007     * the License.  You may obtain a copy of the License at
008     *
009     *     http://www.apache.org/licenses/LICENSE-2.0
010     *
011     * Unless required by applicable law or agreed to in writing, software
012     * distributed under the License is distributed on an "AS IS" BASIS,
013     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014     * See the License for the specific language governing permissions and
015     * limitations under the License.
016     */
017    
018    package org.apache.commons.pipeline;
019    
020    /**
021     * This interface specifies a job or set of tasks that are to be run at a 
022     * well-specified points in the pipeline lifecycle. It is intended to be a
023     * means by which third-party plugins can be added to the pipeline framework.
024     */
025    public interface PipelineLifecycleJob {
026        
027        /**
028         * This is called by the pipeline engine once the pipeline is fully configured,
029         * just prior to stage driver start.
030         */
031        public void onStart(Pipeline pipeline);
032        
033        /**
034         * This is called by the pipeline engine after all data processing has completed.
035         */
036        public void onFinish(Pipeline pipeline);
037        
038    }