com.vmware.operations.OperationAsyncBase Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of test-operations Show documentation
There is a newer version: 1.2.1
/*
 * Copyright (c) 2015-2018 VMware, Inc. All Rights Reserved.
 *
 * SPDX-License-Identifier: Apache-2.0
 *
 * 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 com.vmware.operations;

import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.ExecutorService;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Abstract base class for implementing operations that are naturally asynchronous,
 * based on futures.
 *
 * This base class implements the synchronous versions of execute, revert, and cleanup
 * in a standard way.  In particular, it attempts to unwrap any thrown ExecutionExceptions
 * for readability.
 */
public abstract class OperationAsyncBase extends OperationBase {
    private static final Logger logger = LoggerFactory.getLogger(OperationAsyncBase.class.getPackage().getName());

    private final ExecutorService executorService;

    protected OperationAsyncBase(ExecutorService executorService) {
        super();
        this.executorService = executorService;
    }

    /**
     * @see com.vmware.operations.Operation#execute()
     */
    @Override
    public final void execute() throws Exception {
        try {
            logger.debug("Executing {} [async]", toString());
            executeImpl().get();
        } catch (ExecutionException ex) {
            // Unwrap the exception if possible
            if (ex.getCause() instanceof Exception) {
                throw (Exception) ex.getCause();
            } else {
                throw ex;
            }
        }
    }

    @Override
    public final CompletableFuture executeAsync() {
        // Compose the validators onto the execution result
        return executeImpl()
                .thenComposeAsync((unused) -> validateExecution(executorService), executorService);
    }

    /**
     * @see com.vmware.operations.Operation#revert()
     */
    @Override
    public final void revert() throws Exception {
        try {
            logger.debug("Reverting {} [async]", toString());
            revertImpl().get();
        } catch (ExecutionException ex) {
            // Unwrap the exception if possible
            if (ex.getCause() instanceof Exception) {
                throw (Exception) ex.getCause();
            } else {
                throw ex;
            }
        }
    }

    @Override
    public final CompletableFuture revertAsync() {
        // Compose the validators onto the revert result
        return revertImpl().thenComposeAsync(
                (unused) -> validateRevert(executorService), executorService);
    }

    /**
     * @see com.vmware.operations.Operation#cleanup()
     */
    @Override
    public final void cleanup() {
        try {
            cleanupAsync().get();
        } catch (Throwable throwable) {
            // Swallow the error
            logger.info("Cleanup error {}", throwable.getMessage());
        }
    }

    /**
     * @see com.vmware.operations.Operation#cleanupAsync()
     */
    @Override
    public CompletableFuture cleanupAsync() {
        try {
            if (isExecuted()) {
                return revertAsync();
            }
        } catch (Exception ex) {
            // Catch all failures, and suppress them during cleanup
        }
        return CompletableFuture.completedFuture(null);
    }

    /**
     * @see com.vmware.operations.Operation#close()
     */
    @Override
    public void close() {
        try {
            cleanup();
        } catch (Exception ex) {
            // Catch all failures, and suppress them during cleanup
        }
    }

    /**
     * Asynchronous implementation of the operation.
     * @return A future that completes when the command is complete
     */
    public abstract CompletableFuture executeImpl();

    /**
     * Asynchronous revert implementation of the operation.
     * @return A future that completes when the command is reverted
     */
    public abstract CompletableFuture revertImpl();

    @Override
    public abstract String toString();
}