From ecfc51ad5f403d92638c78635c54b1c8b1cdf03e Mon Sep 17 00:00:00 2001 From: lucasward Date: Tue, 18 Sep 2007 07:41:44 +0000 Subject: [PATCH] OPEN - issue BATCH-24: Provide exit code for job executed as a main method http://opensource.atlassian.com/projects/spring/browse/BATCH-24 --- .../batch/repeat/ExitCodeMapper.java | 42 +++++++++++++++++++ .../batch/repeat/ExitStatus.java | 4 +- 2 files changed, 44 insertions(+), 2 deletions(-) create mode 100644 infrastructure/src/main/java/org/springframework/batch/repeat/ExitCodeMapper.java diff --git a/infrastructure/src/main/java/org/springframework/batch/repeat/ExitCodeMapper.java b/infrastructure/src/main/java/org/springframework/batch/repeat/ExitCodeMapper.java new file mode 100644 index 000000000..320911313 --- /dev/null +++ b/infrastructure/src/main/java/org/springframework/batch/repeat/ExitCodeMapper.java @@ -0,0 +1,42 @@ +/* + * Copyright 2006-2007 the original author or authors. + * + * 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.springframework.batch.repeat; + +/** + * + * This interface should be implemented when an environment calling the batch famework has specific + * requirements regarding the returncodes returned by the BatchFramework. + * + * @param The type of returncode expected by the environment + * @author Stijn Maller + * @author Lucas Ward + */ +public interface ExitCodeMapper { + + String BATCH_EXITCODE_COMPLETED = ExitStatus.FINISHED.getExitCode(); + String BATCH_EXITCODE_GENERIC_ERROR = ExitStatus.FAILED.getExitCode(); + String BATCH_EXITCODE_NO_SUCH_JOBCONFIGURATION = "NO_SUCH_JOBCONFIGURATION"; + + /** + * Transform the exitcode known by the batchframework into an exitcode in the + * format of the calling environment. + * @param exitCode The exitcode which is used internally by the batch framework. + * @return The corresponding exitcode as known by the calling environment. + */ + public int getExitCode(String exitCode); + +} diff --git a/infrastructure/src/main/java/org/springframework/batch/repeat/ExitStatus.java b/infrastructure/src/main/java/org/springframework/batch/repeat/ExitStatus.java index a98014fca..922d47dc5 100644 --- a/infrastructure/src/main/java/org/springframework/batch/repeat/ExitStatus.java +++ b/infrastructure/src/main/java/org/springframework/batch/repeat/ExitStatus.java @@ -40,12 +40,12 @@ public class ExitStatus implements Serializable { /** * Convenient constant value representing finished processing. */ - public static ExitStatus FINISHED = new ExitStatus(false); + public static ExitStatus FINISHED = new ExitStatus(false, "COMPLETED"); /** * Convenient constant value representing finished processing with an error. */ - public static ExitStatus FAILED = new ExitStatus(false); + public static ExitStatus FAILED = new ExitStatus(false, "FAILED"); private final boolean continuable;