gnu.hylafax.pool
Class ClientPoolConfiguration

java.lang.Object
  |
  +--gnu.hylafax.pool.ClientPoolConfiguration

public class ClientPoolConfiguration
extends java.lang.Object


Constructor Summary
ClientPoolConfiguration()
           
 
Method Summary
 java.lang.String getAdminPassword()
           
 long getBlockingTimeout()
           
 java.lang.String getHost()
           
 long getMaxIdleTime()
           
 long getMaxNoopTime()
           
 int getMaxPoolSize()
           
 int getMinPoolSize()
           
 java.lang.String getPassword()
           
 int getPort()
           
 long getRetryInterval()
           
 java.lang.String getTimeZone()
           
 java.lang.String getUserName()
           
 boolean isPooling()
           
 void setAdminPassword(java.lang.String adminPassword)
           
 void setBlockingTimeout(long blockingTimeout)
          The number of milliseconds to wait for a client before throwing an exception.
 void setHost(java.lang.String host)
           
 void setMaxIdleTime(long maxIdleTime)
           
 void setMaxNoopTime(long maxNoopTime)
           
 void setMaxPoolSize(int maxPoolSize)
           
 void setMinPoolSize(int minPoolSize)
           
 void setPassword(java.lang.String password)
           
 void setPooling(boolean pooling)
           
 void setPort(int port)
           
 void setRetryInterval(long retryInterval)
           
 void setTimeZone(java.lang.String timeZone)
           
 void setUserName(java.lang.String userName)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ClientPoolConfiguration

public ClientPoolConfiguration()
Method Detail

getAdminPassword

public java.lang.String getAdminPassword()
Returns:
the admin password.

getBlockingTimeout

public long getBlockingTimeout()
Returns:
the blocking timeout in milliseconds.

getHost

public java.lang.String getHost()
Returns:
the host string

getMaxIdleTime

public long getMaxIdleTime()
Returns:
the maximum time in milliseconds for a client to be idle before reopening a connection.

getMaxNoopTime

public long getMaxNoopTime()
Returns:
the maximum time in millisecondes for a client to be idle between noop commands.

getMaxPoolSize

public int getMaxPoolSize()
Returns:
the maximum number of clients in the client pool.

getMinPoolSize

public int getMinPoolSize()
Returns:
the minimum number of clients in the client pool.

getPassword

public java.lang.String getPassword()
Returns:
the password.

getPort

public int getPort()
Returns:
the port number to be used.

getRetryInterval

public long getRetryInterval()
Returns:
the number of milliseconds to wait before checking the stack for a returned client.

getTimeZone

public java.lang.String getTimeZone()
Returns:
the time zone string.

getUserName

public java.lang.String getUserName()
Returns:
the user name.

isPooling

public boolean isPooling()
Returns:
true if pooling is on.

setAdminPassword

public void setAdminPassword(java.lang.String adminPassword)
Parameters:
adminPassword - the administrator password to set.

setBlockingTimeout

public void setBlockingTimeout(long blockingTimeout)
The number of milliseconds to wait for a client before throwing an exception.
Parameters:
blockingTimeout -  

setHost

public void setHost(java.lang.String host)
Parameters:
host - the host string.

setMaxIdleTime

public void setMaxIdleTime(long maxIdleTime)
Parameters:
maxIdleTime - the number of milliseconds for idle clients to remain open before reopening.

setMaxNoopTime

public void setMaxNoopTime(long maxNoopTime)
Parameters:
maxNoopTime - the number of milliseconds for idle clients to wait between noop commands.

setMaxPoolSize

public void setMaxPoolSize(int maxPoolSize)
Parameters:
maxPoolSize - maximum number of connections to maintain in the pool.

setMinPoolSize

public void setMinPoolSize(int minPoolSize)
Parameters:
minPoolSize - minimum number of connections to maintain in the pool.

setPassword

public void setPassword(java.lang.String password)
Parameters:
password - the password to set.

setPooling

public void setPooling(boolean pooling)
Parameters:
pooling - set to true if client pooling is desired.

setPort

public void setPort(int port)
Parameters:
port - the port number to set.

setRetryInterval

public void setRetryInterval(long retryInterval)
Parameters:
retryInterval - the number of milliseconds to wait before rechecking the pool for returned clients.

setTimeZone

public void setTimeZone(java.lang.String timeZone)
Parameters:
timeZone - the timezone string to set.

setUserName

public void setUserName(java.lang.String userName)
Parameters:
userName - the user name to set.