org.ow2.util.ee.metadata.common.api.struct
Interface IJAnnotationSqlDataSourceDefinition

All Superinterfaces:

Serializable

public interface IJAnnotationSqlDataSourceDefinition
extends Serializable

Manage @javax.annotation.sql.DataSourceDefinition metadata

Author:

Loic Albertin

Method Summary

String	getClassName() DataSource implementation class className.
String	getDatabaseName() Name of a database on a server
String	getDescription() Description of the data source.
int	getInitialPoolSize() Number of connections that should be created when a connection pool is initialized
int	getIsolationLevel() Isolation level for connections.
int	getLoginTimeout() The maximum time in seconds that this data source will wait while attempting to connect to a database.
int	getMaxIdleTime() The number of seconds that a physical connection should remain unused in the pool before the connection is closed for a connection pool
int	getMaxPoolSize() Maximum number of connections that should be concurrently allocated for a connection pool
int	getMaxStatements() The total number of statements that a connection pool should keep open.
int	getMinPoolSize() Minimum number of connections that should be allocated for a connection pool
String	getName() JNDI name by which the data source name will be registered.
String	getPassword() password for connection authentications
int	getPortNumber() Port number where a server is listening for requests
String[]	getProperties() Used to specify vendor specific properties and less commonly used DataSource properties.
String	getServerName() Database server name
String	getUrl() A JDBC url.
String	getUser() User name for connection authentications
boolean	isTransactional() Indicates whether a connection is transactional or not.
void	setClassName(String className) DataSource implementation class className.
void	setDatabaseName(String databaseName) Name of a database on a server
void	setDescription(String description) Description of the data source
void	setInitialPoolSize(int initialPoolSize) Number of connections that should be created when a connection pool is initialized
void	setIsolationLevel(int isolationLevel) Isolation level for connections.
void	setLoginTimeout(int loginTimeout) The maximum time in seconds that this data source will wait while attempting to connect to a database.
void	setMaxIdleTime(int maxIdleTime) The number of seconds that a physical connection should remain unused in the pool before the connection is closed for a connection pool
void	setMaxPoolSize(int maxPoolSize) Maximum number of connections that should be concurrently allocated for a connection pool
void	setMaxStatements(int maxStatements) The total number of statements that a connection pool should keep open.
void	setMinPoolSize(int minPoolSize) Minimum number of connections that should be allocated for a connection pool
void	setName(String name) JNDI name by which the data source name will be registered.
void	setPassword(String password) password for connection authentications
void	setPortNumber(int portNumber) Port number where a server is listening for requests
void	setProperties(String[] properties) Used to specify vendor specific properties and less commonly used DataSource properties.
void	setServerName(String serverName) Database server name
void	setTransactional(boolean transactional) Indicates whether a connection is transactional or not.
void	setUrl(String url) A JDBC url.
void	setUser(String user) User name for connection authentications

Method Detail

getName

String getName()

JNDI name by which the data source name will be registered.

setName

void setName(String name)

JNDI name by which the data source name will be registered.

Parameters:

name - the given JNDI name

getClassName

String getClassName()

DataSource implementation class className.

setClassName

void setClassName(String className)

DataSource implementation class className.

Parameters:

className - the given DataSource implementation class name

getDescription

String getDescription()

Description of the data source.

setDescription

void setDescription(String description)

Description of the data source

Parameters:

description - the given description

getUrl

String getUrl()

A JDBC url. If the url property is specified along with other standard DataSource properties such as serverName and portNumber, the more specific properties will take precedence and the url will be ignored

setUrl

void setUrl(String url)

A JDBC url. If the url property is specified along with other standard DataSource properties such as serverName and portNumber, the more specific properties will take precedence and the url will be ignored

Parameters:

url - the given JDBC url

getUser

String getUser()

User name for connection authentications

setUser

void setUser(String user)

User name for connection authentications

Parameters:

user - the given user name

getPassword

String getPassword()

password for connection authentications

setPassword

void setPassword(String password)

password for connection authentications

Parameters:

password - the given password

getDatabaseName

String getDatabaseName()

Name of a database on a server

setDatabaseName

void setDatabaseName(String databaseName)

Name of a database on a server

Parameters:

databaseName - the given name of the database

getPortNumber

int getPortNumber()

Port number where a server is listening for requests

setPortNumber

void setPortNumber(int portNumber)

Port number where a server is listening for requests

Parameters:

portNumber - the given port number

getServerName

String getServerName()

Database server name

setServerName

void setServerName(String serverName)

Database server name

Parameters:

serverName - the given Database server name

getIsolationLevel

int getIsolationLevel()

Isolation level for connections.

setIsolationLevel

void setIsolationLevel(int isolationLevel)

Isolation level for connections.

Parameters:

isolationLevel - the given isolation level

isTransactional

boolean isTransactional()

Indicates whether a connection is transactional or not.

setTransactional

void setTransactional(boolean transactional)

Indicates whether a connection is transactional or not.

Parameters:

transactional - Indicates whether a connection is transactional or not.

getInitialPoolSize

int getInitialPoolSize()

Number of connections that should be created when a connection pool is initialized

setInitialPoolSize

void setInitialPoolSize(int initialPoolSize)

Number of connections that should be created when a connection pool is initialized

Parameters:

initialPoolSize - the given initial connection pool size

getMaxPoolSize

int getMaxPoolSize()

Maximum number of connections that should be concurrently allocated for a connection pool

setMaxPoolSize

void setMaxPoolSize(int maxPoolSize)

Maximum number of connections that should be concurrently allocated for a connection pool

Parameters:

maxPoolSize - the given maximum connection pool size

getMinPoolSize

int getMinPoolSize()

Minimum number of connections that should be allocated for a connection pool

setMinPoolSize

void setMinPoolSize(int minPoolSize)

Minimum number of connections that should be allocated for a connection pool

Parameters:

minPoolSize - the given minimum connection pool size

getMaxIdleTime

int getMaxIdleTime()

The number of seconds that a physical connection should remain unused in the pool before the connection is closed for a connection pool

setMaxIdleTime

void setMaxIdleTime(int maxIdleTime)

The number of seconds that a physical connection should remain unused in the pool before the connection is closed for a connection pool

Parameters:

maxIdleTime - the given maximum idle time

getMaxStatements

int getMaxStatements()

The total number of statements that a connection pool should keep open. A value of 0 indicates that the caching of statements is disabled for a connection pool.

setMaxStatements

void setMaxStatements(int maxStatements)

The total number of statements that a connection pool should keep open. A value of 0 indicates that the caching of statements is disabled for a connection pool.

Parameters:

maxStatements - the given maximum statements caching

getProperties

String[] getProperties()

Used to specify vendor specific properties and less commonly used DataSource properties.

setProperties

void setProperties(String[] properties)

Used to specify vendor specific properties and less commonly used DataSource properties.

Parameters:

properties - the given properties

getLoginTimeout

int getLoginTimeout()

The maximum time in seconds that this data source will wait while attempting to connect to a database. A value of 0 specifies that the timeout is the default system timeout if there is one, otherwise it specifies that there is no timeout

setLoginTimeout

void setLoginTimeout(int loginTimeout)

The maximum time in seconds that this data source will wait while attempting to connect to a database. A value of 0 specifies that the timeout is the default system timeout if there is one, otherwise it specifies that there is no timeout

Parameters:

loginTimeout - the given login timeout