org.alfresco.jlan.server.filesys.db.mysql

Class MySQLDBInterface

java.lang.Object

org.alfresco.jlan.server.filesys.db.JdbcDBInterface

org.alfresco.jlan.server.filesys.db.mysql.MySQLDBInterface

All Implemented Interfaces:

DBDataInterface, DBInterface, DBObjectIdInterface, DBQueueInterface, DBConnectionPoolListener

public class MySQLDBInterface
extends JdbcDBInterface
implements DBQueueInterface, DBDataInterface, DBObjectIdInterface

mySQL Database Interface Class

mySQL specific implementation of the database interface used by the database filesystem driver (DBDiskDriver).

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	LockFileName
static long	MaxMemoryBuffer

Fields inherited from class org.alfresco.jlan.server.filesys.db.JdbcDBInterface

DataTable, DefaultFragSize, FileSysTable, JarDataTable, m_connPool, m_dataFragSize, m_dataTable, m_dbCtx, m_dbInitConns, m_dbMaxConns, m_debug, m_driver, m_dsn, m_jarDataTable, m_objectIdTable, m_onlineCheckInterval, m_password, m_pendingSaveRequests, m_queueTable, m_retentionPeriod, m_retentionTable, m_specialChars, m_sqlDebug, m_streamTable, m_structTable, m_symLinkTable, m_transactTable, m_userName, MaxFragSize, MinFragSize, NumPoolConnections, ObjectIdTable, QueueTable, RetentionTable, StreamsTable, SymLinkTable, TransactQueueTable

Fields inherited from interface org.alfresco.jlan.server.filesys.db.DBInterface

FeatureData, FeatureJarData, FeatureNTFS, FeatureObjectId, FeatureQueue, FeatureRetention, FeatureSecDescriptor, FeatureSymLinks, FileAll, FileIds, FileNameOnly, StreamAll, StreamIds, StreamNameOnly

Constructor Summary

Constructors

Constructor and Description
MySQLDBInterface() Default constructor

Method Summary

Methods

Modifier and Type	Method and Description
int	createFileRecord(java.lang.String fname, int dirId, FileOpenParams params, boolean retain) Create a file record for a new file or folder
protected void	createQueueStatements() Create the prepared statements used by the file request queueing database
int	createStreamRecord(java.lang.String sname, int fid) Create a stream record for a new file stream
void	deleteFileData(int fileId, int streamId) Delete the file data for the specified file/stream
void	deleteFileRecord(int dirId, int fid, boolean markOnly) Delete a file or folder record
void	deleteFileRequest(FileRequest fileReq) Delete a file request from the pending queue.
void	deleteJarData(int jarId) Delete the file data for the specified Jar file
void	deleteObjectId(int fileId, int streamId, java.lang.String objectId) Delete a file id/object id mapping
void	deleteStreamRecord(int fid, int stid, boolean markOnly) Delete a file stream record
void	deleteSymbolicLinkRecord(int dirId, int fid) Delete a symbolic link record
int	fileExists(int dirId, java.lang.String fname) Check if a file/folder exists
java.lang.String	getDBInterfaceName() Return the database interface name
DBDataDetails	getFileDataDetails(int fileId, int streamId) Return the file data details for the specified file or stream.
int	getFileId(int dirId, java.lang.String fname, boolean dirOnly, boolean caseLess) Get the id for a file/folder, or -1 if the file/folder does not exist.
DBFileInfo	getFileInformation(int dirId, int fid, int infoLevel) Get information for a file or folder
RetentionDetails	getFileRetentionDetails(int dirId, int fid) Return the retention period expiry date/time for the specified file, or zero if the file/folder is not under retention.
long	getMaximumFragmentSize() Return the maximum data fragment size supported
StreamInfo	getStreamInformation(int fid, int stid, int infoLevel) Get information for a file stream
StreamInfoList	getStreamsList(int fid, int infoLevel) Return the list of streams for the specified file
protected int	getSupportedFeatures() Get the supported database features mask
long	getUsedFileSpace() Return the used file space, or -1 if not supported.
boolean	hasQueuedRequest(java.lang.String tempFile, boolean lastFile) Check if the specified temporary file has a queued request.
void	initializeDatabase(DBDeviceContext dbCtx, org.springframework.extensions.config.ConfigElement params) Initialize the database interface
void	loadFileData(int fileId, int streamId, FileSegment fileSeg) Load file data from the database into a temporary/local file
int	loadFileRequests(int fromSeqNo, int reqType, FileRequestQueue reqQueue, int recLimit) Load a block of file request from the database into the specified queue.
void	loadJarData(int jarId, FileSegment jarSeg) Load Jar file data from the database into a temporary file
java.lang.String	loadObjectId(int fileId, int streamId) Load the object id for the specified file id
MultipleFileRequest	loadTransactionRequest(MultipleFileRequest tranReq) Load a transaction request from the queue.
FileRequestQueue	performQueueCleanup(java.io.File tempDir, java.lang.String tempDirPrefix, java.lang.String tempFilePrefix, java.lang.String jarFilePrefix) Perform a queue cleanup deleting temporary cache files that do not have an associated save or transaction request.
void	queueFileRequest(FileRequest req) Queue a file request.
java.lang.String	readSymbolicLink(int dirId, int fid) Return the data for a symbolic link
void	renameFileRecord(int dirId, int fid, java.lang.String newName, int newDir) Rename a file or folder, may also change the parent directory.
void	renameStreamRecord(int dirId, int fid, int stid, java.lang.String newName) Rename a file stream
int	saveFileData(int fileId, int streamId, FileSegment fileSeg) Save the file data from the temporary/local file to the database
int	saveJarData(java.lang.String jarPath, DBDataDetailsList fileList) Save the file data from a Jar file to the database
void	saveObjectId(int fileId, int streamId, java.lang.String objectId) Create a file id to object id mapping
void	setFileInformation(int dirId, int fid, FileInfo finfo) Set file information for a file or folder
void	setStreamInformation(int dirId, int fid, int stid, StreamInfo sinfo) Set information for a file stream
void	shutdownDatabase(DBDeviceContext context) Shutdown the database interface, release resources.
DBSearchContext	startSearch(int dirId, java.lang.String searchPath, int attrib, int infoLevel, int maxRecords) Start a directory search

Methods inherited from class org.alfresco.jlan.server.filesys.db.JdbcDBInterface

checkNameForSpecialChars, createConnectionPool, databaseOnlineStatus, getConnection, getConnection, getConnectionPool, getDataFragmentSize, getDataTableName, getDriverName, getDSNString, getFileSysTableName, getJarDataTableName, getLockFile, getObjectIdTableName, getPassword, getQueueTableName, getRetentionPeriod, getRetentionTableName, getStreamsTableName, getSymLinksTableName, getTransactionTableName, getUserName, hasCrashRecovery, hasDataTableName, hasDebug, hasJarDataTableName, hasObjectIdTableName, hasOfflineFileRequests, hasQueuedRequest, hasQueueTableName, hasRetentionPeriod, hasRetentionTableName, hasSQLDebug, hasStreamsTableName, hasSymLinksTableName, hasTransactionTableName, isDataEnabled, isJarDataEnabled, isNTFSEnabled, isObjectIdEnabled, isOnline, isQueueEnabled, isRetentionEnabled, isSymbolicLinksEnabled, queueOfflineSaveRequest, queueTransactionRequest, releaseConnection, requestFeatures, setDataFragmentSize, setDriverName, setDSNString, setLockFile, supportsFeature

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MaxMemoryBuffer

public static final long MaxMemoryBuffer

See Also:

Constant Field Values

LockFileName

public static final java.lang.String LockFileName

See Also:

Constant Field Values

Constructor Detail

MySQLDBInterface

public MySQLDBInterface()

Default constructor

Method Detail

getDBInterfaceName

public java.lang.String getDBInterfaceName()

Return the database interface name

Specified by:

getDBInterfaceName in interface DBInterface

Returns:

String

getSupportedFeatures

protected int getSupportedFeatures()

Get the supported database features mask

Specified by:

getSupportedFeatures in class JdbcDBInterface

Returns:

int

initializeDatabase

public void initializeDatabase(DBDeviceContext dbCtx,
                      org.springframework.extensions.config.ConfigElement params)
                        throws InvalidConfigurationException

Initialize the database interface

Specified by:

initializeDatabase in interface DBInterface

Overrides:

initializeDatabase in class JdbcDBInterface

Parameters:

dbCtx - DBDeviceContext

params - ConfigElement

Throws:

InvalidConfigurationException

fileExists

public int fileExists(int dirId,
             java.lang.String fname)
               throws DBException

Check if a file/folder exists

Specified by:

fileExists in interface DBInterface

Parameters:

dirId - int

fname - String

Returns:

FileStatus.NotExist, FileStatus.FileExists or FileStatus.DirectoryExists

Throws:

DBException

createFileRecord

public int createFileRecord(java.lang.String fname,
                   int dirId,
                   FileOpenParams params,
                   boolean retain)
                     throws DBException,
                            FileExistsException

Create a file record for a new file or folder

Specified by:

createFileRecord in interface DBInterface

Parameters:

fname - String

dirId - int

params - FileOpenParams

retain - boolean

Returns:

int

Throws:

DBException

FileExistsException

createStreamRecord

public int createStreamRecord(java.lang.String sname,
                     int fid)
                       throws DBException

Create a stream record for a new file stream

Specified by:

createStreamRecord in interface DBInterface

Parameters:

sname - String

fid - int

Returns:

int

Throws:

DBException

deleteFileRecord

public void deleteFileRecord(int dirId,
                    int fid,
                    boolean markOnly)
                      throws DBException

Delete a file or folder record

Specified by:

deleteFileRecord in interface DBInterface

Parameters:

dirId - int

fid - int

markOnly - boolean

Throws:

DBException

deleteStreamRecord

public void deleteStreamRecord(int fid,
                      int stid,
                      boolean markOnly)
                        throws DBException

Delete a file stream record

Specified by:

deleteStreamRecord in interface DBInterface

Parameters:

fid - int

stid - int

markOnly - boolean

Throws:

DBException

setFileInformation

public void setFileInformation(int dirId,
                      int fid,
                      FileInfo finfo)
                        throws DBException

Set file information for a file or folder

Specified by:

setFileInformation in interface DBInterface

Parameters:

dirId - int

fid - int

finfo - FileInfo

Throws:

DBException

setStreamInformation

public void setStreamInformation(int dirId,
                        int fid,
                        int stid,
                        StreamInfo sinfo)
                          throws DBException

Set information for a file stream

Specified by:

setStreamInformation in interface DBInterface

Parameters:

dirId - int

fid - int

stid - int

sinfo - StreamInfo

Throws:

DBException

getFileId

public int getFileId(int dirId,
            java.lang.String fname,
            boolean dirOnly,
            boolean caseLess)
              throws DBException

Get the id for a file/folder, or -1 if the file/folder does not exist.

Specified by:

getFileId in interface DBInterface

Parameters:

dirId - int

fname - String

dirOnly - boolean

caseLess - boolean

Returns:

int

Throws:

DBException

getFileInformation

public DBFileInfo getFileInformation(int dirId,
                            int fid,
                            int infoLevel)
                              throws DBException

Get information for a file or folder

Specified by:

getFileInformation in interface DBInterface

Parameters:

dirId - int

fid - int

infoLevel - int

Returns:

FileInfo

Throws:

DBException

getStreamInformation

public StreamInfo getStreamInformation(int fid,
                              int stid,
                              int infoLevel)
                                throws DBException

Get information for a file stream

Specified by:

getStreamInformation in interface DBInterface

Parameters:

fid - int

stid - int

infoLevel - int

Returns:

StreamInfo

Throws:

DBException

getStreamsList

public StreamInfoList getStreamsList(int fid,
                            int infoLevel)
                              throws DBException

Return the list of streams for the specified file

Specified by:

getStreamsList in interface DBInterface

Parameters:

fid - int

infoLevel - int

Returns:

StreamInfoList

Throws:

DBException

renameFileRecord

public void renameFileRecord(int dirId,
                    int fid,
                    java.lang.String newName,
                    int newDir)
                      throws DBException,
                             java.io.FileNotFoundException

Rename a file or folder, may also change the parent directory.

Specified by:

renameFileRecord in interface DBInterface

Parameters:

dirId - int

fid - int

newName - String

newDir - int

Throws:

DBException

java.io.FileNotFoundException

renameStreamRecord

public void renameStreamRecord(int dirId,
                      int fid,
                      int stid,
                      java.lang.String newName)
                        throws DBException

Rename a file stream

Specified by:

renameStreamRecord in interface DBInterface

Parameters:

dirId - int

fid - int

stid - int

newName -

Throws:

DBException

getFileRetentionDetails

public RetentionDetails getFileRetentionDetails(int dirId,
                                       int fid)
                                         throws DBException

Return the retention period expiry date/time for the specified file, or zero if the file/folder is not under retention.

Specified by:

getFileRetentionDetails in interface DBInterface

Parameters:

dirId - int

fid - int

Returns:

RetentionDetails

Throws:

DBException

startSearch

public DBSearchContext startSearch(int dirId,
                          java.lang.String searchPath,
                          int attrib,
                          int infoLevel,
                          int maxRecords)
                            throws DBException

Start a directory search

Specified by:

startSearch in interface DBInterface

Parameters:

dirId - int

searchPath - String

attrib - int

infoLevel - int

maxRecords - int

Returns:

DBSearchContext

Throws:

DBException

getUsedFileSpace

public long getUsedFileSpace()

Return the used file space, or -1 if not supported.

Specified by:

getUsedFileSpace in interface DBInterface

Returns:

long

queueFileRequest

public void queueFileRequest(FileRequest req)
                      throws DBException

Queue a file request.

Specified by:

queueFileRequest in interface DBQueueInterface

Overrides:

queueFileRequest in class JdbcDBInterface

Parameters:

req - FileRequest

Throws:

DBException

performQueueCleanup

public FileRequestQueue performQueueCleanup(java.io.File tempDir,
                                   java.lang.String tempDirPrefix,
                                   java.lang.String tempFilePrefix,
                                   java.lang.String jarFilePrefix)
                                     throws DBException

Perform a queue cleanup deleting temporary cache files that do not have an associated save or transaction request.

Specified by:

performQueueCleanup in interface DBQueueInterface

Parameters:

tempDir - File

tempDirPrefix - String

tempFilePrefix - String

jarFilePrefix - String

Returns:

FileRequestQueue

Throws:

DBException

hasQueuedRequest

public boolean hasQueuedRequest(java.lang.String tempFile,
                       boolean lastFile)
                         throws DBException

Check if the specified temporary file has a queued request.

Parameters:

tempFile - String

lastFile - boolean

Returns:

boolean

Throws:

DBException

deleteFileRequest

public void deleteFileRequest(FileRequest fileReq)
                       throws DBException

Delete a file request from the pending queue.

Specified by:

deleteFileRequest in interface DBQueueInterface

Overrides:

deleteFileRequest in class JdbcDBInterface

Parameters:

fileReq - FileRequest

Throws:

DBException

loadFileRequests

public int loadFileRequests(int fromSeqNo,
                   int reqType,
                   FileRequestQueue reqQueue,
                   int recLimit)
                     throws DBException

Load a block of file request from the database into the specified queue.

Specified by:

loadFileRequests in interface DBQueueInterface

Overrides:

loadFileRequests in class JdbcDBInterface

Parameters:

fromSeqNo - int

reqType - int

reqQueue - FileRequestQueue

recLimit - int

Returns:

int

Throws:

DBException

loadTransactionRequest

public MultipleFileRequest loadTransactionRequest(MultipleFileRequest tranReq)
                                           throws DBException

Load a transaction request from the queue.

Specified by:

loadTransactionRequest in interface DBQueueInterface

Overrides:

loadTransactionRequest in class JdbcDBInterface

Parameters:

tranReq - MultiplFileRequest

Returns:

MultipleFileRequest

Throws:

DBException

shutdownDatabase

public void shutdownDatabase(DBDeviceContext context)

Shutdown the database interface, release resources.

Specified by:

shutdownDatabase in interface DBInterface

Overrides:

shutdownDatabase in class JdbcDBInterface

Parameters:

context - DBDeviceContext

createQueueStatements

protected final void createQueueStatements()
                                    throws java.sql.SQLException

Create the prepared statements used by the file request queueing database

Throws:

java.sql.SQLException

getFileDataDetails

public DBDataDetails getFileDataDetails(int fileId,
                               int streamId)
                                 throws DBException

Return the file data details for the specified file or stream.

Specified by:

getFileDataDetails in interface DBDataInterface

Parameters:

fileId -

streamId -

Returns:

DBDataDetails

Throws:

DBException

getMaximumFragmentSize

public long getMaximumFragmentSize()

Return the maximum data fragment size supported

Specified by:

getMaximumFragmentSize in interface DBDataInterface

Returns:

long

loadFileData

public void loadFileData(int fileId,
                int streamId,
                FileSegment fileSeg)
                  throws DBException,
                         java.io.IOException

Load file data from the database into a temporary/local file

Specified by:

loadFileData in interface DBDataInterface

Parameters:

fileId - int

streamId - int

fileSeg - FileSegment

Throws:

DBException

java.io.IOException

loadJarData

public void loadJarData(int jarId,
               FileSegment jarSeg)
                 throws DBException,
                        java.io.IOException

Load Jar file data from the database into a temporary file

Specified by:

loadJarData in interface DBDataInterface

Parameters:

jarId - int

jarSeg - FileSegment

Throws:

DBException

java.io.IOException

saveFileData

public int saveFileData(int fileId,
               int streamId,
               FileSegment fileSeg)
                 throws DBException,
                        java.io.IOException

Save the file data from the temporary/local file to the database

Specified by:

saveFileData in interface DBDataInterface

Parameters:

fileId - int

streamId - int

fileSeg - FileSegment

Returns:

int

Throws:

DBException

java.io.IOException

saveJarData

public int saveJarData(java.lang.String jarPath,
              DBDataDetailsList fileList)
                throws DBException,
                       java.io.IOException

Save the file data from a Jar file to the database

Specified by:

saveJarData in interface DBDataInterface

Parameters:

jarPath - String

fileList - DBDataDetailsList

Returns:

int

Throws:

DBException

java.io.IOException

deleteFileData

public void deleteFileData(int fileId,
                  int streamId)
                    throws DBException,
                           java.io.IOException

Delete the file data for the specified file/stream

Specified by:

deleteFileData in interface DBDataInterface

Parameters:

fileId - int

streamId - int

Throws:

DBException

java.io.IOException

deleteJarData

public void deleteJarData(int jarId)
                   throws DBException,
                          java.io.IOException

Delete the file data for the specified Jar file

Specified by:

deleteJarData in interface DBDataInterface

Parameters:

jarId - int

Throws:

DBException

java.io.IOException

saveObjectId

public void saveObjectId(int fileId,
                int streamId,
                java.lang.String objectId)
                  throws DBException

Create a file id to object id mapping

Specified by:

saveObjectId in interface DBObjectIdInterface

Parameters:

fileId - int

streamId - int

objectId - String

Throws:

DBException

loadObjectId

public java.lang.String loadObjectId(int fileId,
                            int streamId)
                              throws DBException

Load the object id for the specified file id

Specified by:

loadObjectId in interface DBObjectIdInterface

Parameters:

fileId - int

streamId - int

Returns:

String

Throws:

DBException

deleteObjectId

public void deleteObjectId(int fileId,
                  int streamId,
                  java.lang.String objectId)
                    throws DBException

Delete a file id/object id mapping

Specified by:

deleteObjectId in interface DBObjectIdInterface

Parameters:

fileId - int

streamId - int

objectId - String

Throws:

DBException

readSymbolicLink

public java.lang.String readSymbolicLink(int dirId,
                                int fid)
                                  throws DBException

Return the data for a symbolic link

Specified by:

readSymbolicLink in interface DBInterface

Parameters:

dirId - int

fid - int

Returns:

String

Throws:

DBException

deleteSymbolicLinkRecord

public void deleteSymbolicLinkRecord(int dirId,
                            int fid)
                              throws DBException

Delete a symbolic link record

Specified by:

deleteSymbolicLinkRecord in interface DBInterface

Parameters:

dirId - int

fid - int

Throws:

DBException