001/*
002 * Copyright 2006-2013 the original author or authors.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *      https://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.springframework.batch.core;
017
018/**
019 * Provide callbacks at specific points in the lifecycle of a {@link Job}.
020 * Implementations can be stateful if they are careful to either ensure thread
021 * safety, or to use one instance of a listener per job, assuming that job
022 * instances themselves are not used by more than one thread.
023 *
024 * @author Dave Syer
025 *
026 */
027public interface JobExecutionListener {
028
029        /**
030         * Callback before a job executes.
031         *
032         * @param jobExecution the current {@link JobExecution}
033         */
034        void beforeJob(JobExecution jobExecution);
035
036        /**
037         * Callback after completion of a job. Called after both both successful and
038         * failed executions. To perform logic on a particular status, use
039         * "if (jobExecution.getStatus() == BatchStatus.X)".
040         *
041         * @param jobExecution the current {@link JobExecution}
042         */
043        void afterJob(JobExecution jobExecution);
044
045}