net.officefloor.woof.template.WoofTemplateExtensionLoaderUtil Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of officeweb_configuration Show documentation
Show all versions of officeweb_configuration Show documentation
Configuration for WoOF (Web on OfficeFloor)
/*
* OfficeFloor - http://www.officefloor.net
* Copyright (C) 2005-2018 Daniel Sagenschneider
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see {@link WoofTemplateExtensionSource}
* type.
* @param woofTemplateExtensionSourceClass {@link WoofTemplateExtensionSource}
* class.
* @param propertyNameLabels Listing of name/label pairs for the
* {@link Property} instances.
* @return Loaded {@link PropertyList}.
*/
public static PropertyList validateSpecification(
Class woofTemplateExtensionSourceClass, String... propertyNameLabels) {
return validateSpecification(woofTemplateExtensionSourceClass, null, propertyNameLabels);
}
/**
* Validates the {@link WoofTemplateExtensionSourceSpecification} for the
* {@link WoofTemplateExtensionSource}.
*
* @param {@link WoofTemplateExtensionSource}
* type.
* @param woofTemplateExtensionSourceClass {@link WoofTemplateExtensionSource}
* class.
* @param classLoader {@link ClassLoader}. May be
* null.
* @param propertyNameLabels Listing of name/label pairs for the
* {@link Property} instances.
* @return Loaded {@link PropertyList}.
*/
public static PropertyList validateSpecification(
Class woofTemplateExtensionSourceClass, ClassLoader classLoader, String... propertyNameLabels) {
// Load the specification
PropertyList propertyList = getWoofTemplateExtensionLoader()
.loadSpecification(woofTemplateExtensionSourceClass.getName(), classLoader, getCompilerIssues());
// Verify the properties
PropertyListUtil.validatePropertyNameLabels(propertyList, propertyNameLabels);
// Return the property list
return propertyList;
}
/**
* Creates the {@link SourceProperties}.
*
* @param propertyNameValues Property name/value pairs.
* @return {@link SourceProperties}.
*/
public static SourceProperties createSourceProperties(String... propertyNameValues) {
return new SourcePropertiesImpl(propertyNameValues);
}
/**
* Obtains the {@link WoofChangeIssues}.
*
* @return {@link WoofChangeIssues}.
*/
public static WoofChangeIssues getWoofChangeIssues() {
final OfficeFloorCompiler compiler = OfficeFloorCompiler.newOfficeFloorCompiler(null);
final CompilerIssues issues = getCompilerIssues();
return new WoofChangeIssues() {
@Override
public void addIssue(String message, Throwable cause) {
issues.addIssue(compiler, message, cause);
}
@Override
public void addIssue(String message) {
issues.addIssue(compiler, message);
}
};
}
/**
* Creates the {@link Change} for refactoring.
*
* @param {@link WoofTemplateExtensionSource}
* type.
* @param woofTemplateExtensionSourceClass {@link WoofTemplateExtensionSource}
* class.
* @param oldUri Old URI.
* @param oldProperties Old {@link SourceProperties}.
* @param newUri New URI.
* @param newProperties New {@link SourceProperties}.
* @return {@link Change} for refactoring. May be null.
*/
public static Change refactorTemplateExtension(
Class woofTemplateExtensionSourceClass, String oldUri, SourceProperties oldProperties, String newUri,
SourceProperties newProperties) {
return refactorTemplateExtension(woofTemplateExtensionSourceClass, oldUri, oldProperties, newUri, newProperties,
null, null);
}
/**
* Creates the {@link Change} for refactoring.
*
* @param {@link WoofTemplateExtensionSource}
* type.
* @param woofTemplateExtensionSourceClass {@link WoofTemplateExtensionSource}
* class.
* @param oldUri Old URI.
* @param oldProperties Old {@link SourceProperties}.
* @param newUri New URI.
* @param newProperties New {@link SourceProperties}.
* @param configurationContext {@link ConfigurationContext}. May be
* null.
* @param classLoader {@link ClassLoader}.
* @param resourceSources {@link ResourceSource} instances.
* @return {@link Change} for refactoring. May be null.
*/
public static Change refactorTemplateExtension(
Class woofTemplateExtensionSourceClass, String oldUri, SourceProperties oldProperties, String newUri,
SourceProperties newProperties, ConfigurationContext configurationContext, ClassLoader classLoader,
ResourceSource... resourceSources) {
// Ensure have configuration context
if (configurationContext == null) {
configurationContext = new MemoryConfigurationContext();
}
// Create the source context
SourceContext sourceContext = getSourceContext(classLoader, resourceSources);
// Obtain the extension source class name
String extensionSourceClassName = woofTemplateExtensionSourceClass.getName();
// Obtain the WoOF change issues
WoofChangeIssues issues = getWoofChangeIssues();
// Load the change
Change change = getWoofTemplateExtensionLoader().refactorTemplateExtension(extensionSourceClassName, oldUri,
oldProperties, newUri, newProperties, configurationContext, sourceContext, issues);
// Return the change
return change;
}
/**
* Convenience method to validate the {@link ConfigurationItem}.
*
* @param context {@link ConfigurationContext}.
* @param location Location of the {@link ConfigurationItem}.
* @param content Expected content of the {@link ConfigurationItem}. May be
* null to indicate no expecting
* {@link ConfigurationItem}.
* @throws Exception If failure in accessing {@link ConfigurationItem}.
*/
public static void validateConfigurationItem(ConfigurationContext context, String location, String content)
throws Exception {
// Obtain the configuration item
ConfigurationItem item = context.getConfigurationItem(location, null);
// Determine if expecting the configuration item
if (content == null) {
Assert.assertNull("Should be no configuration item at location " + location, item);
return;
}
// Ensure have the configuration item
Assert.assertNotNull("Should have configuration item for location " + location, item);
// Load the content of the configuration item
Reader reader = item.getReader();
StringWriter buffer = new StringWriter();
for (int character = reader.read(); character != -1; character = reader.read()) {
buffer.write(character);
}
// Ensure correct content
OfficeFrameTestCase.assertXmlEquals("Incorrect content for configuration item at location " + location, content,
buffer.toString());
}
/**
* Convenience method to validate the {@link ConfigurationItem}.
*
* @param context {@link ConfigurationContext}.
* @param location Location of the {@link ConfigurationItem}.
* @param content Expected content of the {@link ConfigurationItem}. May be
* null to indicate no expecting
* {@link ConfigurationItem}.
* @throws Exception If fails accessing the {@link ConfigurationItem}.
*/
public static void validateConfigurationItem(ConfigurationContext context, String location, Reader content)
throws Exception {
// Obtain the content as string
StringWriter buffer = null;
if (content != null) {
// Load the content into a buffer
buffer = new StringWriter();
for (int character = content.read(); character != -1; character = content.read()) {
buffer.write(character);
}
}
String stringContent = (buffer == null ? null : buffer.toString());
// Validate the configuration item
validateConfigurationItem(context, location, stringContent);
}
/**
* Undertakes the extending of the {@link WebTemplate} by the
* {@link WoofTemplateExtensionSource}.
*
* @param {@link WoofTemplateExtensionSource} type.
* @param extensionSourceClass {@link WoofTemplateExtensionSource} class.
* @param applicationPath Application path to the {@link WebTemplate}.
* @param template {@link WebTemplate}.
* @param officeArchitect {@link OfficeArchitect}.
* @param webArchitect {@link WebArchitect}.
* @param propertyNameValues {@link Property} name/value pairs.
* @throws Exception If fails to extend {@link WebTemplate}.
*/
public static void extendTemplate(Class extensionSourceClass,
String applicationPath, WebTemplate template, OfficeArchitect officeArchitect, WebArchitect webArchitect,
String... propertyNameValues) throws Exception {
extendTemplate(extensionSourceClass, applicationPath, template, officeArchitect, webArchitect, null, null,
propertyNameValues);
}
/**
* Undertakes the extending of the {@link WebTemplate} by the
* {@link WoofTemplateExtensionSource}.
*
* @param {@link WoofTemplateExtensionSource} type.
* @param extensionSourceClass {@link WoofTemplateExtensionSource} class.
* @param templatePath URL path to the {@link WebTemplate}.
* @param template {@link WebTemplate}.
* @param officeArchitect {@link OfficeArchitect}.
* @param webArchitect {@link WebArchitect}.
* @param classLoader {@link ClassLoader}. May be null.
* @param resourceSources {@link ResourceSource} instances. May be
* null.
* @param propertyNameValues {@link Property} name/value pairs.
* @throws Exception If fails to extend {@link WebTemplate}.
*/
public static void extendTemplate(Class extensionSourceClass,
String templatePath, WebTemplate template, OfficeArchitect officeArchitect, WebArchitect webArchitect,
ClassLoader classLoader, ResourceSource[] resourceSources, String... propertyNameValues) throws Exception {
// Obtains the source context
SourceContext sourceContext = getSourceContext(classLoader, resourceSources);
// Create the properties
PropertyList properties = new PropertyListImpl(propertyNameValues);
// Undertake the extension of the template
getWoofTemplateExtensionLoader().extendTemplate(extensionSourceClass.getDeclaredConstructor().newInstance(),
properties, templatePath, template, officeArchitect, webArchitect, sourceContext);
}
/**
* Obtains the {@link WoofTemplateExtensionLoader}.
*
* @return {@link WoofTemplateExtensionLoader}.
*/
private static WoofTemplateExtensionLoader getWoofTemplateExtensionLoader() {
return new WoofTemplateExtensionLoaderImpl();
}
/**
* Obtains the {@link SourceContext}.
*
* @param classLoader {@link ClassLoader}. May be null.
* @param resourceSources {@link ResourceSource} instances. May be
* null.
* @return {@link SourceContext}.
*/
private static SourceContext getSourceContext(ClassLoader classLoader, ResourceSource[] resourceSources) {
// Ensure have class loader
if (classLoader == null) {
classLoader = Thread.currentThread().getContextClassLoader();
}
// Ensure have resource sources
if (resourceSources == null) {
resourceSources = new ResourceSource[0];
}
// Return the source context
return new SourceContextImpl(WoofTemplateExtensionLoaderUtil.class.getName(), false, classLoader,
new MockClockFactory(), resourceSources);
}
/**
* Obtains the {@link CompilerIssues}.
*
* @return {@link CompilerIssues}.
*/
private static CompilerIssues getCompilerIssues() {
return new FailTestCompilerIssues();
}
/**
* All access via static methods.
*/
private WoofTemplateExtensionLoaderUtil() {
}
}© 2015 - 2025 Weber Informatics LLC | Privacy Policy