org.gridgain.grid.compute.GridComputeJobBeforeFailover Maven / Gradle / Ivy

Go to download
/* 
 Copyright (C) GridGain Systems. All Rights Reserved.
 
 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.gridgain.grid.compute;

import org.gridgain.grid.spi.failover.*;

import java.lang.annotation.*;

/**
 * This annotation allows to call a method right before job is submitted to
 * {@link GridFailoverSpi}. In this method job can re-create necessary state that was
 * cleared, for example, in method with {@link GridComputeJobAfterSend} annotation.
 * 
 * This annotation can be applied to methods of {@link GridComputeJob} instances only. It is
 * invoked on the caller node after remote execution has failed and before the
 * job gets failed over to another node.
 * 

 * Example:
 * 
 * public class MyGridJob implements GridComputeJob {
 *     ...
 *     @GridComputeJobBeforeFailover
 *     public void onJobBeforeFailover() {
 *          ...
 *     }
 *     ...
 * }
 * 
 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD})
public @interface GridComputeJobBeforeFailover {
    // No-op.
}