Top Description Fields Methods
org.apache.derby.client

public Interface ClientDataSourceInterface

extends DataSource
Known Direct Subinterfaces
org.apache.derby.client.ClientXADataSourceInterface, org.apache.derby.client.ClientConnectionPoolDataSourceInterface
Known Direct Implementers
org.apache.derby.client.BasicClientDataSource
Imports
javax.sql.DataSource, org.apache.derby.client.am.SqlException, org.apache.derby.client.net.NetConfiguration

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

Field Summary

Modifier and TypeField and Description
public static final short
public static final short
public static final short
public static final int
public static final boolean
public static final short
propertyDefault_securityMechanism

Default security mechanism is USER_ONLY_SECURITY.

public static final String
public static final boolean
public static final String
public static final short
public static final short
USER_ONLY_SECURITY

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

Method Summary

Modifier and TypeMethod and Description
public String
public String
public String
public String
public String
public String
public int
public boolean
public short
public short
public String
public String
public String
public String
public String
public boolean
public int
public String
public void
public void
public void
setDatabaseName(String databaseName)

public void
setDataSourceName(String dataSourceName)

public void
setDescription(String description)

public void
setPassword(String password)

public void
setPortNumber(int portNumber)

public void
setRetrieveMessageText(boolean retrieveMessageText)

public void
setSecurityMechanism(short securityMechanism)

public void
setServerName(String serverName)

public void
public void
setSsl(String mode)

public void
setTraceDirectory(String traceDirectory)

public void
setTraceFile(String traceFile)

public void
setTraceFileAppend(boolean traceFileAppend)

public void
setTraceLevel(int traceLevel)

public void
Inherited from javax.sql.DataSource:
createConnectionBuildergetConnectiongetConnectiongetLoginTimeoutgetLogWritersetLoginTimeoutsetLogWriter

Field Detail

CLEAR_TEXT_PASSWORD_SECURITYback to summary
public static final short CLEAR_TEXT_PASSWORD_SECURITY
ENCRYPTED_PASSWORD_SECURITYback to summary
public static final short ENCRYPTED_PASSWORD_SECURITY
ENCRYPTED_USER_AND_PASSWORD_SECURITYback to summary
public static final short ENCRYPTED_USER_AND_PASSWORD_SECURITY
propertyDefault_portNumberback to summary
public static final int propertyDefault_portNumber
propertyDefault_retrieveMessageTextback to summary
public static final boolean propertyDefault_retrieveMessageText
propertyDefault_securityMechanismback to summary
public static final short propertyDefault_securityMechanism

Default security mechanism is USER_ONLY_SECURITY.

propertyDefault_serverNameback to summary
public static final String propertyDefault_serverName
propertyDefault_traceFileAppendback to summary
public static final boolean propertyDefault_traceFileAppend
propertyDefault_userback to summary
public static final String propertyDefault_user
STRONG_PASSWORD_SUBSTITUTE_SECURITYback to summary
public static final short STRONG_PASSWORD_SUBSTITUTE_SECURITY
USER_ONLY_SECURITYback to summary
public 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.

Method Detail

getConnectionAttributesback to summary
public String getConnectionAttributes()
getCreateDatabaseback to summary
public String getCreateDatabase()
getDatabaseNameback to summary
public String getDatabaseName()
getDataSourceNameback to summary
public String getDataSourceName()
getDescriptionback to summary
public String getDescription()
getPasswordback to summary
public String getPassword()
getPortNumberback to summary
public int getPortNumber()
getRetrieveMessageTextback to summary
public boolean getRetrieveMessageText()
getSecurityMechanismback to summary
public short getSecurityMechanism()
getSecurityMechanismback to summary
public short getSecurityMechanism(String password)
getServerNameback to summary
public String getServerName()
getShutdownDatabaseback to summary
public String getShutdownDatabase()
getSslback to summary
public String getSsl()
getTraceDirectoryback to summary
public String getTraceDirectory()
getTraceFileback to summary
public String getTraceFile()
getTraceFileAppendback to summary
public boolean getTraceFileAppend()
getTraceLevelback to summary
public int getTraceLevel()
getUserback to summary
public String getUser()
setConnectionAttributesback to summary
public void setConnectionAttributes(String prop)
setCreateDatabaseback to summary
public void setCreateDatabase(String create)
setDatabaseNameback to summary
public void setDatabaseName(String databaseName)
setDataSourceNameback to summary
public void setDataSourceName(String dataSourceName)
setDescriptionback to summary
public void setDescription(String description)
setPasswordback to summary
public void setPassword(String password)
setPortNumberback to summary
public void setPortNumber(int portNumber)
setRetrieveMessageTextback to summary
public void setRetrieveMessageText(boolean retrieveMessageText)
setSecurityMechanismback to summary
public void setSecurityMechanism(short securityMechanism)
setServerNameback to summary
public void setServerName(String serverName)
setShutdownDatabaseback to summary
public void setShutdownDatabase(String shutdown)
setSslback to summary
public void setSsl(String mode) throws SqlException
setTraceDirectoryback to summary
public void setTraceDirectory(String traceDirectory)
setTraceFileback to summary
public void setTraceFile(String traceFile)
setTraceFileAppendback to summary
public void setTraceFileAppend(boolean traceFileAppend)
setTraceLevelback to summary
public void setTraceLevel(int traceLevel)
setUserback to summary
public void setUser(String user)