org.apache.derby.jdbc
Interface ClientDataSourceInterface

All Superinterfaces:

javax.sql.CommonDataSource, javax.sql.DataSource, java.sql.Wrapper

All Known Subinterfaces:

ClientConnectionPoolDataSourceInterface, ClientXADataSourceInterface

All Known Implementing Classes:

BasicClientConnectionPoolDataSource40, BasicClientDataSource40, BasicClientXADataSource40, ClientBaseDataSource, ClientBaseDataSourceRoot, ClientConnectionPoolDataSource, ClientConnectionPoolDataSource40, ClientDataSource, ClientDataSource40, ClientXADataSource, ClientXADataSource40

public interface ClientDataSourceInterface
extends javax.sql.DataSource

Specifies Derby extensions to the java.sqlx.DataSource API common to all Derby client driver data sources.

Field Summary

static short	CLEAR_TEXT_PASSWORD_SECURITY
static short	ENCRYPTED_PASSWORD_SECURITY
static short	ENCRYPTED_USER_AND_PASSWORD_SECURITY
static int	propertyDefault_portNumber
static boolean	propertyDefault_retrieveMessageText
static short	propertyDefault_securityMechanism Default security mechanism is USER_ONLY_SECURITY.
static java.lang.String	propertyDefault_serverName
static boolean	propertyDefault_traceFileAppend
static int	propertyDefault_traceLevel
static java.lang.String	propertyDefault_user
static short	STRONG_PASSWORD_SUBSTITUTE_SECURITY
static int	TRACE_ALL
static int	TRACE_CONNECTION_CALLS
static int	TRACE_CONNECTS
static int	TRACE_DIAGNOSTICS
static int	TRACE_DRIVER_CONFIGURATION
static int	TRACE_NONE
static int	TRACE_PARAMETER_META_DATA
static int	TRACE_PROTOCOL_FLOWS
static int	TRACE_RESULT_SET_CALLS
static int	TRACE_RESULT_SET_META_DATA
static int	TRACE_STATEMENT_CALLS
static int	TRACE_XA_CALLS
static short	USER_ONLY_SECURITY The source security mechanism to use when connecting to a client data source.

Method Summary

java.lang.String	getConnectionAttributes()
java.lang.String	getCreateDatabase()
java.lang.String	getDatabaseName()
java.lang.String	getDataSourceName()
java.lang.String	getDescription()
java.lang.String	getPassword()
int	getPortNumber()
boolean	getRetrieveMessageText()
short	getSecurityMechanism()
short	getSecurityMechanism(java.lang.String password)
java.lang.String	getServerName()
java.lang.String	getShutdownDatabase()
java.lang.String	getSsl()
java.lang.String	getTraceDirectory()
java.lang.String	getTraceFile()
boolean	getTraceFileAppend()
int	getTraceLevel()
java.lang.String	getUser()
void	setConnectionAttributes(java.lang.String prop)
void	setCreateDatabase(java.lang.String create)
void	setDatabaseName(java.lang.String databaseName)
void	setDataSourceName(java.lang.String dataSourceName)
void	setDescription(java.lang.String description)
void	setPassword(java.lang.String password)
void	setPortNumber(int portNumber)
void	setRetrieveMessageText(boolean retrieveMessageText)
void	setSecurityMechanism(short securityMechanism)
void	setServerName(java.lang.String serverName)
void	setShutdownDatabase(java.lang.String shutdown)
void	setSsl(java.lang.String mode)
void	setTraceDirectory(java.lang.String traceDirectory)
void	setTraceFile(java.lang.String traceFile)
void	setTraceFileAppend(boolean traceFileAppend)
void	setTraceLevel(int traceLevel)
void	setUser(java.lang.String user)

Methods inherited from interface javax.sql.DataSource

getConnection, getConnection

Methods inherited from interface javax.sql.CommonDataSource

getLoginTimeout, getLogWriter, setLoginTimeout, setLogWriter

Methods inherited from interface java.sql.Wrapper

isWrapperFor, unwrap

Field Detail

propertyDefault_portNumber

static final int propertyDefault_portNumber

See Also:

Constant Field Values

propertyDefault_serverName

static final java.lang.String propertyDefault_serverName

See Also:

Constant Field Values

propertyDefault_user

static final java.lang.String propertyDefault_user

See Also:

Constant Field Values

propertyDefault_retrieveMessageText

static final boolean propertyDefault_retrieveMessageText

See Also:

Constant Field Values

USER_ONLY_SECURITY

static final short USER_ONLY_SECURITY

The source security mechanism to use when connecting to a client data source.

Security mechanism options are:

• USER_ONLY_SECURITY
• CLEAR_TEXT_PASSWORD_SECURITY
• ENCRYPTED_PASSWORD_SECURITY
• ENCRYPTED_USER_AND_PASSWORD_SECURITY - both password and user are encrypted
• STRONG_PASSWORD_SUBSTITUTE_SECURITY

The default security mechanism is USER_ONLY SECURITY

If the application specifies a security mechanism then it will be the only one attempted. If the specified security mechanism is not supported by the conversation then an exception will be thrown and there will be no additional retries.

Both user and password need to be set for all security mechanism except USER_ONLY_SECURITY.

See Also:

Constant Field Values

CLEAR_TEXT_PASSWORD_SECURITY

static final short CLEAR_TEXT_PASSWORD_SECURITY

See Also:

Constant Field Values

ENCRYPTED_PASSWORD_SECURITY

static final short ENCRYPTED_PASSWORD_SECURITY

See Also:

Constant Field Values

ENCRYPTED_USER_AND_PASSWORD_SECURITY

static final short ENCRYPTED_USER_AND_PASSWORD_SECURITY

See Also:

Constant Field Values

STRONG_PASSWORD_SUBSTITUTE_SECURITY

static final short STRONG_PASSWORD_SUBSTITUTE_SECURITY

See Also:

Constant Field Values

propertyDefault_securityMechanism

static final short propertyDefault_securityMechanism

Default security mechanism is USER_ONLY_SECURITY.

See Also:

Constant Field Values

propertyDefault_traceFileAppend

static final boolean propertyDefault_traceFileAppend

See Also:

Constant Field Values

TRACE_NONE

static final int TRACE_NONE

See Also:

Constant Field Values

TRACE_CONNECTION_CALLS

static final int TRACE_CONNECTION_CALLS

See Also:

Constant Field Values

TRACE_STATEMENT_CALLS

static final int TRACE_STATEMENT_CALLS

See Also:

Constant Field Values

TRACE_RESULT_SET_CALLS

static final int TRACE_RESULT_SET_CALLS

See Also:

Constant Field Values

TRACE_DRIVER_CONFIGURATION

static final int TRACE_DRIVER_CONFIGURATION

See Also:

Constant Field Values

TRACE_CONNECTS

static final int TRACE_CONNECTS

See Also:

Constant Field Values

TRACE_PROTOCOL_FLOWS

static final int TRACE_PROTOCOL_FLOWS

See Also:

Constant Field Values

TRACE_RESULT_SET_META_DATA

static final int TRACE_RESULT_SET_META_DATA

See Also:

Constant Field Values

TRACE_PARAMETER_META_DATA

static final int TRACE_PARAMETER_META_DATA

See Also:

Constant Field Values

TRACE_DIAGNOSTICS

static final int TRACE_DIAGNOSTICS

See Also:

Constant Field Values

TRACE_XA_CALLS

static final int TRACE_XA_CALLS

See Also:

Constant Field Values

TRACE_ALL

static final int TRACE_ALL

See Also:

Constant Field Values

propertyDefault_traceLevel

static final int propertyDefault_traceLevel

See Also:

Constant Field Values

Method Detail

setPassword

void setPassword(java.lang.String password)

getPassword

java.lang.String getPassword()

setDatabaseName

void setDatabaseName(java.lang.String databaseName)

getDatabaseName

java.lang.String getDatabaseName()

setDataSourceName

void setDataSourceName(java.lang.String dataSourceName)

getDataSourceName

java.lang.String getDataSourceName()

setDescription

void setDescription(java.lang.String description)

getDescription

java.lang.String getDescription()

setPortNumber

void setPortNumber(int portNumber)

getPortNumber

int getPortNumber()

setServerName

void setServerName(java.lang.String serverName)

getServerName

java.lang.String getServerName()

setUser

void setUser(java.lang.String user)

getUser

java.lang.String getUser()

setRetrieveMessageText

void setRetrieveMessageText(boolean retrieveMessageText)

getRetrieveMessageText

boolean getRetrieveMessageText()

setSecurityMechanism

void setSecurityMechanism(short securityMechanism)

getSecurityMechanism

short getSecurityMechanism()

getSecurityMechanism

short getSecurityMechanism(java.lang.String password)

setSsl

void setSsl(java.lang.String mode)
            throws SqlException

Throws:

SqlException

getSsl

java.lang.String getSsl()

setCreateDatabase

void setCreateDatabase(java.lang.String create)

getCreateDatabase

java.lang.String getCreateDatabase()

setShutdownDatabase

void setShutdownDatabase(java.lang.String shutdown)

getShutdownDatabase

java.lang.String getShutdownDatabase()

setConnectionAttributes

void setConnectionAttributes(java.lang.String prop)

getConnectionAttributes

java.lang.String getConnectionAttributes()

setTraceLevel

void setTraceLevel(int traceLevel)

getTraceLevel

int getTraceLevel()

setTraceFile

void setTraceFile(java.lang.String traceFile)

getTraceFile

java.lang.String getTraceFile()

setTraceDirectory

void setTraceDirectory(java.lang.String traceDirectory)

getTraceDirectory

java.lang.String getTraceDirectory()

setTraceFileAppend

void setTraceFileAppend(boolean traceFileAppend)

getTraceFileAppend

boolean getTraceFileAppend()