info.magnolia.jackrabbit

Class WorkspaceConfigurationMerger

java.lang.Object

info.magnolia.jackrabbit.WorkspaceConfigurationMerger

public class WorkspaceConfigurationMerger
extends Object

Helper class for creating an on the fly workspace.xml configurations from a template repository.xml and a stub workspace.xml.

Constructor Summary

Constructors

Constructor and Description
WorkspaceConfigurationMerger()

Method Summary

Modifier and Type

Method and Description

static void

merge(InputStream repositoryXml, InputStream workspaceStubXml, OutputStream workspaceXml) Create an on the fly workspaceXml configuration by merging elements from repositoryXml into workspaceStubXml: Every direct child element of the Workspace element of repositoryXml is added as a direct child element to the Workspace element of workspaceStubXml unless an element of the same name already exists. No elements are added if a Workspace element does not exist in either repositoryXml or workspaceStubXml. Every empty direct child element from thw Workspace element of workspaceStubXml is removed.

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkspaceConfigurationMerger

public WorkspaceConfigurationMerger()

Method Detail

merge

public static void merge(InputStream repositoryXml,
                         InputStream workspaceStubXml,
                         OutputStream workspaceXml)
                  throws ParserConfigurationException,
                         IOException,
                         SAXException,
                         TransformerException

Create an on the fly workspaceXml configuration by merging elements from repositoryXml into workspaceStubXml:

• Every direct child element of the Workspace element of repositoryXml is added as a direct child element to the Workspace element of workspaceStubXml unless an element of the same name already exists.
• No elements are added if a Workspace element does not exist in either repositoryXml or workspaceStubXml.
• Every empty direct child element from thw Workspace element of workspaceStubXml is removed.

This arrangement allows inheriting, overriding and removing elements from repositoryXml in workspaceStubXml.

Parameters:

repositoryXml - input stream containing a valid repository.xml. It is the responsibility of the caller to close this stream.

workspaceStubXml - input stream containing a stub workspace.xml. It is the responsibility of the caller to close this stream.

workspaceXml - output stream receiving the result of the merge operation. It is the responsibility of the caller to close this stream.

Throws:

ParserConfigurationException - when failing to acquire an XML parser

IOException - when an IO error occurs during reading from the input streams

SAXException - if any error occurs when parsing the xml from the input streams

TransformerException - when an error occurs while during merging