## Uses of Class
org.apache.ignite.internal.client.GridClientException

Packages that use GridClientException
org.apache.ignite.internal.client
org.apache.ignite.internal.client.balancer
org.apache.ignite.internal.client.impl
org.apache.ignite.internal.client.impl.connection
org.apache.ignite.internal.client.router.impl
org.apache.ignite.internal.client.util

### Uses of GridClientException in org.apache.ignite.internal.client

Subclasses of GridClientException in org.apache.ignite.internal.client
`class` `GridClientAuthenticationException` Exception that represents client authentication failure.
`class` `GridClientClosedException` This exception is thrown whenever an attempt is made to use a closed client.
`class` `GridClientDisconnectedException` This exception is thrown when client has no Grid topology and (probably temporary) can't obtain it.
`class` `GridClientFutureTimeoutException` Client future timeout exception is thrown whenever any client waiting is timed out.
`class` `GridClientHandshakeException` This exception is thrown when a client handshake has failed.
`class` `GridServerUnreachableException` Thrown when none of the servers from configuration can be connected within a timeout.

Methods in org.apache.ignite.internal.client that return GridClientException
`GridClientException` GridClientBeforeNodeStart.`checkLastError()` Checking for an error.
`GridClientException` GridClient.`checkLastError()` Check for last topology errors.

Methods in org.apache.ignite.internal.client that throw GridClientException
`<K> UUID` GridClientData.`affinity(K key)` Gets affinity node ID for provided key.
`<R> R` GridClientCompute.`affinityExecute(String taskName, String cacheName, Object affKey, Object taskArg)` Executes task using cache affinity key for routing.
`<K,V> boolean` GridClientData.`append(K key, V val)` Append requested value to already cached one.
`<K,V> GridClientFuture<Boolean>` GridClientData.`appendAsync(K key, V val)` Append requested value to already cached one.
`GridClientDataMetrics` GridClientData.`cachedMetrics()` Tries to get metrics from local cache.
`<K,V> boolean` GridClientData.`cas(K key, V val1, V val2)` Sets entry value to `val1` if current value is `val2` with following conditions: If `val1` is `null` and `val2` is equal to current value, entry is removed from cache.
`String` GridClientClusterState.`clusterName()` Get the cluster name.
`Collection<GridClientNode>` GridClientCompute.`daemonNodes()` Gets most recently refreshed set of daemon nodes.
`GridClientData` GridClient.`data(String cacheName)` Gets a data projection for grid cache with name `cacheName`.
`<R> R` GridClientCompute.`execute(String taskName, Object taskArg)` Executes task on remote grid.
`GridClientData` GridClientData.`flagsOff(GridClientCacheFlag... flags)` Creates new client data object with disabled cache flags.
`GridClientData` GridClientData.`flagsOn(GridClientCacheFlag... flags)` Creates new client data object with enabled cache flags.
`R` GridClientFuture.`get()` Synchronously waits for completion and returns result.
`<K,V> V` GridClientData.`get(K key)` Gets value from cache on remote node.
`R` GridClientFuture.`get(long timeout, TimeUnit unit)` Synchronously waits for completion and returns result.
`<K,V> Map<K,V>` GridClientData.`getAll(Collection<K> keys)` Gets entries from cache on remote grid.
`UUID` GridClientClusterState.`id()` Unique identifier of cluster STATE command was sent to.
`void` GridClientConfiguration.`load(String prefix, Properties in)` Load client configuration from the properties map.
`GridClientDataMetrics` GridClientData.`metrics()` Fetches metrics for cache from remote grid.
`GridClientNode` GridClientCompute.`node(UUID id)` Gets cached node with given id from most recently refreshed topology.
`Collection<GridClientNode>` GridClientCompute.`nodes()` Gets most recently refreshed topology (only non-daemon nodes included).
`Collection<GridClientNode>` GridClientCompute.`nodes(Collection<UUID> ids)` Gets cached nodes for the given IDs based on most recently refreshed topology.
`Collection<GridClientNode>` GridClientCompute.`nodes(GridClientPredicate<GridClientNode> filter)` Gets all cached nodes that pass the filter.
`GridClientData` GridClientData.`pinNodes(GridClientNode node, GridClientNode... nodes)` Gets client data projection which will only contact specified remote grid node.
`<K,V> boolean` GridClientData.`prepend(K key, V val)` Prepend requested value to already cached one.
`<K,V> GridClientFuture<Boolean>` GridClientData.`prependAsync(K key, V val)` Prepend requested value to already cached one.
`GridClientCompute` GridClientCompute.`projection(Collection<GridClientNode> nodes)` Creates a projection that will communicate only with specified remote nodes.
`GridClientCompute` GridClientCompute.`projection(Collection<GridClientNode> nodes, GridClientLoadBalancer balancer)` Creates a projection that will communicate only with specified remote nodes.
`GridClientCompute` GridClientCompute.`projection(GridClientNode node)` Creates a projection that will communicate only with specified remote node.
`GridClientCompute` GridClientCompute.`projection(GridClientPredicate<? super GridClientNode> filter)` Creates a projection that will communicate only with nodes that are accepted by the passed filter.
`GridClientCompute` GridClientCompute.`projection(GridClientPredicate<? super GridClientNode> filter, GridClientLoadBalancer balancer)` Creates a projection that will communicate only with nodes that are accepted by the passed filter.
`<K,V> boolean` GridClientData.`put(K key, V val)` Puts value to cache on remote grid.
`<K,V> void` GridClientData.`putAll(Map<K,V> entries)` Puts entries to cache on remote grid.
`@Nullable GridClientNode` GridClientCompute.`refreshNode(String ip, boolean includeAttrs, boolean includeMetrics)` Refreshes and returns node by its IP address from remote grid.
`GridClientNode` GridClientCompute.`refreshNode(UUID id, boolean includeAttrs, boolean includeMetrics)` Refreshes and returns node by its ID from remote grid.
`List<GridClientNode>` GridClientCompute.`refreshTopology(boolean includeAttrs, boolean includeMetrics)` Refreshes and returns all nodes within topology.
`<K> boolean` GridClientData.`remove(K key)` Removes value from cache on remote node.
`<K> void` GridClientData.`removeAll(Collection<K> keys)` Removes entries from cache on remote node.
`<K,V> boolean` GridClientData.`replace(K key, V val)` Replaces value in cache on remote grid only if there was a `non-null` value associated with this key.
`static GridClient` GridClientFactory.`start(GridClientConfiguration cfg)` Starts a client with given configuration.
`static GridClientBeforeNodeStart` GridClientFactory.`startBeforeNodeStart(GridClientConfiguration cfg)` Starts a client before node start with given configuration.
`ClusterState` GridClientClusterState.`state()`
`void` GridClientClusterState.`state(ClusterState newState, boolean forceDeactivation)` Changes cluster state to `newState`.
`void` GridClientNodeStateBeforeStart.`stopWarmUp()` Stop warm-up.
`String` GridClientClusterState.`tag()` User-defined tag of cluster STATE command was sent to.

Constructors in org.apache.ignite.internal.client with parameters of type GridClientException
Constructor and Description
`GridClientDisconnectedException(String msg, GridClientException cause)` Creates exception with given message and cause.

Constructors in org.apache.ignite.internal.client that throw GridClientException
Constructor and Description
`GridClientConfiguration(Properties in)` Creates properties-based configuration based on passed in properties.
`GridClientConfiguration(String prefix, Properties in)` Creates properties-based configuration.

### Uses of GridClientException in org.apache.ignite.internal.client.balancer

Methods in org.apache.ignite.internal.client.balancer that throw GridClientException
`GridClientNode` GridClientLoadBalancer.`balancedNode(Collection<? extends GridClientNode> nodes)` Gets next node for executing client command.
`GridClientNode` GridClientRoundRobinBalancer.`balancedNode(Collection<? extends GridClientNode> nodes)` Gets next node for executing client command.

### Uses of GridClientException in org.apache.ignite.internal.client.impl

Methods in org.apache.ignite.internal.client.impl that return GridClientException
`GridClientException` GridClientImpl.`checkLastError()` Check for last topology errors.

Methods in org.apache.ignite.internal.client.impl that throw GridClientException
`<K> UUID` GridClientDataImpl.`affinity(K key)` Gets affinity node ID for provided key.
`<K,V> boolean` GridClientDataImpl.`append(K key, V val)` Append requested value to already cached one.
`<K,V> GridClientFuture<Boolean>` GridClientDataImpl.`appendAsync(K key, V val)` Append requested value to already cached one.
`GridClientDataMetrics` GridClientDataImpl.`cachedMetrics()` Tries to get metrics from local cache.
`<K,V> boolean` GridClientDataImpl.`cas(K key, V val1, V val2)` Sets entry value to `val1` if current value is `val2` with following conditions: If `val1` is `null` and `val2` is equal to current value, entry is removed from cache.
`String` GridClientClusterStateImpl.`clusterName()` Get the cluster name.
`GridClientConnection` GridClientImpl.`connection()` Getting a client connection without topology information.
`GridClientData` GridClientImpl.`data(@Nullable String cacheName)` Gets a data projection for grid cache with name `cacheName`.
`GridClientData` GridClientDataImpl.`flagsOff(GridClientCacheFlag... flags)` Creates new client data object with disabled cache flags.
`GridClientData` GridClientDataImpl.`flagsOn(GridClientCacheFlag... flags)` Creates new client data object with enabled cache flags.
`R` GridClientFutureAdapter.`get()` Synchronously waits for completion and returns result.
`<K,V> V` GridClientDataImpl.`get(K key)` Gets value from cache on remote node.
`R` GridClientFutureAdapter.`get(long timeout, TimeUnit unit)` Synchronously waits for completion and returns result.
`<K,V> Map<K,V>` GridClientDataImpl.`getAll(Collection<K> keys)` Gets entries from cache on remote grid.
`UUID` GridClientClusterStateImpl.`id()` Unique identifier of cluster STATE command was sent to.
`GridClientDataMetrics` GridClientDataImpl.`metrics()` Fetches metrics for cache from remote grid.
`GridClientConnectionManager` GridClientImpl.`newConnectionManager(@Nullable Byte marshId, boolean routerClient)`
`S` GridClientFutureCallback.`onComplete(GridClientFuture<R> fut)` Future callback to executed when listened future finishes.
`GridClientData` GridClientDataImpl.`pinNodes(GridClientNode node, GridClientNode... nodes)` Gets client data projection which will only contact specified remote grid node.
`<K,V> boolean` GridClientDataImpl.`prepend(K key, V val)` Prepend requested value to already cached one.
`<K,V> GridClientFuture<Boolean>` GridClientDataImpl.`prependAsync(K key, V val)` Prepend requested value to already cached one.
`<K,V> boolean` GridClientDataImpl.`put(K key, V val)` Puts value to cache on remote grid.
`<K,V> void` GridClientDataImpl.`putAll(Map<K,V> entries)` Puts entries to cache on remote grid.
`<K> boolean` GridClientDataImpl.`remove(K key)` Removes value from cache on remote node.
`<K> void` GridClientDataImpl.`removeAll(Collection<K> keys)` Removes entries from cache on remote node.
`<K,V> boolean` GridClientDataImpl.`replace(K key, V val)` Replaces value in cache on remote grid only if there was a `non-null` value associated with this key.
`ClusterState` GridClientClusterStateImpl.`state()`
`void` GridClientClusterStateImpl.`state(ClusterState newState, boolean forceDeactivation)` Changes cluster state to `newState`.
`void` GridClientNodeStateBeforeStartImpl.`stopWarmUp()` Stop warm-up.
`String` GridClientClusterStateImpl.`tag()` User-defined tag of cluster STATE command was sent to.

Constructors in org.apache.ignite.internal.client.impl that throw GridClientException
Constructor and Description
`GridClientImpl(UUID id, GridClientConfiguration cfg0, boolean routerClient, boolean beforeNodeStart)` Creates a new client based on a given configuration.

### Uses of GridClientException in org.apache.ignite.internal.client.impl.connection

Subclasses of GridClientException in org.apache.ignite.internal.client.impl.connection
`class` `GridClientConnectionResetException` This exception is thrown when ongoing packet should be sent, but network connection is broken.
`class` `GridConnectionIdleClosedException` This exception is thrown if client was closed by idle checker thread.

Methods in org.apache.ignite.internal.client.impl.connection that return GridClientException
`protected GridClientException` GridClientConnection.`getCloseReasonAsException(org.apache.ignite.internal.client.impl.connection.GridClientConnectionCloseReason reason, @Nullable Throwable cause)` Build appropriate exception from the given close reason.
`@Nullable GridClientException` GridClientTopology.`lastError()`

Methods in org.apache.ignite.internal.client.impl.connection with parameters of type GridClientException
`void` GridClientTopology.`fail(GridClientException cause)` Marks topology as failed.

Methods in org.apache.ignite.internal.client.impl.connection that throw GridClientException
`protected GridClientConnection` GridClientConnectionManagerAdapter.`connect(@Nullable UUID nodeId, InetSocketAddress addr)` Create new connection to specified server.
`GridClientConnection` GridClientConnectionManagerAdapter.`connection(Collection<InetSocketAddress> srvs)` Returns connection to node using given server addresses.
`GridClientConnection` GridClientConnectionManager.`connection(Collection<InetSocketAddress> srvs)` Returns connection to node using given server addresses.
`GridClientFutureAdapter<GridRouterRequest>` GridClientNioTcpConnection.`forwardMessage(Object msg)` Forwards a message in raw form to the connected node.
`abstract GridClientFutureAdapter<?>` GridClientConnection.`forwardMessage(Object body)` Forwards a message in raw form to the connected node.
`void` GridClientConnectionManagerAdapter.`init(Collection<InetSocketAddress> srvs)` Tries to open initial connection and fetch topology using given server addresses.
`void` GridClientConnectionManager.`init(Collection<InetSocketAddress> srvs)` Tries to open initial connection and fetch topology using given server addresses.
`protected void` GridClientConnectionManagerOsImpl.`init0()` Additional initialization.
`protected abstract void` GridClientConnectionManagerAdapter.`init0()` Additional initialization.
`GridClientFutureAdapter<?>` GridClientNioTcpConnection.`messageBeforeStart(Object msg)` Sending messages before node starts and getting a response to it.
`abstract GridClientFutureAdapter<?>` GridClientConnection.`messageBeforeStart(Object msg)` Sending messages before node starts and getting a response to it.
`GridClientNode` GridClientTopology.`node(UUID id)` Gets node from last saved topology snapshot by it's id.
`Collection<GridClientNodeImpl>` GridClientTopology.`nodes()` Gets full topology snapshot.
`Collection<GridClientNode>` GridClientTopology.`nodes(Iterable<UUID> ids)` Gets a collection of nodes from last saved topology snapshot by their ids.

Constructors in org.apache.ignite.internal.client.impl.connection that throw GridClientException
Constructor and Description
`GridClientConnectionManagerAdapter(UUID clientId, SSLContext sslCtx, GridClientConfiguration cfg, Collection<InetSocketAddress> routers, GridClientTopology top, @Nullable Byte marshId, boolean routerClient, boolean beforeNodeStart)`
`GridClientConnectionManagerOsImpl(UUID clientId, SSLContext sslCtx, GridClientConfiguration cfg, Collection<InetSocketAddress> routers, GridClientTopology top, Byte marshId, boolean routerClient, boolean beforeNodeStart)`

### Uses of GridClientException in org.apache.ignite.internal.client.router.impl

Methods in org.apache.ignite.internal.client.router.impl that return GridClientException
`GridClientException` GridRouterClientImpl.`checkLastError()` Check for last topology errors.

Methods in org.apache.ignite.internal.client.router.impl that throw GridClientException
`GridClientData` GridRouterClientImpl.`data(String cacheName)` Gets a data projection for grid cache with name `cacheName`.

### Uses of GridClientException in org.apache.ignite.internal.client.util

Methods in org.apache.ignite.internal.client.util that throw GridClientException
`static UUID` GridClientUtils.`checkFeatureSupportedByCluster(GridClient client, IgniteFeatures feature, boolean validateClientNodes, boolean failIfUnsupportedFound)` Checks that all cluster nodes support specified feature.

${current.year} Copyright © Apache Software Foundation

Follow @ApacheIgnite

Ignite Database and Caching Platform | : ver. 2.14.0
Release Date | : September 29 2022