FailurePolicy.java

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2010 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
 * or packager/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at packager/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

package org.glassfish.api.admin;

import org.glassfish.api.ActionReport;

/**
 * Defines the expected behaviour from the system when a supplemental command
 * (could be a local or remote invocation) fails to execute properly.
 *
 * @author Jerome Dochez 
 */
public enum FailurePolicy {
        
    /**
     * Ignore the failure, do not report to the user.
     */
    Ignore,
    /**
     * Warn the user of the failure, does not change the overall exit code
     * of the command execution.
     */
    Warn,
    /**
     * Return an error exit code to the user but do not rollback any successful
     * invocations of the commands.
     */
    Error;

    public static ActionReport.ExitCode applyFailurePolicy(FailurePolicy f, ActionReport.ExitCode e) {
        ActionReport.ExitCode result = ActionReport.ExitCode.FAILURE;
        if(f == null)
            f = Error;
        switch(f) {
            case Ignore :
                // If policy is to ignore, always return success
                result = ActionReport.ExitCode.SUCCESS;
                break;
            case Warn :
                // Switch failures to Warning; Leave Warnings and Successes as is
                if(e.equals(ActionReport.ExitCode.FAILURE))
                    result = ActionReport.ExitCode.WARNING;
                else
                    result = e;
                break;
            case Error :
                result = e;
                break;
        }
        return result;
    }
}