Package org.jboss.as.controller.persistence

Class XmlConfigurationPersister

java.lang.Object

org.jboss.as.controller.persistence.AbstractConfigurationPersister

org.jboss.as.controller.persistence.XmlConfigurationPersister

All Implemented Interfaces:

ConfigurationPersister, ExtensibleConfigurationPersister, SubsystemXmlWriterRegistry

Direct Known Subclasses:

BackupXmlConfigurationPersister

public class XmlConfigurationPersister
extends AbstractConfigurationPersister

A configuration persister which uses an XML file for backing storage.

Author:

David M. Lloyd

Nested Class Summary

Nested classes/interfaces inherited from interface org.jboss.as.controller.persistence.ConfigurationPersister

ConfigurationPersister.PersistenceResource, ConfigurationPersister.SnapshotInfo

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	stored

Fields inherited from interface org.jboss.as.controller.persistence.ConfigurationPersister

NULL_SNAPSHOT_INFO

Constructor Summary

Constructors

Constructor	Description
XmlConfigurationPersister(File fileName, QName rootElement, org.jboss.staxmapper.XMLElementReader<List<org.jboss.dmr.ModelNode>> rootParser, org.jboss.staxmapper.XMLElementWriter<ModelMarshallingContext> rootDeparser)	Construct a new instance.
XmlConfigurationPersister(File fileName, QName rootElement, org.jboss.staxmapper.XMLElementReader<List<org.jboss.dmr.ModelNode>> rootParser, org.jboss.staxmapper.XMLElementWriter<ModelMarshallingContext> rootDeparser, boolean suppressLoad)	Construct a new instance.

Method Summary

Modifier and Type	Method	Description
boolean	hasStored()	Gets whether a call persist to persistent storage has been successfully completed.
List<org.jboss.dmr.ModelNode>	load()	Load the configuration model, returning it as a list of updates to be executed by the controller.
void	registerAdditionalRootElement(QName anotherRoot, org.jboss.staxmapper.XMLElementReader<List<org.jboss.dmr.ModelNode>> parser)
ConfigurationPersister.PersistenceResource	store(org.jboss.dmr.ModelNode model, Set<PathAddress> affectedAddresses)	Persist the given configuration model if ConfigurationPersister.isPersisting() would return true, otherwise return a no-op ConfigurationPersister.PersistenceResource.
protected void	successfulBoot(File file)

Methods inherited from class org.jboss.as.controller.persistence.AbstractConfigurationPersister

deleteSnapshot, listSnapshots, marshallAsXml, registerSubsystemWriter, successfulBoot, unregisterSubsystemWriter

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jboss.as.controller.persistence.ConfigurationPersister

isPersisting, publish, snapshot

Field Details

stored

protected volatile boolean stored

Constructor Details

XmlConfigurationPersister

public XmlConfigurationPersister(File fileName,
 QName rootElement,
 org.jboss.staxmapper.XMLElementReader<List<org.jboss.dmr.ModelNode>> rootParser,
 org.jboss.staxmapper.XMLElementWriter<ModelMarshallingContext> rootDeparser)

Construct a new instance.

Parameters:

fileName - the configuration base file name

rootElement - the root element of the configuration file

rootParser - the root model parser

rootDeparser - the root model deparser

XmlConfigurationPersister

public XmlConfigurationPersister(File fileName,
 QName rootElement,
 org.jboss.staxmapper.XMLElementReader<List<org.jboss.dmr.ModelNode>> rootParser,
 org.jboss.staxmapper.XMLElementWriter<ModelMarshallingContext> rootDeparser,
 boolean suppressLoad)

Construct a new instance.

Parameters:

fileName - the configuration base file name

rootElement - the root element of the configuration file

rootParser - the root model parser

rootDeparser - the root model deparser

Method Details

registerAdditionalRootElement

public void registerAdditionalRootElement(QName anotherRoot,
 org.jboss.staxmapper.XMLElementReader<List<org.jboss.dmr.ModelNode>> parser)

store

public ConfigurationPersister.PersistenceResource store(org.jboss.dmr.ModelNode model,
 Set<PathAddress> affectedAddresses)
                                                 throws ConfigurationPersistenceException

Persist the given configuration model if ConfigurationPersister.isPersisting() would return true, otherwise return a no-op ConfigurationPersister.PersistenceResource.

Parameters:

model - the model to persist

affectedAddresses - the addresses of the resources that were changed

Returns:

callback to use to control whether the stored model should be flushed to permanent storage. Will not be null

Throws:

ConfigurationPersistenceException - if a configuration persistence problem occurs

load

public List<org.jboss.dmr.ModelNode> load()
                                   throws ConfigurationPersistenceException

Load the configuration model, returning it as a list of updates to be executed by the controller.

Returns:

the configuration model as a list of updates to be executed by the controller.

Throws:

ConfigurationPersistenceException - if a configuration persistence problem occurs

successfulBoot

protected void successfulBoot(File file)
                       throws ConfigurationPersistenceException

Throws:

ConfigurationPersistenceException

hasStored

public boolean hasStored()

Description copied from interface: ConfigurationPersister

Gets whether a call persist to persistent storage has been successfully completed.

The default implementation always returns false

Returns:

true if a call to ConfigurationPersister.store(ModelNode, Set) will return an object that actually writes