Package com.ibm.as400.access

Class AS400JDBCConnectionPoolDataSource

java.lang.Object

com.ibm.as400.access.AS400JDBCDataSource

com.ibm.as400.access.AS400JDBCConnectionPoolDataSource

All Implemented Interfaces:

Serializable, Cloneable, Wrapper, Referenceable, CommonDataSource, ConnectionPoolDataSource, DataSource

public class AS400JDBCConnectionPoolDataSource
extends AS400JDBCDataSource
implements ConnectionPoolDataSource, Referenceable, Serializable

The AS400JDBCConnectionPoolDataSource class represents a factory for AS400PooledConnection objects.

The following is an example that creates an AS400JDBCConnectionPoolDataSource object that can be used to cache JDBC connections.

  // Create a data source for making the connection.
  AS400JDBCConnectionPoolDataSource dataSource = new AS400JDBCConnectionPoolDataSource("myAS400");
  datasource.setUser("myUser");
  datasource.setPassword("MYPWD");

  // Get the PooledConnection.
  PooledConnection pooledConnection = datasource.getPooledConnection();
  

See Also:

Serialized Form

Field Summary

Fields inherited from class com.ibm.as400.access.AS400JDBCDataSource

CONCURRENTACCESS_NOT_SET, CONCURRENTACCESS_SKIP_LOCKS, CONCURRENTACCESS_USE_CURRENTLY_COMMITTED, CONCURRENTACCESS_WAIT_FOR_OUTCOME, MAX_STORAGE_LIMIT, SERVER_TRACE_DEBUG_SERVER_JOB, SERVER_TRACE_SAVE_SERVER_JOBLOG, SERVER_TRACE_SAVE_SQL_INFORMATION, SERVER_TRACE_START_DATABASE_MONITOR, SERVER_TRACE_TRACE_SERVER_JOB

Constructor Summary

Constructors

Constructor	Description
AS400JDBCConnectionPoolDataSource()	Constructs a default AS400JDBCConnectionPoolDataSource object.
AS400JDBCConnectionPoolDataSource(AS400 as400)
AS400JDBCConnectionPoolDataSource(String serverName)	Constructs an AS400JDBCConnectionPoolDataSource with the specified serverName.
AS400JDBCConnectionPoolDataSource(String serverName, String user, char[] password)	Constructs an AS400JDBCConnectionPoolDataSource with the specified signon information.
AS400JDBCConnectionPoolDataSource(String serverName, String user, String password)	Deprecated. Use AS400JDBCConnectionPoolDataSource(String serverName, String user, char[] password) instead.
AS400JDBCConnectionPoolDataSource(String serverName, String user, String password, String keyRingNameX, String keyRingPasswordX)	Deprecated. -- keyrings are not supported.

Method Summary

Modifier and Type	Method	Description
PooledConnection	getPooledConnection()	Returns a pooled connection that is connected to the IBM i system.
PooledConnection	getPooledConnection(String user, char[] password)	Returns a pooled connection that is connected to the IBM i system.
PooledConnection	getPooledConnection(String user, String password)	Deprecated. Use getPooledConnection(String user, char[] password) instead.
Reference	getReference()	Returns the Reference object for the data source object.
protected String[]	getValidWrappedList()
boolean	isWrapperFor(Class<?> iface)	Returns true if this either implements the interface argument or is directly or indirectly a wrapper for an object that does.
<T> T	unwrap(Class<T> iface)	Returns an object that implements the given interface to allow access to non-standard methods, or standard methods not exposed by the proxy.

Methods inherited from class com.ibm.as400.access.AS400JDBCDataSource

addPropertyChangeListener, clone, getAccess, getAffinityFailbackInterval, getBehaviorOverride, getBidiStringType, getBlockCriteria, getBlockSize, getCharacterTruncation, getClientRerouteAlternatePortNumber, getClientRerouteAlternateServerName, getConcurrentAccessResolution, getConnection, getConnection, getConnection, getConnection, getCursorSensitivity, getDatabaseName, getDataSourceName, getDateFormat, getDateSeparator, getDecfloatRoundingMode, getDecimalDataErrors, getDecimalSeparator, getDescribeOption, getDescription, getDriver, getEnableClientAffinitiesList, getEnableSeamlessFailover, getErrors, getIgnoreWarnings, getKeepAlive, getLibraries, getLobThreshold, getLoginTimeout, getLogWriter, getMaximumBlockedInputRows, getMaximumPrecision, getMaximumScale, getMaxRetriesForClientReroute, getMetadataSource, getMetaDataSource, getMinimumDivideScale, getNaming, getNumericRangeError, getPackage, getPackageCcsid, getPackageCCSID, getPackageCriteria, getPackageError, getPackageLibrary, getParentLogger, getPortNumber, getProxyServer, getQaqqinilib, getQaqqiniLibrary, getQueryOptimizeGoal, getQueryReplaceTruncatedParameter, getQueryStorageLimit, getQueryTimeoutMechanism, getReceiveBufferSize, getRemarks, getRetryIntervalForClientReroute, getSecondaryUrl, getSecondaryURL, getSendBufferSize, getServerName, getServerTrace, getServerTraceCategories, getSocketTimeout, getSoLinger, getSort, getSortLanguage, getSortTable, getSortWeight, getSoTimeout, getTcpNoDelay, getTimeFormat, getTimeSeparator, getTimestampFormat, getToolboxTrace, getToolboxTraceCategory, getTransactionIsolation, getTranslateHex, getUser, getVariableFieldCompression, getXALooselyCoupledSupport, isAutoCommit, isAutocommitException, isBidiImplicitReordering, isBidiNumericOrdering, isBigDecimal, isCursorHold, isDataCompression, isDataTruncation, isExtendedDynamic, isExtendedMetadata, isExtendedMetaData, isFullOpen, isHoldInputLocators, isHoldStatements, isJvm16Synchronize, isKeepAlive, isLazyClose, isPackageAdd, isPackageCache, isPackageClear, isPrefetch, isPrompt, isRollbackCursorHold, isSavePasswordWhenSerialized, isSecure, isSecureCurrentUser, isTcpNoDelay, isThreadUsed, isTrace, isTranslateBinary, isTranslateBoolean, isTrueAutocommit, isTrueAutoCommit, isUseBlockUpdate, isUseDrdaMetadataVersion, isVariableFieldCompression, removePropertyChangeListener, setAccess, setAdditionalAuthenticationFactor, setAffinityFailbackInterval, setAutoCommit, setAutocommitException, setBehaviorOverride, setBidiImplicitReordering, setBidiNumericOrdering, setBidiStringType, setBigDecimal, setBlockCriteria, setBlockSize, setCharacterTruncation, setClientRerouteAlternatePortNumber, setClientRerouteAlternateServerName, setConcurrentAccessResolution, setCursorHold, setCursorSensitivity, setDatabaseName, setDataCompression, setDataSourceName, setDataTruncation, setDateFormat, setDateSeparator, setDecfloatRoundingMode, setDecimalDataErrors, setDecimalSeparator, setDescribeOption, setDescription, setDriver, setEnableClientAffinitiesList, setEnableSeamlessFailover, setErrors, setExtendedDynamic, setExtendedMetadata, setExtendedMetaData, setFullOpen, setHoldInputLocators, setHoldStatements, setIgnoreWarnings, setJvm16Synchronize, setKeepAlive, setLazyClose, setLibraries, setLobThreshold, setLoginTimeout, setLogWriter, setMaximumBlockedInputRows, setMaximumPrecision, setMaximumScale, setMaxRetriesForClientReroute, setMetadataSource, setMetaDataSource, setMinimumDivideScale, setNaming, setNumericRangeError, setPackage, setPackageAdd, setPackageCache, setPackageCcsid, setPackageCCSID, setPackageClear, setPackageCriteria, setPackageError, setPackageLibrary, setPassword, setPassword, setPortNumber, setPrefetch, setPrompt, setProperties, setProperties, setProxyServer, setQaqqinilib, setQaqqiniLibrary, setQueryOptimizeGoal, setQueryReplaceTruncatedParameter, setQueryStorageLimit, setQueryTimeoutMechanism, setReceiveBufferSize, setRemarks, setRetryIntervalForClientReroute, setRollbackCursorHold, setSavePasswordWhenSerialized, setSecondaryUrl, setSecondaryURL, setSecure, setSecureCurrentUser, setSendBufferSize, setServerName, setServerTrace, setServerTraceCategories, setSocketTimeout, setSoLinger, setSort, setSortLanguage, setSortTable, setSortWeight, setSoTimeout, setStayAlive, setTcpNoDelay, setThreadUsed, setTimeFormat, setTimeSeparator, setTimestampFormat, setToolboxTrace, setToolboxTraceCategory, setTrace, setTransactionIsolation, setTranslateBinary, setTranslateBoolean, setTranslateHex, setTrueAutocommit, setTrueAutoCommit, setUseBlockUpdate, setUseDrdaMetadataVersion, setUser, setVariableFieldCompression, setVariableFieldCompression, setXALooselyCoupledSupport, toString

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface javax.sql.CommonDataSource

createShardingKeyBuilder, getParentLogger

Methods inherited from interface javax.sql.ConnectionPoolDataSource

createPooledConnectionBuilder, getLoginTimeout, getLogWriter, setLoginTimeout, setLogWriter

Methods inherited from interface javax.sql.DataSource

createConnectionBuilder

Methods inherited from interface java.sql.Wrapper

isWrapperFor, unwrap

Constructor Detail

AS400JDBCConnectionPoolDataSource

public AS400JDBCConnectionPoolDataSource()

Constructs a default AS400JDBCConnectionPoolDataSource object.

AS400JDBCConnectionPoolDataSource

public AS400JDBCConnectionPoolDataSource(AS400 as400)

AS400JDBCConnectionPoolDataSource

public AS400JDBCConnectionPoolDataSource(String serverName)

Constructs an AS400JDBCConnectionPoolDataSource with the specified serverName.

Parameters:

serverName - The IBM i system name.

AS400JDBCConnectionPoolDataSource

public AS400JDBCConnectionPoolDataSource(String serverName,
                                         String user,
                                         String password)

Deprecated.

Use AS400JDBCConnectionPoolDataSource(String serverName, String user, char[] password) instead.

Constructs an AS400JDBCConnectionPoolDataSource with the specified signon information.

Parameters:

serverName - The IBM i system name.

user - The user id.

password - The password.

AS400JDBCConnectionPoolDataSource

public AS400JDBCConnectionPoolDataSource(String serverName,
                                         String user,
                                         char[] password)

Constructs an AS400JDBCConnectionPoolDataSource with the specified signon information.

Parameters:

serverName - The IBM i system name.

user - The user id.

password - The password.

AS400JDBCConnectionPoolDataSource

public AS400JDBCConnectionPoolDataSource(String serverName,
                                         String user,
                                         String password,
                                         String keyRingNameX,
                                         String keyRingPasswordX)

Deprecated.

-- keyrings are not supported.

Constructs an AS400JDBCConnectionPoolDataSource with the specified signon information to use for SSL communications with the system.

Parameters:

serverName - The IBM i system name.

user - The user id.

password - The password.

keyRingNameX - The key ring class name to be used for SSL communications with the system.

keyRingPasswordX - The password for the key ring class to be used for SSL communications with the system.

Method Detail

getPooledConnection

public PooledConnection getPooledConnection()
                                     throws SQLException

Returns a pooled connection that is connected to the IBM i system.

Specified by:

getPooledConnection in interface ConnectionPoolDataSource

Returns:

A pooled connection.

Throws:

SQLException - If a database error occurs.

getPooledConnection

public PooledConnection getPooledConnection(String user,
                                            char[] password)
                                     throws SQLException

Returns a pooled connection that is connected to the IBM i system.

Parameters:

user - The userid for the connection.

password - The password for the connection.

Returns:

A pooled connection.

Throws:

SQLException - If a database error occurs.

getPooledConnection

public PooledConnection getPooledConnection(String user,
                                            String password)
                                     throws SQLException

Deprecated.

Use getPooledConnection(String user, char[] password) instead.

Returns a pooled connection that is connected to the IBM i system.

Specified by:

getPooledConnection in interface ConnectionPoolDataSource

Parameters:

user - The userid for the connection.

password - The password for the connection.

Returns:

A pooled connection.

Throws:

SQLException - If a database error occurs.

getReference

public Reference getReference()
                       throws NamingException

Returns the Reference object for the data source object. This is used by JNDI when bound in a JNDI naming service. Contains the information necessary to reconstruct the data source object when it is later retrieved from JNDI via an object factory.

Specified by:

getReference in interface Referenceable

Overrides:

getReference in class AS400JDBCDataSource

Returns:

A Reference object for the data source object.

Throws:

NamingException - If a naming error occurs resolving the object.

getValidWrappedList

protected String[] getValidWrappedList()

Overrides:

getValidWrappedList in class AS400JDBCDataSource

isWrapperFor

public boolean isWrapperFor(Class<?> iface)
                     throws SQLException

Returns true if this either implements the interface argument or is directly or indirectly a wrapper for an object that does. Returns false otherwise. If this implements the interface then return true, else if this is a wrapper then return the result of recursively calling isWrapperFor on the wrapped object. If this does not implement the interface and is not a wrapper, return false. This method should be implemented as a low-cost operation compared to unwrap so that callers can use this method to avoid expensive unwrap calls that may fail. If this method returns true then calling unwrap with the same argument should succeed.

Specified by:

isWrapperFor in interface Wrapper

Parameters:

iface - a Class defining an interface.

Returns:

true if this implements the interface or directly or indirectly wraps an object that does.

Throws:

SQLException - If a database error occurs. if an error occurs while determining whether this is a wrapper for an object with the given interface.

unwrap

public <T> T unwrap(Class<T> iface)
             throws SQLException

Returns an object that implements the given interface to allow access to non-standard methods, or standard methods not exposed by the proxy. If the receiver implements the interface then the result is the receiver or a proxy for the receiver. If the receiver is a wrapper and the wrapped object implements the interface then the result is the wrapped object or a proxy for the wrapped object. Otherwise return the the result of calling unwrap recursively on the wrapped object or a proxy for that result. If the receiver is not a wrapper and does not implement the interface, then an SQLException is thrown.

Specified by:

unwrap in interface Wrapper

Parameters:

iface - A Class defining an interface that the result must implement.

Returns:

an object that implements the interface. May be a proxy for the actual implementing object.

Throws:

SQLException - If a database error occurs. If no object found that implements the interface