/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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.apache.ignite.spi.failover;
import java.util.Collection;
import java.util.List;
import org.apache.ignite.IgniteCompute;
import org.apache.ignite.IgniteException;
import org.apache.ignite.cluster.ClusterNode;
import org.apache.ignite.compute.ComputeJobResult;
import org.apache.ignite.compute.ComputeTaskSession;
import org.apache.ignite.lang.IgniteCallable;
import org.apache.ignite.lang.IgniteRunnable;
import org.jetbrains.annotations.Nullable;
/**
* This interface defines a set of operations available to failover SPI
* one a given failed job.
*/
public interface FailoverContext {
/**
* Gets current task session.
*
* @return Grid task session.
*/
public ComputeTaskSession getTaskSession();
/**
* Gets failed result of job execution.
*
* @return Result of a failed job.
*/
public ComputeJobResult getJobResult();
/**
* Gets the next balanced node for failed job. Internally this method will
* delegate to load balancing SPI (see {@link org.apache.ignite.spi.loadbalancing.LoadBalancingSpi} to
* determine the optimal node for execution.
*
* @param top Topology to pick balanced node from.
* @return The next balanced node.
* @throws IgniteException If anything failed.
*/
public ClusterNode getBalancedNode(List<ClusterNode> top) throws IgniteException;
/**
* Gets partition for {@link IgniteCompute#affinityRun(Collection, int, IgniteRunnable)}
* and {@link IgniteCompute#affinityCall(Collection, int, IgniteCallable)}.
*
* @return Partition number.
*/
public int partition();
/**
* Returns affinity cache name {@link IgniteCompute#affinityRun(String, Object, IgniteRunnable)}
* and {@link IgniteCompute#affinityCall(String, Object, IgniteCallable)}.
*
* @return Cache name.
*/
@Nullable public String affinityCacheName();
}