com.goldencode.p2j.directory

Class XmlRemapper

java.lang.Object

com.goldencode.p2j.directory.RamRemapper

com.goldencode.p2j.directory.XmlRemapper

All Implemented Interfaces:

Remapper

class XmlRemapper
extends RamRemapper

The implementation of the Remapper interface which uses XML file as a backing storage for the directory data.

XmlRemapper is derived from the RamRemapper which implements all back-end functionality related to directory services and combines it with loading/saving data from/to XML file implemented by the XmlRemapperIO class.

Version:

1.0

Author:

SIY

Field Summary

Fields

Modifier and Type	Field and Description
private java.io.File	file XML file which will be used to load and store data
private boolean	mustExist XML file must exist flag

Fields inherited from class com.goldencode.p2j.directory.RamRemapper

mutex, root

Constructor Summary

Constructors

Constructor and Description
XmlRemapper(BootstrapConfig config) Construct an instance of the XmlRemapper for a given file.

Method Summary

Modifier and Type	Method and Description
protected void	load() Load tree from the XML document.
private boolean	renameTo(java.io.File srcFile, java.io.File dstFile) File.renameTo(File) implementation is platform dependent.
protected void	save() Save current tree into XML file.
int	save(java.lang.String newFile) Save current tree into XML specified file.
private void	saveWorker(java.io.File file, int[] res) Save current tree into XML specified file.

Methods inherited from class com.goldencode.p2j.directory.RamRemapper

addAttributeValueExt, addNode, addNodeBitField, addNodeBitSelector, addNodeBoolean, addNodeByteArray, addNodeDate, addNodeDouble, addNodeExt, addNodeInteger, addNodeString, addNodeTime, bind, deleteNode, deleteNodeAttribute, deleteNodeAttributeExt, deleteNodeAttributeValue, deleteNodeAttributeValueExt, deleteNodeExt, enumerateNodeAttributes, enumerateNodes, getClassDefinition, getClassNames, getNodeBitField, getNodeBitSelector, getNodeBoolean, getNodeByteArray, getNodeClassName, getNodeDate, getNodeDouble, getNodeInteger, getNodeString, getNodeTime, getNodeValueExt, getObjClass, getRoot, isBound, isClassImmutable, isClassLeaf, locateNode, moveNode, moveNodeExt, refresh, setNodeBitField, setNodeBitSelector, setNodeBoolean, setNodeByteArray, setNodeDate, setNodeDouble, setNodeInteger, setNodeString, setNodeTime, setNodeValueExt, setRoot, unbind, update

Methods inherited from class java.lang.Object

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

Field Detail

file

private java.io.File file

XML file which will be used to load and store data

mustExist

private boolean mustExist

XML file must exist flag

Constructor Detail

XmlRemapper

XmlRemapper(BootstrapConfig config)
     throws ConfigurationException

Construct an instance of the XmlRemapper for a given file.

Parameters:

config - Configuration data.

Throws:

ConfigurationException - in case of configuration error.

Method Detail

load

protected void load()
             throws java.lang.Exception

Load tree from the XML document.

Overrides:

load in class RamRemapper

Throws:

java.lang.Exception - Various exceptions are forwarded from XmlHelper or thrown in case of errors.

save

protected void save()
             throws java.lang.Exception

Save current tree into XML file.

Overrides:

save in class RamRemapper

Throws:

java.lang.Exception - If I/O error occurred during operation or XmlHelper throws an ParserConfigurationException.

save

public int save(java.lang.String newFile)

Save current tree into XML specified file.

Parameters:

newFile - Name of file to save the directory.

Returns:

return code (refer to DirectoryService for possible error codes).

saveWorker

private void saveWorker(java.io.File file,
                        int[] res)
                 throws java.lang.Exception

Save current tree into XML specified file.

Throws:

java.lang.Exception - If I/O error occurred during operation or XmlHelper throws an ParserConfigurationException.

renameTo

private boolean renameTo(java.io.File srcFile,
                         java.io.File dstFile)

File.renameTo(File) implementation is platform dependent. In Windows if target file already exists the execution of this method fails. In Linux on the other hands succeed. A cross platform solution is implemented using JDK 7 Files.move feature.

Parameters:

srcFile - source file.

dstFile - destination file.

Returns:

true on success false on failure.