Package io.permazen.spring

Class SpringXMLKVDatabase

java.lang.Object

io.permazen.kv.simple.SimpleKVDatabase

io.permazen.kv.simple.MemoryKVDatabase

io.permazen.kv.simple.XMLKVDatabase

io.permazen.spring.SpringXMLKVDatabase

All Implemented Interfaces:

KVDatabase, Serializable

public class SpringXMLKVDatabase
extends XMLKVDatabase

XMLKVDatabase that adds support for loading the default initial content from any Spring Resource. For example, this allows initial content to be loaded from the classpath.

Instances are serializable if the configured StreamRepository and default initial content resource are.

See Also:

• XMLKVDatabase
• Serialized Form

Field Summary

Fields inherited from class io.permazen.kv.simple.SimpleKVDatabase

DEFAULT_HOLD_TIMEOUT, DEFAULT_WAIT_TIMEOUT, kv, log

Constructor Summary

Constructors

Constructor	Description
SpringXMLKVDatabase(File file)	Normal constructor.
SpringXMLKVDatabase(StreamRepository repository)	Constructor allowing storage in any user-supplied StreamRepository.

Method Summary

Modifier and Type	Method	Description
protected InputStream	getInitialContent()	Get the initial content for an uninitialized database.
void	setInitialContentFile(File initialContentFile)	Configure the Resource containing default initial content for an uninitialized database from the specified file.
void	setInitialContentResource(Resource initialContentResource)	Configure the Resource containing default initial content for an uninitialized database.

Methods inherited from class io.permazen.kv.simple.XMLKVDatabase

checkForOutOfBandUpdate, checkState, createTransaction, getGeneration, postCommit, readXML, reload, start, writeXML

Methods inherited from class io.permazen.kv.simple.SimpleKVDatabase

createTransaction, getHoldTimeout, getWaitTimeout, preCommit, setHoldTimeout, setWaitTimeout, stop

Methods inherited from class java.lang.Object

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

Constructor Details

SpringXMLKVDatabase

public SpringXMLKVDatabase(File file)

Normal constructor. Uses a FileStreamRepository backed by the specified file.

Parameters:

file - persistent XML file

Throws:

IllegalArgumentException - if file is null

SpringXMLKVDatabase

public SpringXMLKVDatabase(StreamRepository repository)

Constructor allowing storage in any user-supplied StreamRepository.

Parameters:

repository - XML file storage

Throws:

IllegalArgumentException - if file is null

Method Details

setInitialContentResource

public void setInitialContentResource(Resource initialContentResource)

Configure the Resource containing default initial content for an uninitialized database. This method is invoked by getInitialContent() when, on the first load, the backing XML file is not found.

Parameters:

initialContentResource - resource containing default initial XML database content, or null for none

setInitialContentFile

public void setInitialContentFile(File initialContentFile)

Configure the Resource containing default initial content for an uninitialized database from the specified file.

Overrides:

setInitialContentFile in class XMLKVDatabase

Parameters:

initialContentFile - file containing default initial XML database content, or null for none

getInitialContent

protected InputStream getInitialContent()
                                 throws IOException

Get the initial content for an uninitialized database. This method is invoked when, on the first load, the backing XML file is not found. It should return a stream that reads initial content for the database, if any, otherwise null.

The implementation in SpringXMLKVDatabase returns an InputStream acquired from the Resource configured by setInitialContentResource(), if any, otherwise null.

Overrides:

getInitialContent in class XMLKVDatabase

Returns:

default initial XML database content, or null for none

Throws:

IOException - if an error occurs accessing the initial content file