org.jboss.as.controller.persistence

Class AbstractConfigurationPersister

java.lang.Object

org.jboss.as.controller.persistence.AbstractConfigurationPersister

All Implemented Interfaces:

ConfigurationPersister, ExtensibleConfigurationPersister, SubsystemXmlWriterRegistry

Direct Known Subclasses:

NullConfigurationPersister, XmlConfigurationPersister

public abstract class AbstractConfigurationPersister
extends Object
implements ExtensibleConfigurationPersister

Abstract superclass for ExtensibleConfigurationPersister implementations.

Author:

Brian Stansberry

Nested Class Summary

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

ConfigurationPersister.PersistenceResource, ConfigurationPersister.SnapshotInfo

Field Summary

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

NULL_SNAPSHOT_INFO

Constructor Summary

Constructors

Constructor and Description
AbstractConfigurationPersister(org.jboss.staxmapper.XMLElementWriter<ModelMarshallingContext> rootDeparser) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
void	deleteSnapshot(String name) Deletes a snapshot using its name.
ConfigurationPersister.SnapshotInfo	listSnapshots() Gets the names of the snapshots in the snapshots directory
void	marshallAsXml(org.jboss.dmr.ModelNode model, OutputStream output) Marshals the given configuration model to XML, writing to the given stream.
void	registerSubsystemWriter(String name, Supplier<org.jboss.staxmapper.XMLElementWriter<SubsystemMarshallingContext>> writer) Registers the writer that can marshal to XML the configuration of the named subsystem.
void	registerSubsystemWriter(String name, org.jboss.staxmapper.XMLElementWriter<SubsystemMarshallingContext> writer) Registers the writer that can marshal to XML the configuration of the named subsystem.
void	successfulBoot() Called once the xml has been successfully parsed, translated into updates, executed in the target controller and all services have started successfully.
void	unregisterSubsystemWriter(String name) Unregisters the XML configuration writer of the named subsystem.

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, load, publish, snapshot, snapshot, store

Constructor Detail

AbstractConfigurationPersister

public AbstractConfigurationPersister(org.jboss.staxmapper.XMLElementWriter<ModelMarshallingContext> rootDeparser)

Construct a new instance.

Parameters:

rootDeparser - the root model deparser

Method Detail

registerSubsystemWriter

public void registerSubsystemWriter(String name,
                                    org.jboss.staxmapper.XMLElementWriter<SubsystemMarshallingContext> writer)

Description copied from interface: SubsystemXmlWriterRegistry

Registers the writer that can marshal to XML the configuration of the named subsystem.

Specified by:

registerSubsystemWriter in interface SubsystemXmlWriterRegistry

Parameters:

name - the name of the subsystem

writer - the XML writer

registerSubsystemWriter

public void registerSubsystemWriter(String name,
                                    Supplier<org.jboss.staxmapper.XMLElementWriter<SubsystemMarshallingContext>> writer)

Description copied from interface: SubsystemXmlWriterRegistry

Registers the writer that can marshal to XML the configuration of the named subsystem.

Specified by:

registerSubsystemWriter in interface SubsystemXmlWriterRegistry

Parameters:

name - the name of the subsystem

writer - the XML writer

unregisterSubsystemWriter

public void unregisterSubsystemWriter(String name)

Description copied from interface: SubsystemXmlWriterRegistry

Unregisters the XML configuration writer of the named subsystem.

Specified by:

unregisterSubsystemWriter in interface SubsystemXmlWriterRegistry

Parameters:

name - the name of the subsystem

marshallAsXml

public void marshallAsXml(org.jboss.dmr.ModelNode model,
                          OutputStream output)
                   throws ConfigurationPersistenceException

Marshals the given configuration model to XML, writing to the given stream.

Specified by:

marshallAsXml in interface ConfigurationPersister

Parameters:

model - the model to persist

output - the stream

Throws:

ConfigurationPersistenceException - if a configuration persistence problem occurs

successfulBoot

public void successfulBoot()
                    throws ConfigurationPersistenceException

Description copied from interface: ConfigurationPersister

Called once the xml has been successfully parsed, translated into updates, executed in the target controller and all services have started successfully.

Specified by:

successfulBoot in interface ConfigurationPersister

Throws:

ConfigurationPersistenceException

See Also:

ConfigurationPersister.isPersisting()

listSnapshots

public ConfigurationPersister.SnapshotInfo listSnapshots()

Description copied from interface: ConfigurationPersister

Gets the names of the snapshots in the snapshots directory

Specified by:

listSnapshots in interface ConfigurationPersister

Returns:

the snapshot info. This will never return null

deleteSnapshot

public void deleteSnapshot(String name)

Description copied from interface: ConfigurationPersister

Deletes a snapshot using its name.

Specified by:

deleteSnapshot in interface ConfigurationPersister

Parameters:

name - the name of the snapshot (as returned by ConfigurationPersister.SnapshotInfo.names() returned from ConfigurationPersister.listSnapshots(). The whole name is not needed, just enough to uniquely identify it.