org.gridgain.client.impl.connection.GridClientConnection 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.impl.connection;
import org.gridgain.client.*;
import org.gridgain.client.impl.*;
import org.jetbrains.annotations.*;
import javax.net.ssl.*;
import java.net.*;
import java.util.*;
import static org.gridgain.client.impl.connection.GridClientConnectionCloseReason.*;
/**
* Facade for all possible network communications between client and server. Introduced to hide
* protocol implementation (TCP, HTTP) from client code.
*/
public abstract class GridClientConnection {
/** Topology */
protected GridClientTopology top;
/** Client id. */
protected final UUID clientId;
/** Server address this connection connected to */
private InetSocketAddress srvAddr;
/** SSL context to use if ssl is enabled. */
private SSLContext sslCtx;
/** Client credentials. */
private Object cred;
/**
* Creates a facade.
*
* @param clientId Client identifier.
* @param srvAddr Server address this connection connected to.
* @param sslCtx SSL context to use if SSL is enabled, {@code null} otherwise.
* @param top Topology.
* @param cred Client credentials.
*/
protected GridClientConnection(UUID clientId, InetSocketAddress srvAddr, SSLContext sslCtx, GridClientTopology top,
Object cred) {
assert top != null;
this.clientId = clientId;
this.srvAddr = srvAddr;
this.top = top;
this.sslCtx = sslCtx;
this.cred = cred;
}
/**
* Closes connection facade.
*
* @param reason Why this connection should be closed.
* @param waitCompletion If {@code true} this method will wait until all pending requests are handled.
*/
abstract void close(GridClientConnectionCloseReason reason, boolean waitCompletion);
/**
* Closes connection facade if no requests are in progress.
*
* @param idleTimeout Idle timeout.
* @return {@code True} if no requests were in progress and client was closed, {@code false} otherwise.
*/
abstract boolean closeIfIdle(long idleTimeout);
/**
* Gets server address this connection connected to.
*
* @return Server address this connection connected to.
*/
public InetSocketAddress serverAddress() {
return srvAddr;
}
/**
* Encodes cache flags to bit map.
*
* @param flagSet Set of flags to be encoded.
* @return Bit map.
*/
public static int encodeCacheFlags(Collection flagSet) {
int bits = 0;
if (flagSet.contains(GridClientCacheFlag.SKIP_STORE))
bits |= 1;
if (flagSet.contains(GridClientCacheFlag.SKIP_SWAP))
bits |= 1 << 1;
if (flagSet.contains(GridClientCacheFlag.SYNC_COMMIT))
bits |= 1 << 2;
if (flagSet.contains(GridClientCacheFlag.INVALIDATE))
bits |= 1 << 4;
return bits;
}
/**
* Puts key-value pair into cache.
*
* @param cacheName Cache name.
* @param key Key.
* @param val Value.
* @param flags Cache flags to be enabled.
* @param destNodeId Destination node ID.
* @return If value was actually put.
* @throws GridClientConnectionResetException In case of error.
* @throws GridClientClosedException If client was manually closed before request was sent over network.
*/
public GridClientFutureAdapter cachePut(String cacheName, K key, V val,
Set flags, UUID destNodeId)
throws GridClientConnectionResetException, GridClientClosedException {
return cachePutAll(cacheName, Collections.singletonMap(key, val), flags, destNodeId);
}
/**
* Gets entry from the cache for specified key.
*
* @param cacheName Cache name.
* @param key Key.
* @param flags Cache flags to be enabled.
* @param destNodeId Destination node ID.
* @return Value.
* @throws GridClientConnectionResetException In case of error.
* @throws GridClientClosedException If client was manually closed before request was sent over network.
*/
public GridClientFutureAdapter cacheGet(String cacheName, final K key, Set flags,
UUID destNodeId) throws GridClientConnectionResetException, GridClientClosedException {
final GridClientFutureAdapter> res = cacheGetAll(cacheName, Collections.singleton(key), flags,
destNodeId);
return res.chain(new GridClientFutureCallback, V>() {
@Override public V onComplete(GridClientFuture> fut) throws GridClientException {
return fut.get().get(key);
}
});
}
/**
* Removes entry from the cache for specified key.
*
* @param cacheName Cache name.
* @param key Key.
* @param flags Cache flags to be enabled.
* @param destNodeId Destination node ID.
* @return Whether entry was actually removed.
* @throws GridClientConnectionResetException In case of error.
* @throws GridClientClosedException If client was manually closed before request was sent over network.
*/
public abstract GridClientFutureAdapter cacheRemove(String cacheName, K key,
Set flags, UUID destNodeId)
throws GridClientConnectionResetException, GridClientClosedException;
/**
* Puts bundle of entries into cache.
*
* @param cacheName Cache name.
* @param entries Entries.
* @param flags Cache flags to be enabled.
* @param destNodeId Destination node ID.
* @return {@code True} if map contained more then one entry or if put succeeded in case of one entry,
* {@code false} otherwise
* @throws GridClientConnectionResetException In case of error.
* @throws GridClientClosedException If client was manually closed before request was sent over network.
*/
public abstract GridClientFutureAdapter cachePutAll(String cacheName, Map entries,
Set flags, UUID destNodeId)
throws GridClientConnectionResetException, GridClientClosedException;
/**
* Gets bundle of entries for specified keys from the cache.
*
* @param cacheName Cache name.
* @param keys Keys.
* @param flags Cache flags to be enabled.
* @param destNodeId Destination node ID.
* @return Entries.
* @throws GridClientConnectionResetException In case of error.
* @throws GridClientClosedException If client was manually closed before request was sent over network.
*/
public abstract GridClientFutureAdapter> cacheGetAll(String cacheName, Collection keys,
Set flags, UUID destNodeId)
throws GridClientConnectionResetException, GridClientClosedException;
/**
* Removes bundle of entries for specified keys from the cache.
*
* @param cacheName Cache name.
* @param keys Keys.
* @param flags Cache flags to be enabled.
* @param destNodeId Destination node ID.
* @return Whether entries were actually removed
* @throws GridClientConnectionResetException In case of error.
* @throws GridClientClosedException If client was manually closed before request was sent over network.
*/
public abstract GridClientFutureAdapter cacheRemoveAll(String cacheName, Collection keys,
Set flags, UUID destNodeId)
throws GridClientConnectionResetException, GridClientClosedException;
/**
* Replace key-value pair in cache if already exist.
*
* @param cacheName Cache name.
* @param key Key.
* @param val Value.
* @param flags Cache flags to be enabled.
* @param destNodeId Destination node ID.
* @return Whether value was actually replaced.
* @throws GridClientConnectionResetException In case of error.
* @throws GridClientClosedException If client was manually closed before request was sent over network.
*/
public abstract GridClientFutureAdapter cacheReplace(String cacheName, K key, V val,
Set flags, UUID destNodeId)
throws GridClientConnectionResetException, GridClientClosedException;
/**
*
* New value Actual/old value Behaviour null null Remove entry for key. newVal null Put newVal into cache if such key doesn't exist. null oldVal Remove if actual value oldVal is equals to value in cache. newVal oldVal Replace if actual value oldVal is equals to value in cache.
*
* @param cacheName Cache name.
* @param key Key.
* @param newVal Value 1.
* @param oldVal Value 2.
* @param flags Cache flags to be enabled.
* @param destNodeId Destination node ID.
* @return Whether new value was actually set.
* @throws GridClientConnectionResetException In case of error.
* @throws GridClientClosedException If client was manually closed before request was sent over network.
*/
public abstract GridClientFutureAdapter cacheCompareAndSet(String cacheName, K key, V newVal,
V oldVal, Set flags, UUID destNodeId)
throws GridClientConnectionResetException, GridClientClosedException;
/**
* Gets cache metrics for the key.
*
* @param cacheName Cache name.
* @param destNodeId Destination node ID.
* @return Metrics.
* @throws GridClientConnectionResetException In case of error.
* @throws GridClientClosedException If client was manually closed before request was sent over network.
*/
public abstract GridClientFutureAdapter cacheMetrics(String cacheName, UUID destNodeId)
throws GridClientConnectionResetException, GridClientClosedException;
/**
* Append requested value to already cached one.
*
* @param cacheName Cache name.
* @param key Key.
* @param val Value to append to the cached one.
* @param flags Cache flags to be enabled.
* @param destNodeId Destination node ID.
* @return Whether new value was actually set.
* @throws GridClientConnectionResetException In case of error.
* @throws GridClientClosedException If client was manually closed before request was sent over network.
*/
public abstract GridClientFutureAdapter cacheAppend(String cacheName, K key, V val,
Set flags, UUID destNodeId)
throws GridClientConnectionResetException, GridClientClosedException;
/**
* Prepend requested value to already cached one.
*
* @param cacheName Cache name.
* @param key Key.
* @param val Value to prepend to the cached one.
* @param flags Cache flags to be enabled.
* @param destNodeId Destination node ID.
* @return Whether new value was actually set.
* @throws GridClientConnectionResetException In case of error.
* @throws GridClientClosedException If client was manually closed before request was sent over network.
*/
public abstract GridClientFutureAdapter cachePrepend(String cacheName, K key, V val,
Set flags, UUID destNodeId)
throws GridClientConnectionResetException, GridClientClosedException;
/**
* Execute task in the grid.
*
* @param taskName Task name.
* @param arg Task argument.
* @param destNodeId Destination node ID.
* @return Task execution result.
* @throws GridClientConnectionResetException In case of error.
* @throws GridClientClosedException If client was manually closed before request was sent over network.
*/
public abstract GridClientFutureAdapter execute(String taskName, Object arg, UUID destNodeId)
throws GridClientConnectionResetException, GridClientClosedException;
/**
* Gets node by node ID.
*
* @param id Node ID.
* @param inclAttrs Whether to include attributes.
* @param inclMetrics Whether to include metrics.
* @param destNodeId Destination node ID.
* @return Node.
* @throws GridClientConnectionResetException In case of error.
* @throws GridClientClosedException If client was manually closed before request was sent over network.
*/
public abstract GridClientFuture node(UUID id, boolean inclAttrs, boolean inclMetrics,
UUID destNodeId) throws GridClientConnectionResetException, GridClientClosedException;
/**
* Gets node by node IP.
*
* @param ipAddr IP address.
* @param inclAttrs Whether to include attributes.
* @param includeMetrics Whether to include metrics.
* @param destNodeId Destination node ID.
* @return Node.
* @throws GridClientConnectionResetException In case of error.
* @throws GridClientClosedException If client was manually closed before request was sent over network.
*/
public abstract GridClientFuture node(String ipAddr, boolean inclAttrs,
boolean includeMetrics, UUID destNodeId)
throws GridClientConnectionResetException, GridClientClosedException;
/**
* Gets grid topology nodes.
*
* @param inclAttrs Whether to include attributes.
* @param inclMetrics Whether to include metrics.
* @param destNodeId Destination node ID.
* @return Nodes.
* @throws GridClientConnectionResetException In case of error.
* @throws GridClientClosedException If client was manually closed before request was sent over network.
*/
public abstract GridClientFuture> topology(boolean inclAttrs, boolean inclMetrics,
@Nullable UUID destNodeId) throws GridClientConnectionResetException, GridClientClosedException;
/**
* Gets log entries.
*
* @param path Log file path. If {@code null}, then default path will be used.
* @param fromLine Index of start line that should be retrieved.
* @param toLine Index of end line that should be retrieved.
* @param destNodeId Destination node ID.
* @return Log file contents.
* @throws GridClientConnectionResetException In case of error.
* @throws GridClientClosedException If client was manually closed before request was sent over network.
*/
public abstract GridClientFuture> log(@Nullable String path, int fromLine, int toLine, UUID destNodeId)
throws GridClientConnectionResetException, GridClientClosedException;
/**
* Forwards a message in raw form to the connected node. This method supposed to be used only inside router.
* The exact types of acceptable arguments and return values depend on connection implementation.
*
* @param body A raw message to send.
* @return Future holding server's response.
* @throws GridClientException If message forwarding failed.
*/
public abstract GridClientFutureAdapter forwardMessage(Object body) throws GridClientException;
/**
* Gets SSLContext of this client connection.
*
* @return {@link SSLContext} instance.
*/
protected SSLContext sslContext() {
return sslCtx;
}
/**
* Returns credentials for this client connection.
*
* @return Credentials.
*/
protected Object credentials() {
return cred;
}
/**
* Safely gets long value by given key.
*
* @param map Map to get value from.
* @param key Metrics name.
* @return Value or -1, if not found.
*/
protected long safeLong(Map map, String key) {
Number val = map.get(key);
if (val == null)
return -1;
return val.longValue();
}
/**
* Safely gets double value by given key.
*
* @param map Map to get value from.
* @param key Metrics name.
* @return Value or -1, if not found.
*/
protected double safeDouble(Map map, String key) {
Number val = map.get(key);
if (val == null)
return -1;
return val.doubleValue();
}
/**
* Converts metrics map to metrics object.
*
* @param metricsMap Map to convert.
* @return Metrics object.
*/
protected GridClientDataMetrics metricsMapToMetrics(Map metricsMap) {
GridClientDataMetricsAdapter metrics = new GridClientDataMetricsAdapter();
metrics.createTime(safeLong(metricsMap, "createTime"));
metrics.readTime(safeLong(metricsMap, "readTime"));
metrics.writeTime(safeLong(metricsMap, "writeTime"));
metrics.reads((int)safeLong(metricsMap, "reads"));
metrics.writes((int)safeLong(metricsMap, "writes"));
metrics.hits((int)safeLong(metricsMap, "hits"));
metrics.misses((int)safeLong(metricsMap, "misses"));
return metrics;
}
/**
* Check if this connection was closed and throws appropriate exception.
* This method should be used for synchronous connection state check.
*
* @param reason Close reason.
* @throws GridConnectionIdleClosedException If connection was closed as idle.
* @throws GridClientClosedException If client was closed by by external call.
* @throws GridClientConnectionResetException If connection was closed because of failure.
*/
protected void checkClosed(GridClientConnectionCloseReason reason)
throws GridConnectionIdleClosedException, GridClientConnectionResetException, GridClientClosedException {
if (reason == CONN_IDLE)
throw new GridConnectionIdleClosedException("Connection was closed by idle thread (will " +
"reconnect): " + serverAddress());
if (reason == FAILED)
throw new GridClientConnectionResetException("Failed to perform request (connection failed before " +
"message is sent): " + serverAddress());
if (reason == CLIENT_CLOSED)
throw new GridClientClosedException("Failed to perform request (connection was closed before " +
"message is sent): " + serverAddress());
}
/**
* Build appropriate exception from the given close reason.
* This method should be used as a factory for exception to finish futures asynchronously.
*
* @param reason Close reason.
* @param cause Cause of connection close, or {@code null} in case of regular close.
* @return Exception.
*/
protected GridClientException getCloseReasonAsException(GridClientConnectionCloseReason reason,
@Nullable Throwable cause) {
if (reason == CONN_IDLE)
return new GridConnectionIdleClosedException("Connection was closed by idle thread: " + serverAddress());
if (reason == FAILED)
return new GridClientConnectionResetException("Failed to perform request (connection failed): " +
serverAddress(), cause);
if (reason == CLIENT_CLOSED)
return new GridClientClosedException("Failed to perform request (client was closed): " + serverAddress());
return null;
}
/**
* @param reason Close reason.
* @param cause Cause of connection close, or {@code null} in case of regular close.
* @return Description of close reason for logging purpose.
*/
protected String getCloseReasonMessage(GridClientConnectionCloseReason reason, @Nullable Throwable cause) {
if (reason == CONN_IDLE)
return "Connection was closed by idle thread";
if (reason == FAILED)
return cause != null ? "Connection failed, cause: " + cause.getMessage() : "Connection failed";
if (reason == CLIENT_CLOSED)
return "Client was closed";
return null;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy