public class JdbcConnectionDescriptor extends java.lang.Object implements java.io.Serializable, XmlCapable
Modifier and Type | Field and Description |
---|---|
static int |
AUTO_COMMIT_IGNORE_STATE |
static int |
AUTO_COMMIT_SET_FALSE |
static int |
AUTO_COMMIT_SET_TRUE_AND_TEMPORARY_FALSE |
_NEXT, ACCEPT_LOCKS, ACCESS, ATTRIBUTE, ATTRIBUTE_NAME, ATTRIBUTE_VALUE, AUTO_DELETE, AUTO_INCREMENT, AUTO_RETRIEVE, AUTO_UPDATE, BATCH_MODE, CASCADE_LINK_STR, CASCADE_NONE_STR, CASCADE_OBJECT_STR, CLASS_DESCRIPTOR, CLASS_EXTENT, CLASS_NAME, CLASS_PROXY, CLASS_REF, COLLECTION_CLASS, COLLECTION_DESCRIPTOR, COLUMN_NAME, CON_LOG_ABANDONED, CON_MAX_ACTIVE, CON_MAX_IDLE, CON_MAX_WAIT, CON_MIN_EVICTABLE_IDLE_TIME_MILLIS, CON_NUM_TESTS_PER_EVICTION_RUN, CON_REMOVE_ABANDONED, CON_REMOVE_ABANDONED_TIMEOUT, CON_TEST_ON_BORROW, CON_TEST_ON_RETURN, CON_TEST_WHILE_IDLE, CON_TIME_BETWEEN_EVICTION_RUNS_MILLIS, CON_WHEN_EXHAUSTED_ACTION, CONNECTION_FACTORY, CONNECTION_POOL, CONSTANT_ARGUMENT, DATASOURCE_NAME, DBMS_NAME, DEFAULT_CONNECTION, DELETE_PROCEDURE, DOCUMENTATION, DRIVER_NAME, EAGER_RELEASE, EXTENDS, FACTORY_CLASS, FACTORY_METHOD, FIELD_CONVERSION, FIELD_DESCRIPTOR, FIELD_ID_REF, FIELD_NAME, FIELD_REF, FK_POINTING_TO_ITEMS_CLASS, FK_POINTING_TO_THIS_CLASS, FOREIGN_KEY, ID, IGNORE_AUTOCOMMIT_EXCEPTION, INCLUDE_ALL_FIELDS, INCLUDE_PK_FIELDS_ONLY, INDEX_COLUMN, INDEX_DESCRIPTOR, INDEXED, INDIRECTION_TABLE, INITIALIZATION_METHOD, INSERT_PROCEDURE, INVERSE_FK, ISOLATION_LEVEL, ITEMS_CLASS, JCD_ALIAS, JDBC_CONNECTION_DESCRIPTOR, JDBC_LEVEL, JDBC_TYPE, LENGTH, LOCKING, MAPPING_REPOSITORY, NAME, NULLABLE, OBJECT_CACHE, ORDERBY, OTM_DEPENDENT, PRECISION, PRIMARY_KEY, PROXY_PREFETCHING_LIMIT, PROXY_REFERENCE, QUERY_CUSTOMIZER, REFERENCE_DESCRIPTOR, REFERENCED_CLASS, REFRESH, REPOSITORY_VERSION, RETURN, RETURN_FIELD_REF, ROW_READER, RUNTIME_ARGUMENT, SCALE, SCHEMA_NAME, SEQUENCE_MANAGER, SEQUENCE_MANAGER_CLASS, SEQUENCE_NAME, SORT, TABLE_NAME, TAG_ACCESS, TAG_ACCESS_ANONYMOUS, TAG_ACCESS_READONLY, TAG_ACCESS_READWRITE, TAG_SUPER, UNIQUE, UPDATE_LOCK, UPDATE_PROCEDURE, URL_DBALIAS, URL_PROTOCOL, URL_SUBPROTOCOL, USE_AUTOCOMMIT, USER_NAME, USER_PASSWD, VALIDATION_QUERY, VALUE
Constructor and Description |
---|
JdbcConnectionDescriptor()
Constructor declaration
|
Modifier and Type | Method and Description |
---|---|
void |
addAttribute(java.lang.String attributeName,
java.lang.String attributeValue)
Store the specified attribute and it's value.
|
java.lang.String |
getAttribute(java.lang.String attributeName)
Get the value of an attribute
|
java.lang.String |
getAttribute(java.lang.String attributeName,
java.lang.String defaultValue)
Get the value of an attribute
|
java.lang.String[] |
getAttributeNames()
Returns an array of the names of all atributes of this descriptor.
|
java.util.Map |
getAttributes()
Returns the attribute map (name, value) of this descriptor.
|
boolean |
getBatchMode() |
ConnectionPoolDescriptor |
getConnectionPoolDescriptor()
Returns the connection pool descriptor.
|
javax.sql.DataSource |
getDataSource()
Returns the data source that this connection descriptor represents if any.
|
java.lang.String |
getDatasourceName()
Gets the datasourceName.
|
java.lang.String |
getDbAlias()
Returns the database alias name
used by OJB.
|
java.lang.String |
getDbms()
Returns the database platform name.
|
java.lang.String |
getDriver()
Returns the driver name.
|
boolean |
getEagerRelease() |
java.lang.String |
getJcdAlias()
Get the alias name for this descriptor.
|
double |
getJdbcLevel()
Gets the jdbcLevel.
|
ObjectCacheDescriptor |
getObjectCacheDescriptor()
Returns the appropriate
ObjectCacheDescriptor
or null if not specified. |
java.lang.String |
getPassWord()
Returns the database password.
|
PBKey |
getPBKey()
Return a key to identify the connection descriptor.
|
java.lang.String |
getProtocol()
Returns the database protocol.
|
SequenceDescriptor |
getSequenceDescriptor()
Return the associated
SequenceDescriptor
or null if not set. |
java.lang.String |
getSubProtocol()
Returns the database sub-protocol.
|
int |
getUseAutoCommit() |
java.lang.String |
getUserName()
Returns the database user name.
|
boolean |
isDataSource() |
boolean |
isDefaultConnection() |
boolean |
isIgnoreAutoCommitExceptions() |
void |
setBatchMode(boolean flag) |
void |
setConnectionPoolDescriptor(ConnectionPoolDescriptor cpd)
Sets the connection pool descriptor.
|
void |
setDataSource(javax.sql.DataSource dataSource)
Sets the data source that this connection descriptor represents.
|
void |
setDatasourceName(java.lang.String datasourceName)
Sets the datasourceName.
|
void |
setDbAlias(java.lang.String str)
Sets the database alias name.
|
void |
setDbms(java.lang.String str)
Sets the database platform name.
|
void |
setDefaultConnection(boolean defaultConnection) |
void |
setDriver(java.lang.String str)
Set the database driver.
|
void |
setEagerRelease(boolean flag) |
void |
setIgnoreAutoCommitExceptions(boolean ignoreAutoCommitExceptions) |
void |
setJcdAlias(java.lang.String jcdAlias)
Set an alias name for this descriptor.
|
void |
setJdbcLevel(double jdbcLevel) |
void |
setJdbcLevel(java.lang.String jdbcLevel)
Sets the jdbcLevel.
|
void |
setObjectCacheDescriptor(ObjectCacheDescriptor objectCacheDescriptor)
Sets the
ObjectCacheDescriptor for representing connection/database. |
void |
setPassWord(java.lang.String str)
Sets the database password.
|
void |
setProtocol(java.lang.String str)
Sets the database protocol.
|
void |
setSequenceDescriptor(SequenceDescriptor sequenceDescriptor)
Set the
SequenceDescriptor for this
connection descriptor. |
void |
setSubProtocol(java.lang.String str)
Sets the database sub-protocol.
|
void |
setUseAutoCommit(int useAutoCommit) |
void |
setUserName(java.lang.String str)
Sets the database user name.
|
java.lang.String |
toString()
Returns a String representation of this class.
|
java.lang.String |
toXML()
returns the XML marshalled version of this instance.
|
public static final int AUTO_COMMIT_IGNORE_STATE
public static final int AUTO_COMMIT_SET_TRUE_AND_TEMPORARY_FALSE
public static final int AUTO_COMMIT_SET_FALSE
public JdbcConnectionDescriptor()
public ObjectCacheDescriptor getObjectCacheDescriptor()
ObjectCacheDescriptor
or null
if not specified.public void setObjectCacheDescriptor(ObjectCacheDescriptor objectCacheDescriptor)
ObjectCacheDescriptor
for representing connection/database.public javax.sql.DataSource getDataSource()
null
public void setDataSource(javax.sql.DataSource dataSource)
dataSource
- The data sourcepublic java.lang.String getJcdAlias()
public void setJcdAlias(java.lang.String jcdAlias)
public boolean isDefaultConnection()
public boolean isDataSource()
public void setDefaultConnection(boolean defaultConnection)
public SequenceDescriptor getSequenceDescriptor()
SequenceDescriptor
or null
if not set.public void setSequenceDescriptor(SequenceDescriptor sequenceDescriptor)
SequenceDescriptor
for this
connection descriptor.public ConnectionPoolDescriptor getConnectionPoolDescriptor()
public void setConnectionPoolDescriptor(ConnectionPoolDescriptor cpd)
public PBKey getPBKey()
public int getUseAutoCommit()
public void setUseAutoCommit(int useAutoCommit)
public boolean isIgnoreAutoCommitExceptions()
public void setIgnoreAutoCommitExceptions(boolean ignoreAutoCommitExceptions)
public java.lang.String getDbms()
public void setDbms(java.lang.String str)
public java.lang.String getDriver()
public void setDriver(java.lang.String str)
public java.lang.String getProtocol()
public void setProtocol(java.lang.String str)
public java.lang.String getSubProtocol()
public void setSubProtocol(java.lang.String str)
public java.lang.String getDbAlias()
public void setDbAlias(java.lang.String str)
public java.lang.String getUserName()
public void setUserName(java.lang.String str)
public java.lang.String getPassWord()
public void setPassWord(java.lang.String str)
public java.lang.String getDatasourceName()
public void setDatasourceName(java.lang.String datasourceName)
datasourceName
- The datasourceName to setpublic double getJdbcLevel()
public void setJdbcLevel(java.lang.String jdbcLevel)
jdbcLevel
- The jdbcLevel to setpublic void setJdbcLevel(double jdbcLevel)
public boolean getEagerRelease()
public void setEagerRelease(boolean flag)
public boolean getBatchMode()
public void setBatchMode(boolean flag)
public java.lang.String toString()
public java.lang.String toXML()
XmlCapable
toXML
in interface XmlCapable
public void addAttribute(java.lang.String attributeName, java.lang.String attributeValue)
AttributeContainer
addAttribute
in interface AttributeContainer
attributeName
- the name of the attribute to retrieveattributeValue
- the attribute's valueAttributeContainer.addAttribute(String, String)
public java.lang.String getAttribute(java.lang.String attributeName, java.lang.String defaultValue)
AttributeContainer
getAttribute
in interface AttributeContainer
attributeName
- the attribute to retrievedefaultValue
- the value to return if the attribute is not presentAttributeContainer.getAttribute(String, String)
public java.lang.String getAttribute(java.lang.String attributeName)
AttributeContainer
getAttribute
in interface AttributeContainer
attributeName
- the attribute to retrieveAttributeContainer.getAttribute(String)
public java.util.Map getAttributes()
public java.lang.String[] getAttributeNames()
null
)(C) 2002 - 2005 Apache Software Foundation
All rights reserved. Published under the Apache License 2.0.
http://db.apache.org/ojb
Version: 1.0.4, 2005-12-30