org.waarp.openr66.dao.xml

Class XMLTransferDAO

java.lang.Object

org.waarp.openr66.dao.xml.XMLTransferDAO

All Implemented Interfaces:

Cloneable, AbstractDAO<Transfer>, TransferDAO

public class XMLTransferDAO
extends Object
implements TransferDAO

Field Summary

Fields

Modifier and Type	Field and Description
static String	BLOCK_SIZE_FIELD
static String	FILE_INFO_FIELD
static String	FILENAME_FIELD
static String	GLOBAL_STEP_FIELD
static String	ID_FIELD
static String	INFO_STATUS_FIELD
static String	IS_MOVED_FIELD
static String	LAST_GLOBAL_STEP_FIELD
static String	ORIGINAL_NAME_FIELD
static String	OWNER_FIELD
static String	RANK_FIELD
static String	REQUESTED_FIELD
static String	REQUESTER_FIELD
static String	RETRIEVE_MODE_FIELD
static String	ROOT_ELEMENT
static String	ROOT_LIST
static String	RULE_FIELD
static String	START_FIELD
static String	STEP_FIELD
static String	STEP_STATUS_FIELD
static String	STOP_FIELD
static String	TRANSFER_MODE_FIELD
static String	XMLEXTENSION

Constructor Summary

Constructors

Constructor and Description
XMLTransferDAO(String filePath)

Method Summary

Modifier and Type	Method and Description
static int	clearCache() To enable clear of oldest entries in the cache
void	close()
static void	createLruCache(int limit, long ttl) Create the LRU cache
void	delete(Transfer transfer) Remove the specified object from the persistance layer
void	deleteAll() DAOConnectionException
boolean	exist(long id, String requester, String requested, String owner) Verify if a Transfer object with the specified Special ID exists in the persistance layer
boolean	exist(String id) UnsupportedOperationException
List<Transfer>	find(List<Filter> fitlers) DAOConnectionException
List<Transfer>	find(List<Filter> filters, int limit) DAOConnectionException
List<Transfer>	find(List<Filter> filters, int limit, int offset) DAOConnectionException
List<Transfer>	find(List<Filter> filters, String column, boolean ascend) DAOConnectionException
List<Transfer>	find(List<Filter> filters, String column, boolean ascend, int limit) DAOConnectionException
List<Transfer>	find(List<Filter> filters, String column, boolean ascend, int limit, int offset) DAOConnectionException
List<Transfer>	getAll() Retrieve all objects in a List from the persistance layer
static String	hashStatus()
void	insert(Transfer transfer) Insert the specified object in the persistance layer
static void	removeNoDbSpecialId(long specialId) To allow to remove specifically one SpecialId from MemoryHashmap
Transfer	select(long id, String requester, String requested, String owner) Retrieve the Transfer object with the specified Special ID from the persistance layer
Transfer	select(String id) UnsupportedOperationException
void	update(Transfer transfer) Update the specified object in the persistance layer
static void	updateLruCacheTimeout(long ttl) To update the TTL for the cache (to 10xTIMEOUT)
static void	updateUsed(long specialId) To update the usage TTL of the associated object

Methods inherited from class java.lang.Object

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

Field Detail

ROOT_LIST

public static final String ROOT_LIST

See Also:

Constant Field Values

ROOT_ELEMENT

public static final String ROOT_ELEMENT

See Also:

Constant Field Values

GLOBAL_STEP_FIELD

public static final String GLOBAL_STEP_FIELD

See Also:

Constant Field Values

LAST_GLOBAL_STEP_FIELD

public static final String LAST_GLOBAL_STEP_FIELD

See Also:

Constant Field Values

STEP_FIELD

public static final String STEP_FIELD

See Also:

Constant Field Values

RANK_FIELD

public static final String RANK_FIELD

See Also:

Constant Field Values

STEP_STATUS_FIELD

public static final String STEP_STATUS_FIELD

See Also:

Constant Field Values

RETRIEVE_MODE_FIELD

public static final String RETRIEVE_MODE_FIELD

See Also:

Constant Field Values

FILENAME_FIELD

public static final String FILENAME_FIELD

See Also:

Constant Field Values

IS_MOVED_FIELD

public static final String IS_MOVED_FIELD

See Also:

Constant Field Values

RULE_FIELD

public static final String RULE_FIELD

See Also:

Constant Field Values

BLOCK_SIZE_FIELD

public static final String BLOCK_SIZE_FIELD

See Also:

Constant Field Values

ORIGINAL_NAME_FIELD

public static final String ORIGINAL_NAME_FIELD

See Also:

Constant Field Values

FILE_INFO_FIELD

public static final String FILE_INFO_FIELD

See Also:

Constant Field Values

TRANSFER_MODE_FIELD

public static final String TRANSFER_MODE_FIELD

See Also:

Constant Field Values

START_FIELD

public static final String START_FIELD

See Also:

Constant Field Values

STOP_FIELD

public static final String STOP_FIELD

See Also:

Constant Field Values

INFO_STATUS_FIELD

public static final String INFO_STATUS_FIELD

See Also:

Constant Field Values

OWNER_FIELD

public static final String OWNER_FIELD

See Also:

Constant Field Values

REQUESTER_FIELD

public static final String REQUESTER_FIELD

See Also:

Constant Field Values

REQUESTED_FIELD

public static final String REQUESTED_FIELD

See Also:

Constant Field Values

ID_FIELD

public static final String ID_FIELD

See Also:

Constant Field Values

XMLEXTENSION

public static final String XMLEXTENSION

See Also:

Constant Field Values

Constructor Detail

XMLTransferDAO

public XMLTransferDAO(String filePath)

Method Detail

createLruCache

public static void createLruCache(int limit,
                                  long ttl)

Create the LRU cache

Parameters:

limit - limit of number of entries in the cache

ttl - time to leave used

hashStatus

public static String hashStatus()

clearCache

public static int clearCache()

To enable clear of oldest entries in the cache

Returns:

the number of elements removed

updateLruCacheTimeout

public static void updateLruCacheTimeout(long ttl)

To update the TTL for the cache (to 10xTIMEOUT)

Parameters:

ttl -

removeNoDbSpecialId

public static final void removeNoDbSpecialId(long specialId)

To allow to remove specifically one SpecialId from MemoryHashmap

Parameters:

specialId -

updateUsed

public static final void updateUsed(long specialId)

To update the usage TTL of the associated object

Parameters:

specialId -

close

public void close()

Specified by:

close in interface AbstractDAO<Transfer>

delete

public void delete(Transfer transfer)
            throws DAOConnectionException

Description copied from interface: AbstractDAO

Remove the specified object from the persistance layer

Specified by:

delete in interface AbstractDAO<Transfer>

Parameters:

transfer - object to delete

Throws:

DAOConnectionException - If a data access error occurs

deleteAll

public void deleteAll()
               throws DAOConnectionException

DAOConnectionException

Specified by:

deleteAll in interface AbstractDAO<Transfer>

Throws:

DAOConnectionException - If a data access error occurs

getAll

public List<Transfer> getAll()
                      throws DAOConnectionException

Description copied from interface: AbstractDAO

Retrieve all objects in a List from the persistance layer

Specified by:

getAll in interface AbstractDAO<Transfer>

Throws:

DAOConnectionException - If data access error occurs

exist

public boolean exist(long id,
                     String requester,
                     String requested,
                     String owner)
              throws DAOConnectionException

Description copied from interface: TransferDAO

Verify if a Transfer object with the specified Special ID exists in the persistance layer

Specified by:

exist in interface TransferDAO

Parameters:

id - special ID of the Transfer object verified

Returns:

true if a Transfer object with the specified Special ID exist; false if no Transfer object correspond to the specified Special ID.

Throws:

DAOConnectionException - If a data access error occurs

find

public List<Transfer> find(List<Filter> fitlers)
                    throws DAOConnectionException

DAOConnectionException

Specified by:

find in interface AbstractDAO<Transfer>

Parameters:

fitlers - List of filter

Returns:

never

Throws:

DAOConnectionException - If data access error occurs

select

public Transfer select(String id)
                throws DAOConnectionException,
                       DAONoDataException

UnsupportedOperationException

Specified by:

select in interface AbstractDAO<Transfer>

Parameters:

id - id of the object requested

Returns:

never

Throws:

DAOConnectionException - If a data access error occurs

DAONoDataException - if no data are available

exist

public boolean exist(String id)
              throws DAOConnectionException

UnsupportedOperationException

Specified by:

exist in interface AbstractDAO<Transfer>

Parameters:

id - id of the object verified

Returns:

never

Throws:

DAOConnectionException - If a data access error occurs

find

public List<Transfer> find(List<Filter> filters,
                           int limit)
                    throws DAOConnectionException

DAOConnectionException

Specified by:

find in interface TransferDAO

Parameters:

filters - List of filter

Returns:

never

Throws:

DAOConnectionException - If data access error occurs

find

public List<Transfer> find(List<Filter> filters,
                           int limit,
                           int offset)
                    throws DAOConnectionException

DAOConnectionException

Specified by:

find in interface TransferDAO

Parameters:

filters - List of filter

Returns:

never

Throws:

DAOConnectionException - If data access error occurs

find

public List<Transfer> find(List<Filter> filters,
                           String column,
                           boolean ascend)
                    throws DAOConnectionException

DAOConnectionException

Specified by:

find in interface TransferDAO

Parameters:

filters - List of filter

Returns:

never

Throws:

DAOConnectionException - If data access error occurs

find

public List<Transfer> find(List<Filter> filters,
                           String column,
                           boolean ascend,
                           int limit)
                    throws DAOConnectionException

DAOConnectionException

Specified by:

find in interface TransferDAO

Parameters:

filters - List of filter

Returns:

never

Throws:

DAOConnectionException - If data access error occurs

find

public List<Transfer> find(List<Filter> filters,
                           String column,
                           boolean ascend,
                           int limit,
                           int offset)
                    throws DAOConnectionException

DAOConnectionException

Specified by:

find in interface TransferDAO

Parameters:

filters - List of filter

Returns:

never

Throws:

DAOConnectionException - If data access error occurs

insert

public void insert(Transfer transfer)
            throws DAOConnectionException

Description copied from interface: AbstractDAO

Insert the specified object in the persistance layer

Specified by:

insert in interface AbstractDAO<Transfer>

Parameters:

transfer - object to insert

Throws:

DAOConnectionException - If a data access error occurs

select

public Transfer select(long id,
                       String requester,
                       String requested,
                       String owner)
                throws DAOConnectionException,
                       DAONoDataException

Description copied from interface: TransferDAO

Retrieve the Transfer object with the specified Special ID from the persistance layer

Specified by:

select in interface TransferDAO

Parameters:

id - special ID of the Transfer object requested

Throws:

DAOConnectionException - If a data access error occurs

DAONoDataException - if no data are available

update

public void update(Transfer transfer)
            throws DAOConnectionException

Description copied from interface: AbstractDAO

Update the specified object in the persistance layer

Specified by:

update in interface AbstractDAO<Transfer>

Parameters:

transfer - object to update

Throws:

DAOConnectionException - If a data access error occurs