org.springframework.yarn.launch.SimpleJvmExitCodeMapper.java Source code

Introduction

Here is the source code for org.springframework.yarn.launch.SimpleJvmExitCodeMapper.java

Source

/*
 * Copyright 2013 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.yarn.launch;

import java.util.HashMap;
import java.util.Map;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.springframework.util.ObjectUtils;

/**
 * An implementation of {@link ExitCodeMapper} that can be configured through a
 * map from batch exit codes (String) to integer results. Some default entries
 * are set up to recognise common cases. Any that are injected are added to
 * these.
 *
 * @author Janne Valkealahti
 *
 */
public class SimpleJvmExitCodeMapper implements ExitCodeMapper {

    protected static final Log log = LogFactory.getLog(SimpleJvmExitCodeMapper.class);

    private Map<String, Integer> mapping;

    public SimpleJvmExitCodeMapper() {
        mapping = new HashMap<String, Integer>();
        mapping.put(ExitStatus.COMPLETED.getExitCode(), JVM_EXITCODE_COMPLETED);
        mapping.put(ExitStatus.FAILED.getExitCode(), JVM_EXITCODE_GENERIC_ERROR);
        // TODO: possibly add yarn related mappings
    }

    public Map<String, Integer> getMapping() {
        return mapping;
    }

    /**
     * Supply the ExitCodeMappings
     *
     * @param exitCodeMap
     *            A set of mappings between environment specific exit codes and
     *            batch framework internal exit codes
     */
    public void setMapping(Map<String, Integer> exitCodeMap) {
        mapping.putAll(exitCodeMap);
    }

    /**
     * Get the operating system exit status that matches a certain Batch
     * Framework Exitcode
     *
     * @param exitCode
     *            The exitcode of the Batch Job as known by the Batch Framework
     * @return The exitCode of the Batch Job as known by the JVM
     */
    @Override
    public int intValue(String exitCode) {

        Integer statusCode = null;

        try {
            statusCode = mapping.get(exitCode);
        } catch (RuntimeException ex) {
            // We still need to return an exit code, even if there is an issue
            // with the mapper.
            log.fatal("Error mapping exit code, generic exit status returned.", ex);
        }

        return (statusCode != null) ? statusCode.intValue() : JVM_EXITCODE_GENERIC_ERROR;
    }

    @Override
    public int intValue(Boolean exitCode) {
        return ObjectUtils.nullSafeEquals(exitCode, true) ? JVM_EXITCODE_COMPLETED : JVM_EXITCODE_GENERIC_ERROR;
    }

}