org.gridgain.client.GridClientDataAffinity Maven / Gradle / Ivy
/*
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.client;
import java.util.*;
/**
* Determines which node should be connected when operation on a key is requested.
*
* If implementation of data affinity implements {@link GridClientTopologyListener} interface as well,
* then affinity will be added to topology listeners on client start before first connection is established
* and will be removed after last connection is closed.
*/
public interface GridClientDataAffinity {
/**
* Gets primary affinity node for a key. In case of replicated cache all nodes are equal and can be
* considered primary, so it may return any node. In case of partitioned cache primary node is returned.
*
* @param key Key to get affinity for.
* @param nodes Nodes to choose from.
* @return Affinity nodes for the given partition.
*/
public GridClientNode node(Object key, Collection nodes);
}