Package org.apache.geode.cache.client

Interface PoolFactory

public interface PoolFactory
This interface provides for the configuration and creation of instances of Pool.

Every pool needs to have at least one locator or server added to it. Locators should be added unless direct connections to cache servers are desired.

The setter methods are used to specify non-default values for the other pool properties.

Once it is configured create(java.lang.String) will produce an instance.

The factory can be restored to its default configuration by calling reset().

Instances of this interface can be created by calling PoolManager.createFactory().

If a subscription is going to be made using a pool then subscriptions must be enabled on the pool. Subscriptions are made using these APIs:

Since:
GemFire 5.7

  • Field Details

    • DEFAULT_SOCKET_CONNECT_TIMEOUT

      static final int DEFAULT_SOCKET_CONNECT_TIMEOUT
      The default amount of time, in milliseconds, socket timeout when the client connects to the servers/locators.

      Current value: 59000.

      See Also:

    • DEFAULT_FREE_CONNECTION_TIMEOUT

      static final int DEFAULT_FREE_CONNECTION_TIMEOUT
      The default amount of time, in milliseconds, which we will wait for a free connection if max connections is set and all of the connections are in use.

      Current value: 10000.

      See Also:

    • DEFAULT_SERVER_CONNECTION_TIMEOUT

      static final int DEFAULT_SERVER_CONNECTION_TIMEOUT
      The default amount of time, in milliseconds, which we will wait for a server connection if max connections is set and there is no free connections towards designated server.

      Current value: 0.

      See Also:

    • DEFAULT_LOAD_CONDITIONING_INTERVAL

      static final int DEFAULT_LOAD_CONDITIONING_INTERVAL
      The default interval in which the pool will check to see if a connection to a given server should be moved to a different server to improve the load balance.

      Current value: 300,000 (which is 5 minutes).

      See Also:

    • DEFAULT_SOCKET_BUFFER_SIZE

      static final int DEFAULT_SOCKET_BUFFER_SIZE
      Default size in bytes of the socket buffer on each connection established.

      Current value: 32768.

      See Also:

    • DEFAULT_READ_TIMEOUT

      static final int DEFAULT_READ_TIMEOUT
      The default amount of time, in milliseconds, to wait for a response from a server

      Current value: 10000.

      See Also:

    • DEFAULT_MIN_CONNECTIONS

      static final int DEFAULT_MIN_CONNECTIONS
      The default number of connections to initially create

      Current value: 1.

      See Also:

    • DEFAULT_MAX_CONNECTIONS

      static final int DEFAULT_MAX_CONNECTIONS
      The default maximum number of connections to create

      Current value: -1.

      See Also:

    • DEFAULT_IDLE_TIMEOUT

      static final long DEFAULT_IDLE_TIMEOUT
      The default amount of time in milliseconds, to wait for a connection to become idle

      Current value: 5000.

      See Also:

    • DEFAULT_RETRY_ATTEMPTS

      static final int DEFAULT_RETRY_ATTEMPTS
      The default number of times to retry an operation after a timeout or exception.

      Current value: -1.

      See Also:

    • DEFAULT_PING_INTERVAL

      static final long DEFAULT_PING_INTERVAL
      The default frequency, in milliseconds, to ping servers.

      Current value: 10000.

      See Also:

    • DEFAULT_STATISTIC_INTERVAL

      static final int DEFAULT_STATISTIC_INTERVAL
      The default frequency, in milliseconds, that client statistics will be sent to the server.

      Current value: -1.

      See Also:

    • DEFAULT_THREAD_LOCAL_CONNECTIONS

      @Deprecated static final boolean DEFAULT_THREAD_LOCAL_CONNECTIONS
      Deprecated.
      Since Geode 1.10.0. Thread local connections are ignored. Will be removed in future major release.
      The default value for whether connections should have affinity to the thread that last used them.

      Current value: false.

      See Also:

    • DEFAULT_SUBSCRIPTION_ENABLED

      static final boolean DEFAULT_SUBSCRIPTION_ENABLED
      The default value for whether to establish a server to client subscription.

      Current value: false.

      See Also:

    • DEFAULT_SUBSCRIPTION_REDUNDANCY

      static final int DEFAULT_SUBSCRIPTION_REDUNDANCY
      The default redundancy for servers holding subscriptions established by this client

      Current value: 0.

      See Also:

    • DEFAULT_SUBSCRIPTION_MESSAGE_TRACKING_TIMEOUT

      static final int DEFAULT_SUBSCRIPTION_MESSAGE_TRACKING_TIMEOUT
      The default amount of time, in milliseconds, that messages sent from a server to a client will be tracked. The tracking is done to minimize duplicate events.

      Current value: 900000.

      See Also:

    • DEFAULT_SUBSCRIPTION_ACK_INTERVAL

      static final int DEFAULT_SUBSCRIPTION_ACK_INTERVAL
      The default amount of time, in milliseconds, to wait before sending an acknowledgement to the server about events received from the subscriptions.

      Current value: 100.

      See Also:

    • DEFAULT_SUBSCRIPTION_TIMEOUT_MULTIPLIER

      static final int DEFAULT_SUBSCRIPTION_TIMEOUT_MULTIPLIER
      The default number of server "ping" intervals that can elapse with no activity before a subscription connection is deemed dead and failover is initiated.

      Current value: 0

      See Also:

    • DEFAULT_SERVER_GROUP

      static final String DEFAULT_SERVER_GROUP
      The default server group.

      Current value: "".

      See Also:

    • DEFAULT_PR_SINGLE_HOP_ENABLED

      static final boolean DEFAULT_PR_SINGLE_HOP_ENABLED
      The default value for whether to have single hop optimisations enabled.

      Current value: true.

      Since:
      GemFire 6.5
      See Also:

    • DEFAULT_MULTIUSER_AUTHENTICATION

      static final boolean DEFAULT_MULTIUSER_AUTHENTICATION
      The default value for whether to use multiuser mode.

      Current value: false.

      Since:
      GemFire 6.5
      See Also:

    • DEFAULT_SOCKET_FACTORY

      @Immutable static final SocketFactory DEFAULT_SOCKET_FACTORY
      The default value for the socket factory Current value SocketFactory.DEFAULT

  • Method Details

    • setSocketConnectTimeout

      PoolFactory setSocketConnectTimeout(int socketConnectTimeout)
      Sets the socket connect timeout for this pool. The number of milli seconds specified as socket timeout when the client connects to the servers/locators. A timeout of zero is interpreted as an infinite timeout. The connection will then block until established or an error occurs.
      Parameters:
      socketConnectTimeout - timeout in milliseconds when the client connects to the servers
      Returns:
      a reference to this
      Throws:
      IllegalArgumentException - if socketConnectTimeout is less than or equal to -1.

    • setFreeConnectionTimeout

      PoolFactory setFreeConnectionTimeout(int connectionTimeout)
      Sets the free connection timeout for this pool. If the pool has a max connections setting, operations will block if all of the connections are in use. The free connection timeout specifies how long those operations will block waiting for a free connection before receiving an AllConnectionsInUseException. If max connections is not set this setting has no effect.
      Parameters:
      connectionTimeout - the connection timeout in milliseconds
      Returns:
      a reference to this
      Throws:
      IllegalArgumentException - if connectionTimeout is less than or equal to 0.
      See Also:

    • setServerConnectionTimeout

      PoolFactory setServerConnectionTimeout(int serverConnectionTimeout)
      Sets the server connection timeout for this pool. If the pool has a max connections setting, operations will block if there is no free connection towards specific server. The server connection timeout specifies how long those operations will block waiting for a free connection towards specific server before receiving an AllConnectionsInUseException. If max connections is not set this setting has no effect. It differs from "setFreeConnectionTimeout" which sets wait time for any server connection in the pool, where this sets wait time for a free connection to a specific server.
      Parameters:
      serverConnectionTimeout - the connection timeout in milliseconds
      Returns:
      a reference to this
      Throws:
      IllegalArgumentException - if serverConnectionTimeout is less than 0.
      See Also:

    • setLoadConditioningInterval

      PoolFactory setLoadConditioningInterval(int loadConditioningInterval)
      Sets the load conditioning interval for this pool. This interval controls how frequently the pool will check to see if a connection to a given server should be moved to a different server to improve the load balance.

      A value of -1 disables load conditioning

      Parameters:
      loadConditioningInterval - the connection lifetime in milliseconds
      Returns:
      a reference to this
      Throws:
      IllegalArgumentException - if connectionLifetime is less than -1.

    • setSocketBufferSize

      PoolFactory setSocketBufferSize(int bufferSize)
      Sets the socket buffer size for each connection made in this pool. Large messages can be received and sent faster when this buffer is larger. Larger buffers also optimize the rate at which servers can send events for client subscriptions.
      Parameters:
      bufferSize - the size of the socket buffers used for reading and writing on each connection in this pool.
      Returns:
      a reference to this
      Throws:
      IllegalArgumentException - if bufferSize is less than or equal to 0.

    • setThreadLocalConnections

      @Deprecated PoolFactory setThreadLocalConnections(boolean threadLocalConnections)
      Deprecated.
      Since Geode 1.10.0. Thread local connections are ignored. Will be removed in future major release.
      Sets the thread local connections policy for this pool. If true then any time a thread goes to use a connection from this pool it will check a thread local cache and see if it already has a connection in it. If so it will use it. If not it will get one from this pool and cache it in the thread local. This gets rid of thread contention for the connections but increases the number of connections the servers see.

      If false then connections are returned to the pool as soon as the operation being done with the connection completes. This allows connections to be shared amonst multiple threads keeping the number of connections down.

      Parameters:
      threadLocalConnections - if true then enable thread local connections.
      Returns:
      a reference to this

    • setReadTimeout

      PoolFactory setReadTimeout(int timeout)
      Sets the number of milliseconds to wait for a response from a server before timing out the operation and trying another server (if any are available).
      Parameters:
      timeout - number of milliseconds to wait for a response from a server
      Returns:
      a reference to this
      Throws:
      IllegalArgumentException - if timeout is less than 0.

    • setMinConnections

      PoolFactory setMinConnections(int minConnections)
      Set the minimum number of connections to keep available at all times. When the pool is created, it will create this many connections. If 0 then connections will not be made until an actual operation is done that requires client-to-server communication.
      Parameters:
      minConnections - the initial number of connections this pool will create.
      Returns:
      a reference to this
      Throws:
      IllegalArgumentException - if minConnections is less than 0.

    • setMaxConnections

      PoolFactory setMaxConnections(int maxConnections)
      Set the max number of client to server connections that the pool will create. If all of the connections are in use, an operation requiring a client to server connection will block until a connection is available.
      Parameters:
      maxConnections - the maximum number of connections in the pool. this pool will create. -1 indicates that there is no maximum number of connections
      Returns:
      a reference to this
      Throws:
      IllegalArgumentException - if maxConnections is less than minConnections.
      See Also:

    • setIdleTimeout

      PoolFactory setIdleTimeout(long idleTimeout)
      Set the amount of time a connection can be idle before expiring the connection. If the pool size is greater than the minimum specified by setMinConnections(int), connections which have been idle for longer than the idleTimeout will be closed.
      Parameters:
      idleTimeout - The amount of time in milliseconds that an idle connection should live before expiring. -1 indicates that connections should never expire.
      Returns:
      a reference to this
      Throws:
      IllegalArgumentException - if idleTimout is less than -1.

    • setRetryAttempts

      PoolFactory setRetryAttempts(int retryAttempts)
      Set the number of times to retry a request after timeout/exception.
      Parameters:
      retryAttempts - The number of times to retry a request after timeout/exception. -1 indicates that a request should be tried against every available server before failing
      Returns:
      a reference to this
      Throws:
      IllegalArgumentException - if retryAttempts is less than -1.

    • setPingInterval

      PoolFactory setPingInterval(long pingInterval)
      How often to ping servers to verify that they are still alive. Each server will be sent a ping every pingInterval if there has not been any other communication with the server. These pings are used by the server to monitor the health of the client. Make sure that the pingInterval is less than the maximum time between pings allowed by the cache server.
      Parameters:
      pingInterval - The amount of time in milliseconds between pings.
      Returns:
      a reference to this
      Throws:
      IllegalArgumentException - if pingInterval is less than or equal to 0.
      See Also:

    • setStatisticInterval

      PoolFactory setStatisticInterval(int statisticInterval)
      How often to send client statistics to the server. Doing this allows gfmon to monitor clients.

      A value of -1 disables the sending of client statistics to the server.

      Parameters:
      statisticInterval - The amount of time in milliseconds between sends of client statistics to the server.
      Returns:
      a reference to this
      Throws:
      IllegalArgumentException - if statisticInterval is less than -1.

    • setServerGroup

      PoolFactory setServerGroup(String group)
      Configures the group that all servers this pool connects to must belong to.
      Parameters:
      group - the server group that this pool will connect to. If null or "" then all servers will be connected to.
      Returns:
      a reference to this

    • addLocator

      PoolFactory addLocator(String host, int port)
      Add a locator, given its host and port, to this factory. The locator must be a server locator and will be used to discover other running cache servers and locators. Note that if the host is unknown at the time of this call the locator will still be added. When the pool is used for an operation if the host is still unknown an exception will be thrown.
      Parameters:
      host - the host name or ip address that the locator is listening on.
      port - the port that the locator is listening on
      Returns:
      a reference to this
      Throws:
      IllegalArgumentException - if port is outside the valid range of [0..65535] inclusive.
      IllegalStateException - if a server has already been added to this factory.

    • addServer

      PoolFactory addServer(String host, int port)
      Add a server, given its host and port, to this factory. The server must be a cache server and this client will directly connect to without consulting a server locator. Note that if the host is unknown at the time of this call the server will still be added. When the pool is used for an operation if the host is still unknown an exception will be thrown.
      Parameters:
      host - the host name or ip address that the server is listening on.
      port - the port that the server is listening on
      Returns:
      a reference to this
      Throws:
      IllegalArgumentException - if port is outside the valid range of [0..65535] inclusive.
      IllegalStateException - if a locator has already been added to this factory.

    • setSubscriptionEnabled

      PoolFactory setSubscriptionEnabled(boolean enabled)
      If set to true then the created pool will have server-to-client subscriptions enabled. If set to false then all Subscription* attributes are ignored at create time.
      Parameters:
      enabled - whether the created pool will have server-to-client subscriptions enabled
      Returns:
      a reference to this

    • setSubscriptionRedundancy

      PoolFactory setSubscriptionRedundancy(int redundancy)
      Sets the redundancy level for this pools server-to-client subscriptions. If 0 then no redundant copies will be kept on the servers. Otherwise an effort will be made to maintain the requested number of copies of the server-to-client subscriptions. At most one copy per server will be made up to the requested level.
      Parameters:
      redundancy - the number of redundant servers for this client's subscriptions.
      Returns:
      a reference to this
      Throws:
      IllegalArgumentException - if redundancyLevel is less than -1.

    • setSubscriptionMessageTrackingTimeout

      PoolFactory setSubscriptionMessageTrackingTimeout(int messageTrackingTimeout)
      Sets the messageTrackingTimeout attribute which is the time-to-live period, in milliseconds, for subscription events the client has received from the server. It's used to minimize duplicate events. Entries that have not been modified for this amount of time are expired from the list
      Parameters:
      messageTrackingTimeout - number of milliseconds to set the timeout to.
      Returns:
      a reference to this
      Throws:
      IllegalArgumentException - if messageTrackingTimeout is less than or equal to 0.

    • setSubscriptionTimeoutMultiplier

      PoolFactory setSubscriptionTimeoutMultiplier(int multiplier)
      A server has an inactivity monitor that ensures a message is sent to a client at least once a minute (60,000 milliseconds). If a subscription timeout multiplier is set in the client it enables timing out of the subscription feed with failover to another server.

      The client will time out it's subscription connection after a number of seconds equal to this multiplier times the server's subscription-timeout.

      Set this to 2 or more to make sure the client will receive pings from the server before the timeout.

      A value of zero (the default) disables timeouts

      The resulting timeout will be multiplied by 1.25 in order to avoid race conditions with the server sending its "ping" message.

      Parameters:
      multiplier - the subscription timeout multiplier to set
      Returns:
      a reference to this

    • setSubscriptionAckInterval

      PoolFactory setSubscriptionAckInterval(int ackInterval)
      Sets the interval in milliseconds to wait before sending acknowledgements to the cache server for events received from the server subscriptions.
      Parameters:
      ackInterval - number of milliseconds to wait before sending event acknowledgements.
      Returns:
      a reference to this
      Throws:
      IllegalArgumentException - if ackInterval is less than or equal to 0.

    • reset

      PoolFactory reset()
      Resets the configuration of this factory to its defaults.
      Returns:
      a reference to this

    • create

      Pool create(String name)
      Create a new Pool for connecting a client to a set of GemFire Cache Servers. using this factory's settings for attributes.
      Parameters:
      name - the name of the pool, used when connecting regions to it
      Returns:
      the newly created pool.
      Throws:
      IllegalStateException - if a pool with name already exists
      IllegalStateException - if a locator or server has not been added.

    • setPRSingleHopEnabled

      PoolFactory setPRSingleHopEnabled(boolean enabled)
      By default setPRSingleHopEnabled is true in which case the client is aware of the location of partitions on servers hosting regions with DataPolicy.PARTITION. Using this information, the client routes the client cache operations directly to the server which is hosting the required partition for the cache operation using a single network hop. This mode works best when setMaxConnections(int) is set to -1 which is the default. This mode causes the client to have more connections to the servers.

      If setPRSingleHopEnabled is false the client may need to do an extra network hop on servers to go to the required partition for that cache operation. The client will use fewer network connections to the servers.

      Caution: for partition regions with local-max-memory equal to zero, no cache operations mentioned above will be routed to those servers as they do not host any partitions.

      Parameters:
      enabled - whether Partitioned Region single hop is enabled
      Returns:
      a reference to this
      Since:
      GemFire 6.5

    • setMultiuserAuthentication

      PoolFactory setMultiuserAuthentication(boolean enabled)
      If set to true then the created pool can be used by multiple authenticated users.
      This setting should only be used for applications that require the client to authenticate itself with the server multiple users.
      Note: If set to true, all the client side regions must have their data-policy set to empty.
      Parameters:
      enabled - whether the created pool can be used by multiple authenticated users
      Returns:
      a reference to this
      Since:
      GemFire 6.5
      See Also:

    • setSocketFactory

      PoolFactory setSocketFactory(SocketFactory socketFactory)
      Set the socket factory used by this pool to create connections to both locators (if configured using addLocator(String, int)) and servers. see SocketFactory See ProxySocketFactories
      Parameters:
      socketFactory - The SocketFactory to use
      Returns:
      a reference to this
      Since:
      Geode 1.13