ConnectionPoolInfo (JMap 7.0 Kathmandu API Documentation)

java.lang.Object
- com.kheops.jmap.metadata.LocalizedObject
- - com.kheops.jmap.metadata.JMapObject
  - - com.kheops.jmap.db.ConnectionPoolInfo

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<ConnectionPoolInfo>

Direct Known Subclasses:

DatabaseConnectionPoolInfo, SdeConnectionPoolInfo
```
public abstract class ConnectionPoolInfo
extends JMapObject
implements java.io.Serializable, java.lang.Comparable<ConnectionPoolInfo>, java.lang.Cloneable
```
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CONNECTION_ERROR`
`static int`	`CONNECTION_INACTIVE`
`static int`	`CONNECTION_NOT_TESTED`
`static int`	`CONNECTION_OK`
`protected java.lang.String`	`description`
`protected java.lang.String`	`driver`
`protected int`	`id`
`protected java.lang.Exception`	`lastException`
`protected int`	`maximumSize`
`protected java.lang.String`	`name`
`protected static int`	`OBJECT_VERSION_ID_7_0`
`protected static int`	`OBJECT_VERSION_ID_7_0_ISTANBUL`
`protected int`	`objectVersionId`
`protected java.lang.String`	`password`
`protected long`	`recyclePeriod`
`protected int`	`size`
`protected int`	`status`
`protected long`	`timeout`
`protected java.lang.String`	`url`
`protected java.lang.String`	`user`

Fields inherited from class com.kheops.jmap.metadata.JMapObject
acl

Constructor Summary

Constructors
Constructor and Description

ConnectionPoolInfo()

Constructors
Constructor and Description
`ConnectionPoolInfo()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.Object`	`clone()` Clones the current connection pool info.
`int`	`compareTo(ConnectionPoolInfo poolInfo)` Compares this object's name with another ConnectionPoolInfo object's name
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getDescription()` This method returns the description of the ConnectionPool
`java.lang.String`	`getDriver()` This method returns the driver name to use to connect to the database
`int`	`getId()` This method returns the Id of the ConnectionPool
`java.lang.Exception`	`getLastException()`
`int`	`getMaximumSize()` This method returns the maximum size of the ConnectionPool
`java.lang.String`	`getName()` This method returns the name of a ConnectionPool
`java.lang.String`	`getPassword()` This method returns the password to use to initialize the ConnectionPool
`long`	`getRecyclePeriod()` This method returns the period (milliseconds) to wait before recycling the ConnectionPool connections.
`int`	`getSize()` This method returns the minimum size of the ConnectionPool
`int`	`getStatus()`
`long`	`getTimeout()`
`java.lang.String`	`getUrl()` This method returns the URL of the database to use
`java.lang.String`	`getUser()` This method returns the username to use to initialize the ConnectionPool
`int`	`hashCode()`
`void`	`setDescription(java.lang.String description)` This method sets the description of the ConnectionPool
`void`	`setDriver(java.lang.String driver)` This method sets the driver name to use to connect to the database
`void`	`setId(int id)` This method sets the Id of the ConnectionPool
`void`	`setLastException(java.lang.Exception lastException)`
`void`	`setMaximumSize(int maxsize)` This method sets the maximum size of the ConnectionPool
`void`	`setName(java.lang.String name)` This method sets the name of the ConnectionPool
`void`	`setPassword(java.lang.String password)` This method sets the password to use to initialize the ConnectionPool
`void`	`setRecyclePeriod(long recyclePeriod)` This method sets the period (milliseconds) to wait before recycling the ConnectionPool connections.
`void`	`setSize(int size)` This method sets the minimum size of the ConnectionPool
`void`	`setStatus(int status)`
`void`	`setTimeout(long timeout)`
`void`	`setUrl(java.lang.String url)` This method sets the URL of the database to use
`void`	`setUser(java.lang.String user)` This method sets the username to use to initialize the ConnectionPool
`java.lang.String`	`toString()`

Methods inherited from class com.kheops.jmap.metadata.JMapObject
clone, setAcl

Methods inherited from class com.kheops.jmap.metadata.LocalizedObject
getAvailableLocales, getTranslation, isTranslationExists, removeTranslationsOtherThan, setTranslation, updateTranslations

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

- Field Detail
  - CONNECTION_NOT_TESTED
```
public static final int CONNECTION_NOT_TESTED
```
    See Also:
    
    Constant Field Values
  - CONNECTION_ERROR
```
public static final int CONNECTION_ERROR
```
    See Also:
    
    Constant Field Values
  - CONNECTION_OK
```
public static final int CONNECTION_OK
```
    See Also:
    
    Constant Field Values
  - CONNECTION_INACTIVE
```
public static final int CONNECTION_INACTIVE
```
    See Also:
    
    Constant Field Values
  - OBJECT_VERSION_ID_7_0
```
protected static final int OBJECT_VERSION_ID_7_0
```
    See Also:
    
    Constant Field Values
  - OBJECT_VERSION_ID_7_0_ISTANBUL
```
protected static final int OBJECT_VERSION_ID_7_0_ISTANBUL
```
    See Also:
    
    Constant Field Values
  - id
```
protected int id
```
  - name
```
protected java.lang.String name
```
  - description
```
protected java.lang.String description
```
  - driver
```
protected java.lang.String driver
```
  - url
```
protected java.lang.String url
```
  - user
```
protected java.lang.String user
```
  - password
```
protected java.lang.String password
```
  - size
```
protected int size
```
  - maximumSize
```
protected int maximumSize
```
  - recyclePeriod
```
protected long recyclePeriod
```
  - status
```
protected int status
```
  - timeout
```
protected long timeout
```
  - lastException
```
protected transient java.lang.Exception lastException
```
  - objectVersionId
```
protected int objectVersionId
```
- Constructor Detail
  - ConnectionPoolInfo
```
public ConnectionPoolInfo()
```
- Method Detail
  - getId
```
public int getId()
```
    This method returns the Id of the ConnectionPool
    
    Returns:
    
    a ConnectionPool Id
  - setId
```
public void setId(int id)
```
    This method sets the Id of the ConnectionPool
    
    Parameters:
    
    id - a ConnectionPool Id
  - getName
```
public java.lang.String getName()
```
    This method returns the name of a ConnectionPool
    
    Returns:
    
    the name of a ConnectionPool
  - setName
```
public void setName(java.lang.String name)
```
    This method sets the name of the ConnectionPool
    
    Parameters:
    
    name - the name of the ConnectionPool
  - getDescription
```
public java.lang.String getDescription()
```
    This method returns the description of the ConnectionPool
    
    Returns:
    
    the description of the ConnectionPool
  - setDescription
```
public void setDescription(java.lang.String description)
```
    This method sets the description of the ConnectionPool
    
    Parameters:
    
    description - the description of the ConnectionPool
  - getDriver
```
public java.lang.String getDriver()
```
    This method returns the driver name to use to connect to the database
    
    Returns:
    
    the driver name to use to connect to the database
  - setDriver
```
public void setDriver(java.lang.String driver)
```
    This method sets the driver name to use to connect to the database
    
    Parameters:
    
    driver - the driver name to use to connect to the database
  - getUrl
```
public java.lang.String getUrl()
```
    This method returns the URL of the database to use
    
    Returns:
    
    the URL of the database to use
  - setUrl
```
public void setUrl(java.lang.String url)
```
    This method sets the URL of the database to use
    
    Parameters:
    
    url - the URL of the database to use
  - getUser
```
public java.lang.String getUser()
```
    This method returns the username to use to initialize the ConnectionPool
    
    Returns:
    
    the username to use to initialize the ConnectionPool
  - setUser
```
public void setUser(java.lang.String user)
```
    This method sets the username to use to initialize the ConnectionPool
    
    Parameters:
    
    user - the username to use to initialize the ConnectionPool
  - getPassword
```
public java.lang.String getPassword()
```
    This method returns the password to use to initialize the ConnectionPool
    
    Returns:
    
    the password to use to initialize the ConnectionPool
  - setPassword
```
public void setPassword(java.lang.String password)
```
    This method sets the password to use to initialize the ConnectionPool
    
    Parameters:
    
    password - the password to use to initialize the ConnectionPool
  - getSize
```
public int getSize()
```
    This method returns the minimum size of the ConnectionPool
    
    Returns:
    
    the minimum size of the ConnectionPool
  - getMaximumSize
```
public int getMaximumSize()
```
    This method returns the maximum size of the ConnectionPool
    
    Returns:
    
    the maximum size of the ConnectionPool
  - setSize
```
public void setSize(int size)
```
    This method sets the minimum size of the ConnectionPool
    
    Parameters:
    
    size - the minimum size of the ConnectionPool
  - setMaximumSize
```
public void setMaximumSize(int maxsize)
```
    This method sets the maximum size of the ConnectionPool
    
    Parameters:
    
    maxsize - the maximum size of the ConnectionPool
  - getRecyclePeriod
```
public long getRecyclePeriod()
```
    This method returns the period (milliseconds) to wait before recycling the ConnectionPool connections.
    
    Returns:
    
    the period in milliseconds
  - setRecyclePeriod
```
public void setRecyclePeriod(long recyclePeriod)
```
    This method sets the period (milliseconds) to wait before recycling the ConnectionPool connections.
    
    Parameters:
    
    recyclePeriod - the recycle period time in milliseconds
  - compareTo
```
public int compareTo(ConnectionPoolInfo poolInfo)
```
    Compares this object's name with another ConnectionPoolInfo object's name
    
    Specified by:
    
    compareTo in interface java.lang.Comparable<ConnectionPoolInfo>
    
    Parameters:
    
    poolInfo - the object to be compared with
    
    Returns:
    
    a negative integer, zero, or a positive integer as the the specified String is greater than, equal to, or less than this String, ignoring case considerations
  - getStatus
```
public int getStatus()
```
  - setStatus
```
public void setStatus(int status)
```
  - getLastException
```
public java.lang.Exception getLastException()
```
  - setLastException
```
public void setLastException(java.lang.Exception lastException)
```
  - getTimeout
```
public long getTimeout()
```
  - setTimeout
```
public void setTimeout(long timeout)
```
  - clone
```
public java.lang.Object clone()
```
    Clones the current connection pool info.
    
    Overrides:
    
    clone in class java.lang.Object
    
    Returns:
    
    a deep clone of the current connection pool info.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class JMapObject
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class JMapObject
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class ConnectionPoolInfo

Field Summary

Fields inherited from class com.kheops.jmap.metadata.JMapObject

Constructor Summary

Method Summary

Methods inherited from class com.kheops.jmap.metadata.JMapObject

Methods inherited from class com.kheops.jmap.metadata.LocalizedObject

Methods inherited from class java.lang.Object

Field Detail

CONNECTION_NOT_TESTED

CONNECTION_ERROR

CONNECTION_OK

CONNECTION_INACTIVE

OBJECT_VERSION_ID_7_0

OBJECT_VERSION_ID_7_0_ISTANBUL

id

name

description

driver

url

user

password

size

maximumSize

recyclePeriod

status

timeout

lastException

objectVersionId

Constructor Detail

ConnectionPoolInfo

Method Detail

getId

setId

getName

setName

getDescription

setDescription

getDriver

setDriver

getUrl

setUrl

getUser

setUser

getPassword

setPassword

getSize

getMaximumSize

setSize

setMaximumSize

getRecyclePeriod

setRecyclePeriod

compareTo

getStatus

setStatus

getLastException

setLastException

getTimeout

setTimeout

clone

hashCode

equals

toString