org.jboss.as.host.controller

Class HostControllerConfigurationPersister

java.lang.Object

org.jboss.as.host.controller.HostControllerConfigurationPersister

All Implemented Interfaces:

ConfigurationPersister, ExtensibleConfigurationPersister, SubsystemXmlWriterRegistry

public class HostControllerConfigurationPersister
extends Object
implements ExtensibleConfigurationPersister

Configuration persister that can delegate to a domain or host persister depending what needs to be persisted.

Author:

Brian Stansberry (c) 2011 Red Hat Inc.

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
HostControllerConfigurationPersister(HostControllerEnvironment environment, LocalHostControllerInfo localHostControllerInfo, ExecutorService executorService, ExtensionRegistry extensionRegistry)

Method Summary

Modifier and Type	Method and Description
void	deleteSnapshot(String name) Deletes a snapshot using its name.
ExtensibleConfigurationPersister	getDomainPersister()
ExtensibleConfigurationPersister	getHostPersister()
void	initializeDomainConfigurationPersister(boolean slave)
boolean	isSlave()
ConfigurationPersister.SnapshotInfo	listSnapshots() Gets the names of the snapshots in the snapshots directory
List<org.jboss.dmr.ModelNode>	load() Load the configuration model, returning it as a list of updates to be executed by the controller.
void	marshallAsXml(org.jboss.dmr.ModelNode model, OutputStream output) Marshals the given configuration model to XML, writing to the given stream.
void	registerSubsystemDeploymentWriter(String name, org.jboss.staxmapper.XMLElementWriter<SubsystemMarshallingContext> writer) Deprecated.
void	registerSubsystemWriter(String name, org.jboss.staxmapper.XMLElementWriter<SubsystemMarshallingContext> writer) Registers the writer that can marshal to XML the configuration of the named subsystem.
String	snapshot() Take a snapshot of the current configuration
ConfigurationPersister.PersistenceResource	store(org.jboss.dmr.ModelNode model, Set<PathAddress> affectedAddresses) Persist the given configuration model.
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	unregisterSubsystemDeploymentWriter(String name) Deprecated.
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

Constructor Detail

HostControllerConfigurationPersister

public HostControllerConfigurationPersister(HostControllerEnvironment environment,
                                            LocalHostControllerInfo localHostControllerInfo,
                                            ExecutorService executorService,
                                            ExtensionRegistry extensionRegistry)

Method Detail

initializeDomainConfigurationPersister

public void initializeDomainConfigurationPersister(boolean slave)

isSlave

public boolean isSlave()

getDomainPersister

public ExtensibleConfigurationPersister getDomainPersister()

getHostPersister

public ExtensibleConfigurationPersister getHostPersister()

store

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

Description copied from interface: ConfigurationPersister

Persist the given configuration model.

Specified by:

store in interface ConfigurationPersister

Parameters:

model - the model to persist

Returns:

callback to use to control whether the stored model should be flushed to persistent storage

Throws:

ConfigurationPersistenceException

marshallAsXml

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

Description copied from interface: ConfigurationPersister

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

load

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

Description copied from interface: ConfigurationPersister

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

Specified by:

load in interface ConfigurationPersister

Throws:

ConfigurationPersistenceException

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

snapshot

public String snapshot()
                throws ConfigurationPersistenceException

Description copied from interface: ConfigurationPersister

Take a snapshot of the current configuration

Specified by:

snapshot in interface ConfigurationPersister

Returns:

the location of the snapshot

Throws:

ConfigurationPersistenceException - if a problem happened when creating the snapshot

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.

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

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

registerSubsystemDeploymentWriter

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

Deprecated.

Description copied from interface: SubsystemXmlWriterRegistry

Register the writer for the per-deployment configuration for the named subsystem. (TODO: round this out.)

Specified by:

registerSubsystemDeploymentWriter in interface SubsystemXmlWriterRegistry

Parameters:

name - the name of the subsystem

writer - the XML writer

unregisterSubsystemDeploymentWriter

@Deprecated
public void unregisterSubsystemDeploymentWriter(String name)

Deprecated.

Description copied from interface: SubsystemXmlWriterRegistry

Unregisters the per-deployment XML configuration writer of the named subsystem.

Specified by:

unregisterSubsystemDeploymentWriter in interface SubsystemXmlWriterRegistry

Parameters:

name - the name of the subsystem