javax.sql.CommonDataSource
SQLServerConnectionPoolDataSource
, SQLServerDataSource
, SQLServerXADataSource
public interface ISQLServerDataSource
extends javax.sql.CommonDataSource
SQLServerDataSource
Class.Modifier and Type | Method | Description |
---|---|---|
java.lang.String |
getAccessToken() |
Returns the access token.
|
java.lang.String |
getApplicationIntent() |
Returns the application intent.
|
java.lang.String |
getApplicationName() |
Returns the application name.
|
java.lang.String |
getAuthentication() |
Returns the authentication mode.
|
int |
getCancelQueryTimeout() |
Returns the cancel timeout.
|
java.lang.String |
getColumnEncryptionSetting() |
Returns the Always Encrypted functionality setting for the data source object.
|
java.lang.String |
getDatabaseName() |
Returns the database name.
|
java.lang.String |
getDescription() |
Returns a description of the data source.
|
boolean |
getDisableStatementPooling() |
Returns whether statement pooling is disabled.
|
boolean |
getEnablePrepareOnFirstPreparedStatementCall() |
Returns the value that indicates whether the first execution of a prepared statement will call sp_executesql and
not prepare a statement.
|
boolean |
getEncrypt() |
Returns a Boolean value that indicates if the encrypt property is enabled.
|
java.lang.String |
getFailoverPartner() |
Returns the name of the failover server that is used in a database mirroring configuration.
|
boolean |
getFIPS() |
Returns the value of connection property "fips".
|
org.ietf.jgss.GSSCredential |
getGSSCredentials() |
Returns the GSSCredential.
|
java.lang.String |
getHostNameInCertificate() |
Returns the host name used in validating the SQL Server Secure Sockets Layer (SSL) certificate.
|
java.lang.String |
getInstanceName() |
Returns the SQL Server instance name.
|
java.lang.String |
getJASSConfigurationName() |
Returns the login configuration file for Kerberos authentication.
|
java.lang.String |
getKeyStoreAuthentication() |
Returns the value of the keyStoreAuthentication setting for the data source object.
|
java.lang.String |
getKeyStoreLocation() |
Returns the keyStoreLocation for the Java Key Store.
|
boolean |
getLastUpdateCount() |
Returns a Boolean value that indicates if the lastUpdateCount property is enabled.
|
int |
getLockTimeout() |
Returns an int value that indicates the number of milliseconds that the database will wait before reporting a
lock time out.
|
boolean |
getMultiSubnetFailover() |
Returns the value of the multiSubnetFailover connection property.
|
int |
getPacketSize() |
Returns the current network packet size used to communicate with SQL Server, specified in bytes.
|
int |
getPortNumber() |
Returns the current port number that is used to communicate with SQL Server.
|
int |
getQueryTimeout() |
Returns the query timeout.
|
java.lang.String |
getResponseBuffering() |
Returns the response buffering mode for this SQLServerDataSource object.
|
java.lang.String |
getSelectMethod() |
Returns the default cursor type used for all result sets that are created by using this SQLServerDataSource
object.
|
boolean |
getSendStringParametersAsUnicode() |
Returns whether sending string parameters to the server in UNICODE format is enabled.
|
boolean |
getSendTimeAsDatetime() |
Returns the value of the sendTimeAsDatetime connection property.
|
java.lang.String |
getServerName() |
Returns the name of the SQL Server instance.
|
boolean |
getServerNameAsACE() |
Returns if the serverName should be translated from Unicode to ASCII Compatible Encoding (ACE).
|
int |
getServerPreparedStatementDiscardThreshold() |
Returns the value of the setting that controls how many outstanding prepared statement discard actions
(sp_unprepare) can be outstanding per connection before a call to clean-up the outstanding handles on the server
is executed.
|
java.lang.String |
getServerSpn() |
Returns the server spn.
|
int |
getSocketTimeout() |
Returns the socket timeout value.
|
java.lang.String |
getSSLProtocol() |
Returns the value of connection property 'sslProtocol'.
|
int |
getStatementPoolingCacheSize() |
Returns the size of the prepared statement cache for this connection.
|
boolean |
getTransparentNetworkIPResolution() |
Returns the TransparentNetworkIPResolution value.
|
java.lang.String |
getTrustManagerClass() |
Returns the value for the connection property 'trustManagerClass'.
|
java.lang.String |
getTrustManagerConstructorArg() |
Returns the value for the connection property 'trustManagerConstructorArg'.
|
boolean |
getTrustServerCertificate() |
Returns a Boolean value that indicates if the trustServerCertificate property is enabled.
|
java.lang.String |
getTrustStore() |
Returns the path (including file name) to the certificate trustStore file.
|
java.lang.String |
getTrustStoreType() |
Returns the keyStore Type for the trustStore.
|
java.lang.String |
getURL() |
Returns the URL that is used to connect to the data source.
|
boolean |
getUseBulkCopyForBatchInsert() |
Returns whether the use Bulk Copy API is used for Batch Insert.
|
java.lang.String |
getUser() |
Returns the user name that is used to connect the data source.
|
java.lang.String |
getWorkstationID() |
Returns the name of the client computer name that is used to connect to the data source.
|
boolean |
getXopenStates() |
Returns the value that indicates if converting SQL states to XOPEN compliant states is enabled.
|
void |
setAccessToken(java.lang.String accessToken) |
Sets the access token.
|
void |
setApplicationIntent(java.lang.String applicationIntent) |
Sets the application intent.
|
void |
setApplicationName(java.lang.String applicationName) |
Sets the application name.
|
void |
setAuthentication(java.lang.String authentication) |
Sets the authentication mode.
|
void |
setAuthenticationScheme(java.lang.String authenticationScheme) |
Sets the kind of integrated security you want your application to use.
|
void |
setCancelQueryTimeout(int cancelQueryTimeout) |
Sets the cancel timeout.
|
void |
setColumnEncryptionSetting(java.lang.String columnEncryptionSetting) |
Sets the value to enable/disable Always Encrypted functionality for the data source object.
|
void |
setDatabaseName(java.lang.String databaseName) |
Sets the database name to connect to.
|
void |
setDescription(java.lang.String description) |
Sets the description of the data source.
|
void |
setDisableStatementPooling(boolean disableStatementPooling) |
Sets the value to disable/enable statement pooling.
|
void |
setEnablePrepareOnFirstPreparedStatementCall(boolean enablePrepareOnFirstPreparedStatementCall) |
Sets the value that enables/disables whether the first execution of a prepared statement will call sp_executesql
and not prepare a statement.
|
void |
setEncrypt(boolean encrypt) |
Sets a Boolean value that indicates if the encrypt property is enabled.
|
void |
setFailoverPartner(java.lang.String serverName) |
Sets the name of the failover server that is used in a database mirroring configuration.
|
void |
setFIPS(boolean fips) |
Sets whether Fips Mode should be enabled/disabled on the connection.
|
void |
setGSSCredentials(org.ietf.jgss.GSSCredential userCredential) |
Sets the GSSCredential.
|
void |
setHostNameInCertificate(java.lang.String hostName) |
Sets the host name to be used in validating the SQL Server Secure Sockets Layer (SSL) certificate.
|
void |
setInstanceName(java.lang.String instanceName) |
Sets the SQL Server instance name.
|
void |
setIntegratedSecurity(boolean enable) |
Sets a Boolean value that indicates if the integratedSecurity property is enabled.
|
void |
setJASSConfigurationName(java.lang.String configurationName) |
Sets the login configuration file for Kerberos authentication.
|
void |
setKeyStoreAuthentication(java.lang.String keyStoreAuthentication) |
Sets the name that identifies a key store.
|
void |
setKeyStoreLocation(java.lang.String keyStoreLocation) |
Sets the location including the file name for the Java keystore.
|
void |
setKeyStoreSecret(java.lang.String keyStoreSecret) |
Sets the password for the Java keystore.
|
void |
setLastUpdateCount(boolean lastUpdateCount) |
Sets a Boolean value that indicates if the lastUpdateCount property is enabled.
|
void |
setLockTimeout(int lockTimeout) |
Sets an int value that indicates the number of milliseconds to wait before the database reports a lock time out.
|
void |
setMultiSubnetFailover(boolean multiSubnetFailover) |
Sets the value of the multiSubnetFailover connection property.
|
void |
setPacketSize(int packetSize) |
Sets the current network packet size used to communicate with SQL Server, specified in bytes.
|
void |
setPassword(java.lang.String password) |
Sets the password that will be used to connect to SQL Server.
|
void |
setPortNumber(int portNumber) |
Sets the port number to be used to communicate with SQL Server.
|
void |
setQueryTimeout(int queryTimeout) |
Setting the query timeout.
|
void |
setResponseBuffering(java.lang.String bufferingMode) |
Sets the response buffering mode for connections created by using this SQLServerDataSource object.
|
void |
setSelectMethod(java.lang.String selectMethod) |
Sets the default cursor type that is used for all result sets that are created by using this SQLServerDataSource
object.
|
void |
setSendStringParametersAsUnicode(boolean sendStringParametersAsUnicode) |
Sets a boolean value that indicates if sending string parameters to the server in UNICODE format is enabled.
|
void |
setSendTimeAsDatetime(boolean sendTimeAsDatetime) |
Sets the value to enable/disable the sendTimeAsDatetime connection property.
|
void |
setServerName(java.lang.String serverName) |
Sets the name of the computer that is running SQL Server.
|
void |
setServerNameAsACE(boolean serverNameAsACE) |
Sets whether the serverName will be translated from Unicode to ASCII Compatible Encoding (ACE).
|
void |
setServerPreparedStatementDiscardThreshold(int serverPreparedStatementDiscardThreshold) |
Sets the value that controls how many outstanding prepared statement discard actions (sp_unprepare) can be
outstanding per connection before a call to clean-up the outstanding handles on the server is executed.
|
void |
setServerSpn(java.lang.String serverSpn) |
Sets the server spn.
|
void |
setSocketTimeout(int socketTimeout) |
Sets the socket timeout value.
|
void |
setSSLProtocol(java.lang.String sslProtocol) |
Sets the sslProtocol property for connection Set this value to specify TLS protocol keyword.
|
void |
setStatementPoolingCacheSize(int statementPoolingCacheSize) |
Sets the size of the prepared statement cache for this connection.
|
void |
setTransparentNetworkIPResolution(boolean tnir) |
Sets the value to enable/disable Transparent Netowrk IP Resolution (TNIR).
|
void |
setTrustManagerClass(java.lang.String trustManagerClass) |
Sets the connection property 'trustManagerClass' on the connection.
|
void |
setTrustManagerConstructorArg(java.lang.String trustManagerConstructorArg) |
Sets Constructor Arguments to be provided on constructor of 'trustManagerClass'.
|
void |
setTrustServerCertificate(boolean e) |
Sets a Boolean value that indicates if the trustServerCertificate property is enabled.
|
void |
setTrustStore(java.lang.String trustStore) |
Sets the path (including file name) to the certificate trustStore file.
|
void |
setTrustStorePassword(java.lang.String trustStorePassword) |
Sets the password that is used to check the integrity of the trustStore data.
|
void |
setTrustStoreType(java.lang.String trustStoreType) |
Sets the keystore type for the trustStore.
|
void |
setURL(java.lang.String url) |
Sets the URL that is used to connect to the data source.
|
void |
setUseBulkCopyForBatchInsert(boolean useBulkCopyForBatchInsert) |
Sets whether the use Bulk Copy API should be used for Batch Insert.
|
void |
setUser(java.lang.String user) |
Sets the user name that is used to connect the data source.
|
void |
setWorkstationID(java.lang.String workstationID) |
Sets the name of the client computer name that is used to connect to the data source.
|
void |
setXopenStates(boolean xopenStates) |
Sets whether converting SQL states to XOPEN compliant states is enabled.
|
void setApplicationIntent(java.lang.String applicationIntent)
applicationIntent
- A String that contains the application intent.java.lang.String getApplicationIntent()
void setApplicationName(java.lang.String applicationName)
applicationName
- A String that contains the name of the application.java.lang.String getApplicationName()
void setDatabaseName(java.lang.String databaseName)
databaseName
- A String that contains the database name.java.lang.String getDatabaseName()
void setInstanceName(java.lang.String instanceName)
instanceName
- A String that contains the instance name.java.lang.String getInstanceName()
void setIntegratedSecurity(boolean enable)
enable
- true if integratedSecurity is enabled. Otherwise, false.void setLastUpdateCount(boolean lastUpdateCount)
lastUpdateCount
- true if lastUpdateCount is enabled. Otherwise, false.boolean getLastUpdateCount()
void setEncrypt(boolean encrypt)
encrypt
- true if the Secure Sockets Layer (SSL) encryption is enabled between the client and the SQL Server.
Otherwise, false.boolean getEncrypt()
void setTransparentNetworkIPResolution(boolean tnir)
transparentNetworkIPResolution is ignored if multiSubnetFailover is true
transparentNetworkIPResolution is ignored if database mirroring is used
transparentNetworkIPResolution is ignored if there are more than 64 IP addresses
tnir
- if set to true, the driver attempts to connect to the first IP address available. It is true by default.boolean getTransparentNetworkIPResolution()
void setTrustServerCertificate(boolean e)
e
- true, if the server Secure Sockets Layer (SSL) certificate should be automatically trusted when the
communication layer is encrypted using SSL. Otherwise, false.boolean getTrustServerCertificate()
void setTrustStoreType(java.lang.String trustStoreType)
trustStoreType
- A String that contains the trust store typejava.lang.String getTrustStoreType()
void setTrustStore(java.lang.String trustStore)
trustStore
- A String that contains the path (including file name) to the certificate trustStore file.java.lang.String getTrustStore()
void setTrustStorePassword(java.lang.String trustStorePassword)
trustStorePassword
- A String that contains the password that is used to check the integrity of the trustStore data.void setHostNameInCertificate(java.lang.String hostName)
hostName
- A String that contains the host name.java.lang.String getHostNameInCertificate()
void setLockTimeout(int lockTimeout)
lockTimeout
- An int value that contains the number of milliseconds to wait.int getLockTimeout()
void setPassword(java.lang.String password)
password
- A String that contains the password.void setPortNumber(int portNumber)
portNumber
- An int value that contains the port number.int getPortNumber()
void setSelectMethod(java.lang.String selectMethod)
selectMethod
- A String value that contains the default cursor type.java.lang.String getSelectMethod()
void setResponseBuffering(java.lang.String bufferingMode)
bufferingMode
- A String that contains the buffering and streaming mode. The valid mode can be one of the following
case-insensitive Strings: full or adaptive.java.lang.String getResponseBuffering()
void setSendTimeAsDatetime(boolean sendTimeAsDatetime)
sendTimeAsDatetime
- A Boolean value. When true, causes java.sql.Time values to be sent to the server as SQL Server datetime
types. When false, causes java.sql.Time values to be sent to the server as SQL Server time types.boolean getSendTimeAsDatetime()
void setSendStringParametersAsUnicode(boolean sendStringParametersAsUnicode)
sendStringParametersAsUnicode
- true if string parameters are sent to the server in UNICODE format. Otherwise, false.boolean getSendStringParametersAsUnicode()
void setServerNameAsACE(boolean serverNameAsACE)
serverNameAsACE
- if enabled the servername will be translated to ASCII Compatible Encoding (ACE)boolean getServerNameAsACE()
void setServerName(java.lang.String serverName)
serverName
- A String that contains the server name.java.lang.String getServerName()
void setFailoverPartner(java.lang.String serverName)
serverName
- A String that contains the failover server name.java.lang.String getFailoverPartner()
void setMultiSubnetFailover(boolean multiSubnetFailover)
multiSubnetFailover
- The new value of the multiSubnetFailover connection property.boolean getMultiSubnetFailover()
void setUser(java.lang.String user)
user
- A String that contains the user name.java.lang.String getUser()
void setWorkstationID(java.lang.String workstationID)
workstationID
- A String that contains the client computer name.java.lang.String getWorkstationID()
void setXopenStates(boolean xopenStates)
xopenStates
- true if converting SQL states to XOPEN compliant states is enabled. Otherwise, false.boolean getXopenStates()
void setURL(java.lang.String url)
url
- A String that contains the URL.java.lang.String getURL()
void setDescription(java.lang.String description)
description
- A String that contains the description.java.lang.String getDescription()
void setPacketSize(int packetSize)
packetSize
- An int value containing the network packet size.int getPacketSize()
void setAuthenticationScheme(java.lang.String authenticationScheme)
authenticationScheme
- Values are "JavaKerberos" and the default "NativeAuthentication".void setAuthentication(java.lang.String authentication)
authentication
- the authentication modejava.lang.String getAuthentication()
void setServerSpn(java.lang.String serverSpn)
serverSpn
- A String that contains the server spnjava.lang.String getServerSpn()
void setGSSCredentials(org.ietf.jgss.GSSCredential userCredential)
userCredential
- the credentialorg.ietf.jgss.GSSCredential getGSSCredentials()
void setAccessToken(java.lang.String accessToken)
accessToken
- to be set in the string property.java.lang.String getAccessToken()
void setColumnEncryptionSetting(java.lang.String columnEncryptionSetting)
columnEncryptionSetting
- Enables/disables Always Encrypted functionality for the data source object. The default is Disabled.java.lang.String getColumnEncryptionSetting()
void setKeyStoreAuthentication(java.lang.String keyStoreAuthentication)
keyStoreAuthentication
- the name that identifies a key store.java.lang.String getKeyStoreAuthentication()
void setKeyStoreSecret(java.lang.String keyStoreSecret)
keyStoreSecret
- the password to use for the keystore as well as for the keyvoid setKeyStoreLocation(java.lang.String keyStoreLocation)
keyStoreLocation
- the location including the file name for the Java keystore.java.lang.String getKeyStoreLocation()
void setQueryTimeout(int queryTimeout)
queryTimeout
- The number of seconds to wait before a timeout has occurred on a query. The default value is 0, which
means infinite timeout.int getQueryTimeout()
void setCancelQueryTimeout(int cancelQueryTimeout)
cancelQueryTimeout
- The number of seconds to wait before we wait for the query timeout to happen.int getCancelQueryTimeout()
void setEnablePrepareOnFirstPreparedStatementCall(boolean enablePrepareOnFirstPreparedStatementCall)
enablePrepareOnFirstPreparedStatementCall
- Changes the setting per the description.boolean getEnablePrepareOnFirstPreparedStatementCall()
void setServerPreparedStatementDiscardThreshold(int serverPreparedStatementDiscardThreshold)
serverPreparedStatementDiscardThreshold
- Changes the setting per the description.int getServerPreparedStatementDiscardThreshold()
void setStatementPoolingCacheSize(int statementPoolingCacheSize)
statementPoolingCacheSize
- Changes the setting per the description.int getStatementPoolingCacheSize()
void setDisableStatementPooling(boolean disableStatementPooling)
disableStatementPooling
- true to disable statement pooling, false to enable it.boolean getDisableStatementPooling()
void setSocketTimeout(int socketTimeout)
socketTimeout
- The number of milliseconds to wait before a timeout is occurred on a socket read or accept. The default
value is 0, which means infinite timeout.int getSocketTimeout()
void setJASSConfigurationName(java.lang.String configurationName)
configurationName
- the configuration namejava.lang.String getJASSConfigurationName()
void setFIPS(boolean fips)
fips
- Boolean property to enable/disable fipsboolean getFIPS()
void setSSLProtocol(java.lang.String sslProtocol)
sslProtocol
- Value for SSL Protocol to be set.java.lang.String getSSLProtocol()
void setTrustManagerClass(java.lang.String trustManagerClass)
trustManagerClass
- The fully qualified class name of a custom javax.net.ssl.TrustManager.java.lang.String getTrustManagerClass()
void setTrustManagerConstructorArg(java.lang.String trustManagerConstructorArg)
trustManagerConstructorArg
- 'trustManagerClass' constructor argumentsjava.lang.String getTrustManagerConstructorArg()
boolean getUseBulkCopyForBatchInsert()
void setUseBulkCopyForBatchInsert(boolean useBulkCopyForBatchInsert)
useBulkCopyForBatchInsert
- indicates whether Bulk Copy API should be used for Batch Insert operations.Copyright © 2018 Microsoft Corporation. All rights reserved.