|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.jackrabbit.core.data.db.DbDataStore
public class DbDataStore
A data store implementation that stores the records in a database using JDBC. Configuration:
<DataStore class="org.apache.jackrabbit.core.data.db.DbDataStore"> <param name="url
" value="jdbc:postgresql:test"/> <param name="user
" value="sa"/> <param name="password
" value="sa"/> <param name="databaseType
" value="postgresql"/> <param name="driver
" value="org.postgresql.Driver"/> <param name="minRecordLength
" value="1024"/> <param name="maxConnections
" value="2"/> <param name="copyWhenReading
" value="true"/> <param name="tablePrefix
" value=""/> </DataStore>
Only URL, user name and password usually need to be set. The remaining settings are generated using the database URL sub-protocol from the database type resource file.
JNDI can be used to get the connection. In this case, use the javax.naming.InitialContext as the driver, and the JNDI name as the URL. If the user and password are configured in the JNDI resource, they should not be configured here. Example JNDI settings:
<param name="driver" value="javax.naming.InitialContext" /> <param name="url" value="java:comp/env/jdbc/Test" />
For Microsoft SQL Server 2005, there is a problem reading large BLOBs. You will need to use the JDBC driver version 1.2 or newer, and append ;responseBuffering=adaptive to the database URL. Don't append ;selectMethod=cursor, otherwise it can still run out of memory. Example database URL: jdbc:sqlserver://localhost:4220;DatabaseName=test;responseBuffering=adaptive
By default, the data is copied to a temp file when reading, to avoid problems when reading multiple blobs at the same time.
The tablePrefix can be used to specify a schema and / or catalog name: <param name="tablePrefix" value="ds.">
Field Summary | |
---|---|
protected Pool |
connectionPool
A list of connections |
protected boolean |
copyWhenReading
Copy the stream to a temp file before returning it. |
protected String |
createTableSQL
This is the property 'createTable' in the [databaseType].properties file, initialized with the default value. |
protected String |
databaseType
The database type used. |
static int |
DEFAULT_MAX_CONNECTIONS
The default value for the maximum connections. |
static int |
DEFAULT_MIN_RECORD_LENGTH
The default value for the minimum object size. |
protected String |
deleteOlderSQL
This is the property 'deleteOlder' in the [databaseType].properties file, initialized with the default value. |
protected String |
deleteSQL
This is the property 'delete' in the [databaseType].properties file, initialized with the default value. |
protected static String |
DIGEST
The digest algorithm used to uniquely identify records. |
protected String |
driver
The database driver. |
protected String |
insertTempSQL
This is the property 'insertTemp' in the [databaseType].properties file, initialized with the default value. |
protected Map |
inUse
All data identifiers that are currently in use are in this set until they are garbage collected. |
protected int |
maxConnections
The maximum number of open connections. |
protected long |
minModifiedDate
The minimum modified date. |
protected int |
minRecordLength
The minimum size of an object that should be stored in this data store. |
protected String |
password
The password |
protected String |
selectAllSQL
This is the property 'selectAll' in the [databaseType].properties file, initialized with the default value. |
protected String |
selectDataSQL
This is the property 'selectData' in the [databaseType].properties file, initialized with the default value. |
protected String |
selectMetaSQL
This is the property 'selectMeta' in the [databaseType].properties file, initialized with the default value. |
static String |
STORE_SIZE_MAX
Call PreparedStatement.setBinaryStream(..., Integer.MAX_VALUE) |
static String |
STORE_SIZE_MINUS_ONE
Call PreparedStatement.setBinaryStream(..., -1) |
static String |
STORE_TEMP_FILE
Write to a temporary file to get the length (slow, but always works). |
protected String |
storeStream
The stream storing mechanism used. |
protected String |
tablePrefix
The prefix for the datastore table, empty by default. |
protected String |
tableSQL
This is the property 'table' in the [databaseType].properties file, initialized with the default value. |
protected static String |
TEMP_PREFIX
The prefix used for temporary objects. |
protected String |
updateDataSQL
This is the property 'updateData' in the [databaseType].properties file, initialized with the default value. |
protected String |
updateLastModifiedSQL
This is the property 'updateLastModified' in the [databaseType].properties file, initialized with the default value. |
protected String |
updateSQL
This is the property 'update' in the [databaseType].properties file, initialized with the default value. |
protected String |
url
The database URL used. |
protected String |
user
The user name. |
Constructor Summary | |
---|---|
DbDataStore()
|
Method Summary | |
---|---|
DataRecord |
addRecord(InputStream stream)
Creates a new data record. |
void |
clearInUse()
Clear the in-use list. |
void |
close()
Close the data store |
protected DataStoreException |
convert(String cause,
Exception e)
Convert an exception to a data store exception. |
ConnectionRecoveryManager |
createNewConnection()
Create a new connection. |
int |
deleteAllOlderThan(long min)
Delete objects that have a modified date older than the specified date. |
Iterator |
getAllIdentifiers()
Get all identifiers. |
protected ConnectionRecoveryManager |
getConnection()
|
boolean |
getCopyWhenReading()
Is a stream copied to a temporary file before returning? |
String |
getDatabaseType()
Get the database type (if set). |
protected MessageDigest |
getDigest()
|
String |
getDriver()
Get the database driver |
int |
getMaxConnections()
Get the maximum number of concurrent connections. |
int |
getMinRecordLength()
Get the minimum size of an object that should be stored in this data store. |
String |
getPassword()
Get the password. |
protected String |
getProperty(Properties prop,
String key,
String defaultValue)
Get the expanded property value. |
DataRecord |
getRecord(DataIdentifier identifier)
Returns the identified data record. |
String |
getTablePrefix()
Get the table prefix. |
String |
getUrl()
Get the database URL. |
String |
getUser()
Get the user name. |
void |
init(String homeDir)
Initialized the data store |
protected void |
initDatabaseType()
|
protected void |
putBack(ConnectionRecoveryManager conn)
|
void |
setCopyWhenReading(boolean copyWhenReading)
The the copy setting. |
void |
setDatabaseType(String databaseType)
Set the database type. |
void |
setDriver(String driver)
Set the database driver class name. |
void |
setMaxConnections(int maxConnections)
Set the maximum number of concurrent connections in the pool. |
void |
setMinRecordLength(int minRecordLength)
Set the minimum object length. |
void |
setPassword(String password)
Set the password. |
void |
setTablePrefix(String tablePrefix)
Set the new table prefix. |
void |
setUrl(String url)
Set the database URL. |
void |
setUser(String user)
Set the user name. |
void |
updateModifiedDateOnAccess(long before)
From now on, update the modified date of an object even when accessing it. |
protected void |
usesIdentifier(DataIdentifier identifier)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int DEFAULT_MIN_RECORD_LENGTH
public static final int DEFAULT_MAX_CONNECTIONS
public static final String STORE_TEMP_FILE
public static final String STORE_SIZE_MINUS_ONE
public static final String STORE_SIZE_MAX
protected static final String DIGEST
protected static final String TEMP_PREFIX
protected long minModifiedDate
protected String url
protected String driver
protected String user
protected String password
protected String databaseType
protected int minRecordLength
protected int maxConnections
protected Pool connectionPool
protected String tablePrefix
protected String tableSQL
protected String createTableSQL
protected String insertTempSQL
protected String updateDataSQL
protected String updateLastModifiedSQL
protected String updateSQL
protected String deleteSQL
protected String deleteOlderSQL
protected String selectMetaSQL
protected String selectAllSQL
protected String selectDataSQL
protected String storeStream
protected boolean copyWhenReading
protected Map inUse
Constructor Detail |
---|
public DbDataStore()
Method Detail |
---|
public DataRecord addRecord(InputStream stream) throws DataStoreException
The given stream is consumed and not closed by this method. It is the responsibility of the caller to close the stream. A typical call pattern would be:
InputStream stream = ...; try { record = store.addRecord(stream); } finally { stream.close(); }
addRecord
in interface DataStore
stream
- binary stream
DataStoreException
- if the data store could not be accessedpublic int deleteAllOlderThan(long min) throws DataStoreException
deleteAllOlderThan
in interface DataStore
min
- the minimum time
DataStoreException
public Iterator getAllIdentifiers() throws DataStoreException
getAllIdentifiers
in interface DataStore
DataStoreException
- if the list could not be readpublic int getMinRecordLength()
getMinRecordLength
in interface DataStore
public void setMinRecordLength(int minRecordLength)
minRecordLength
- the lengthpublic DataRecord getRecord(DataIdentifier identifier) throws DataStoreException
getRecord
in interface DataStore
identifier
- data identifier
DataStoreException
- if the data store could not be accessed,
or if the given identifier is invalidpublic void init(String homeDir) throws DataStoreException
init
in interface DataStore
homeDir
- the home directory of the repository
DataStoreException
protected void initDatabaseType() throws DataStoreException
DataStoreException
protected String getProperty(Properties prop, String key, String defaultValue)
prop
- the properties objectkey
- the keydefaultValue
- the default value
protected DataStoreException convert(String cause, Exception e)
cause
- the messagee
- the root cause
public void updateModifiedDateOnAccess(long before)
updateModifiedDateOnAccess
in interface DataStore
before
- - update the modified date to the current time if it is older than this valuepublic String getDatabaseType()
public void setDatabaseType(String databaseType)
databaseType
- public String getDriver()
public void setDriver(String driver)
driver
- public String getPassword()
public void setPassword(String password)
password
- public String getUrl()
public void setUrl(String url)
url
- public String getUser()
public void setUser(String user)
user
- public void close()
close
in interface DataStore
protected void usesIdentifier(DataIdentifier identifier)
public void clearInUse()
clearInUse
in interface DataStore
protected MessageDigest getDigest() throws DataStoreException
DataStoreException
protected ConnectionRecoveryManager getConnection() throws DataStoreException
DataStoreException
protected void putBack(ConnectionRecoveryManager conn) throws DataStoreException
DataStoreException
public int getMaxConnections()
public void setMaxConnections(int maxConnections)
maxConnections
- the new valuepublic ConnectionRecoveryManager createNewConnection() throws RepositoryException
RepositoryException
public boolean getCopyWhenReading()
public void setCopyWhenReading(boolean copyWhenReading)
copyWhenReading
- the new settingpublic String getTablePrefix()
public void setTablePrefix(String tablePrefix)
tablePrefix
- the new value
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |