Package org.apache.geode.cache.configuration

Class PoolType

java.lang.Object
org.apache.geode.cache.configuration.PoolType
@Experimental public class PoolType extends Object
A "pool" element specifies a client to server connection pool.

Java class for pool-type complex type.

The following schema fragment specifies the expected content contained within this class. 

 <complexType name="pool-type">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <choice>
         <element name="locator" maxOccurs="unbounded">
           <complexType>
             <complexContent>
               <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                 <attribute name="host" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
                 <attribute name="port" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
               </restriction>
             </complexContent>
           </complexType>
         </element>
         <element name="server" maxOccurs="unbounded">
           <complexType>
             <complexContent>
               <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                 <attribute name="host" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
                 <attribute name="port" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
               </restriction>
             </complexContent>
           </complexType>
         </element>
       </choice>
       <attribute name="subscription-timeout-multiplier" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="socket-connect-timeout" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="free-connection-timeout" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="server-connection-timeout" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="load-conditioning-interval" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="min-connections" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="max-connections" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="retry-attempts" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="idle-timeout" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="ping-interval" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="name" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="read-timeout" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="server-group" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="socket-buffer-size" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="subscription-enabled" type="{http://www.w3.org/2001/XMLSchema}boolean" />
       <attribute name="subscription-message-tracking-timeout" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="subscription-ack-interval" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="subscription-redundancy" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="statistic-interval" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="thread-local-connections" type="{http://www.w3.org/2001/XMLSchema}boolean" />
       <attribute name="pr-single-hop-enabled" type="{http://www.w3.org/2001/XMLSchema}boolean" />
       <attribute name="multiuser-authentication" type="{http://www.w3.org/2001/XMLSchema}boolean" />
     </restriction>
   </complexContent>
 </complexType>

  • Field Details

    • locators

      protected List<PoolType.Locator> locators

    • servers

      protected List<PoolType.Server> servers

    • freeConnectionTimeout

      protected String freeConnectionTimeout

    • serverConnectionTimeout

      protected String serverConnectionTimeout

    • loadConditioningInterval

      protected String loadConditioningInterval

    • minConnections

      protected String minConnections

    • maxConnections

      protected String maxConnections

    • retryAttempts

      protected String retryAttempts

    • idleTimeout

      protected String idleTimeout

    • pingInterval

      protected String pingInterval

    • name

      protected String name

    • readTimeout

      protected String readTimeout

    • serverGroup

      protected String serverGroup

    • socketBufferSize

      protected String socketBufferSize

    • subscriptionEnabled

      protected Boolean subscriptionEnabled

    • subscriptionAckInterval

      protected String subscriptionAckInterval

    • subscriptionRedundancy

      protected String subscriptionRedundancy

    • statisticInterval

      protected String statisticInterval

    • threadLocalConnections

      @Deprecated protected Boolean threadLocalConnections
      Deprecated.

    • prSingleHopEnabled

      protected Boolean prSingleHopEnabled

  • Constructor Details

    • PoolType

      public PoolType()

  • Method Details

    • getLocators

      public List<PoolType.Locator> getLocators()
      Gets the value of the locator property.

      This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the locator property.

      For example, to add a new item, do as follows: 

       getLocators().add(newItem);

      Objects of the following type(s) are allowed in the list PoolType.Locator

      Returns:
      the List of PoolType.Locators representing the locators property.

    • getServers

      public List<PoolType.Server> getServers()
      Gets the value of the server property.

      This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the server property.

      For example, to add a new item, do as follows: 

       getServers().add(newItem);

      Objects of the following type(s) are allowed in the list PoolType.Server

      Returns:
      a List of PoolType.Servers representing the server property.

    • getSubscriptionTimeoutMultiplier

      public String getSubscriptionTimeoutMultiplier()
      Gets the value of the subscriptionTimeoutMultiplier property. possible object is String
      Returns:
      the subscription timeout multiplier.

    • setSubscriptionTimeoutMultiplier

      public void setSubscriptionTimeoutMultiplier(String value)
      Sets the value of the subscriptionTimeoutMultiplier property. allowed object is String
      Parameters:
      value - the subscription timeout multiplier.

    • getSocketConnectTimeout

      public String getSocketConnectTimeout()
      Gets the value of the socketConnectTimeout property. possible object is String
      Returns:
      the socket connection timeout.

    • setSocketConnectTimeout

      public void setSocketConnectTimeout(String value)
      Sets the value of the socketConnectTimeout property. allowed object is String
      Parameters:
      value - the socket connection timeout.

    • getFreeConnectionTimeout

      public String getFreeConnectionTimeout()
      Gets the value of the freeConnectionTimeout property. possible object is String
      Returns:
      the free connection timeout.

    • setFreeConnectionTimeout

      public void setFreeConnectionTimeout(String value)
      Sets the value of the freeConnectionTimeout property. allowed object is String
      Parameters:
      value - the free connection timeout.

    • getServerConnectionTimeout

      public String getServerConnectionTimeout()
      Gets the value of the serverConnectionTimeout property. possible object is String
      Returns:
      the server connection timeout.

    • setServerConnectionTimeout

      public void setServerConnectionTimeout(String value)
      Sets the value of the serverConnectionTimeout property. allowed object is String
      Parameters:
      value - the server connection timeout.

    • getLoadConditioningInterval

      public String getLoadConditioningInterval()
      Gets the value of the loadConditioningInterval property. possible object is String
      Returns:
      the load conditioning interval.

    • setLoadConditioningInterval

      public void setLoadConditioningInterval(String value)
      Sets the value of the loadConditioningInterval property. allowed object is String
      Parameters:
      value - the load conditioning interval.

    • getMinConnections

      public String getMinConnections()
      Gets the value of the minConnections property. possible object is String
      Returns:
      the minimum value of connections.

    • setMinConnections

      public void setMinConnections(String value)
      Sets the value of the minConnections property. allowed object is String
      Parameters:
      value - the minimum value of connections.

    • getMaxConnections

      public String getMaxConnections()
      Gets the value of the maxConnections property. possible object is String
      Returns:
      the maximum number of connections.

    • setMaxConnections

      public void setMaxConnections(String value)
      Sets the value of the maxConnections property. allowed object is String
      Parameters:
      value - the maximum number of connections.

    • getRetryAttempts

      public String getRetryAttempts()
      Gets the value of the retryAttempts property. possible object is String
      Returns:
      the number or allowed retry attempts.

    • setRetryAttempts

      public void setRetryAttempts(String value)
      Sets the value of the retryAttempts property. allowed object is String
      Parameters:
      value - the number of times to retry.

    • getIdleTimeout

      public String getIdleTimeout()
      Gets the value of the idleTimeout property. possible object is String
      Returns:
      the idle timeout.

    • setIdleTimeout

      public void setIdleTimeout(String value)
      Sets the value of the idleTimeout property. allowed object is String
      Parameters:
      value - the idle timeout.

    • getPingInterval

      public String getPingInterval()
      Gets the value of the pingInterval property. possible object is String
      Returns:
      the ping interval.

    • setPingInterval

      public void setPingInterval(String value)
      Sets the value of the pingInterval property. allowed object is String
      Parameters:
      value - the ping interval.

    • getName

      public String getName()
      Gets the value of the name property. possible object is String
      Returns:
      the name.

    • setName

      public void setName(String value)
      Sets the value of the name property. allowed object is String
      Parameters:
      value - the name.

    • getReadTimeout

      public String getReadTimeout()
      Gets the value of the readTimeout property. possible object is String
      Returns:
      the read timeout.

    • setReadTimeout

      public void setReadTimeout(String value)
      Sets the value of the readTimeout property. allowed object is String
      Parameters:
      value - the read timeout.

    • getServerGroup

      public String getServerGroup()
      Gets the value of the serverGroup property. possible object is String
      Returns:
      the name of the server group.

    • setServerGroup

      public void setServerGroup(String value)
      Sets the value of the serverGroup property. allowed object is String
      Parameters:
      value - name of the server group.

    • getSocketBufferSize

      public String getSocketBufferSize()
      Gets the value of the socketBufferSize property. possible object is String
      Returns:
      the size of the socket buffer.

    • setSocketBufferSize

      public void setSocketBufferSize(String value)
      Sets the value of the socketBufferSize property. allowed object is String
      Parameters:
      value - the size to use for the socket buffer.

    • isSubscriptionEnabled

      public Boolean isSubscriptionEnabled()
      Gets the value of the subscriptionEnabled property. possible object is Boolean
      Returns:
      true if subscriptions are enabled.

    • setSubscriptionEnabled

      public void setSubscriptionEnabled(Boolean value)
      Sets the value of the subscriptionEnabled property. allowed object is Boolean
      Parameters:
      value - enables or disables subscriptions.

    • getSubscriptionMessageTrackingTimeout

      public String getSubscriptionMessageTrackingTimeout()
      Gets the value of the subscriptionMessageTrackingTimeout property. possible object is String
      Returns:
      the subscription message tracking timeout.

    • setSubscriptionMessageTrackingTimeout

      public void setSubscriptionMessageTrackingTimeout(String value)
      Sets the value of the subscriptionMessageTrackingTimeout property. allowed object is String
      Parameters:
      value - the subscription message tracking timeout.

    • getSubscriptionAckInterval

      public String getSubscriptionAckInterval()
      Gets the value of the subscriptionAckInterval property. possible object is String
      Returns:
      the subscription ack interval.

    • setSubscriptionAckInterval

      public void setSubscriptionAckInterval(String value)
      Sets the value of the subscriptionAckInterval property. allowed object is String
      Parameters:
      value - the subscription ack interval.

    • getSubscriptionRedundancy

      public String getSubscriptionRedundancy()
      Gets the value of the subscriptionRedundancy property. possible object is String
      Returns:
      the number of servers being used as backups.

    • setSubscriptionRedundancy

      public void setSubscriptionRedundancy(String value)
      Sets the value of the subscriptionRedundancy property. allowed object is String
      Parameters:
      value - the number of servers to use as backups. Set to -1 to use all non-primaries as backups.

    • getStatisticInterval

      public String getStatisticInterval()
      Gets the value of the statisticInterval property. possible object is String
      Returns:
      the statistics interval.

    • setStatisticInterval

      public void setStatisticInterval(String value)
      Sets the value of the statisticInterval property. allowed object is String
      Parameters:
      value - the statistics interval.

    • isThreadLocalConnections

      @Deprecated public Boolean isThreadLocalConnections()
      Deprecated.
      Since Geode 1.10.0. Thread local connections are ignored. Will be removed in future major release.
      Gets the value of the threadLocalConnections property. possible object is Boolean
      Returns:
      true is using thread local connections, false otherwise.

    • setThreadLocalConnections

      @Deprecated public void setThreadLocalConnections(Boolean value)
      Deprecated.
      Since Geode 1.10.0. Thread local connections are ignored. Will be removed in future major release.
      Sets the value of the threadLocalConnections property. allowed object is Boolean
      Parameters:
      value - enables or disables thread local connections.

    • isPrSingleHopEnabled

      public Boolean isPrSingleHopEnabled()
      Gets the value of the prSingleHopEnabled property. possible object is Boolean
      Returns:
      true if partitioned region single hop is enabled, false otherwise.

    • setPrSingleHopEnabled

      public void setPrSingleHopEnabled(Boolean value)
      Sets the value of the prSingleHopEnabled property. allowed object is Boolean
      Parameters:
      value - enables or disables partitioned region single hop

    • isMultiuserAuthentication

      public Boolean isMultiuserAuthentication()
      Gets the value of the multiuserAuthentication property. possible object is Boolean
      Returns:
      true is using multiuser authentication, false otherwise.

    • setMultiuserAuthentication

      public void setMultiuserAuthentication(Boolean value)
      Sets the value of the multiuserAuthentication property. allowed object is Boolean
      Parameters:
      value - enables or disables multiuser authentication.