EJBClientCluster (JBoss EJB Client 5.0.1.Final API)

java.lang.Object
- org.jboss.ejb.client.EJBClientCluster

```
public final class EJBClientCluster
extends Object
```
Information about a configured cluster on an Enterprise Bean client context.

Author:

David M. Lloyd

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class EJBClientCluster.Builder
A builder for a cluster definition.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`ClusterNodeSelector`	`getClusterNodeSelector()`	Get the cluster node selector to use.
`long`	`getConnectTimeoutMilliseconds()`	Get the connection timeout value in milliseconds.
`long`	`getMaximumConnectedNodes()`	Get the maximum number of nodes to connect.
`String`	`getName()`	Get the name of the configured cluster.
`org.wildfly.security.auth.client.AuthenticationConfiguration`	`getOverrideConfiguration()`	Get the overriding authentication configuration in use for nodes in this cluster, overriding the caller's default.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - getName
```
public String getName()
```
    Get the name of the configured cluster.
    
    Returns:
    
    the name of the configured cluster (not null)
  - getMaximumConnectedNodes
```
public long getMaximumConnectedNodes()
```
    Get the maximum number of nodes to connect.
    
    Returns:
    
    the maximum number of nodes to connect, or 0 for no limit
  - getConnectTimeoutMilliseconds
```
public long getConnectTimeoutMilliseconds()
```
    Get the connection timeout value in milliseconds. This value overrides any preconfigured values.
    
    Returns:
    
    the connection timeout (in milliseconds), 0 for no timeout, or -1 to use the context default
  - getClusterNodeSelector
```
public ClusterNodeSelector getClusterNodeSelector()
```
    Get the cluster node selector to use.
    
    Returns:
    
    the cluster node selector, or null if the default selector from the context should be used
  - getOverrideConfiguration
```
public org.wildfly.security.auth.client.AuthenticationConfiguration getOverrideConfiguration()
```
    Get the overriding authentication configuration in use for nodes in this cluster, overriding the caller's default.
    
    Returns:
    
    the authentication configuration to use or null to use the standard inherited authentication configuration
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object