/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.cocoon.components.treeprocessor.sitemap;
import java.util.ArrayList;
import java.util.List;
import org.apache.avalon.framework.configuration.Configuration;
import org.apache.avalon.framework.configuration.ConfigurationException;
import org.apache.cocoon.components.pipeline.ProcessingPipeline;
import org.apache.cocoon.components.treeprocessor.AbstractParentProcessingNodeBuilder;
import org.apache.cocoon.components.treeprocessor.ProcessingNode;
import org.apache.cocoon.components.treeprocessor.ProcessingNodeBuilder;
import org.apache.cocoon.components.treeprocessor.TreeBuilder;
import org.apache.cocoon.configuration.Settings;
/**
* Builds a <map:pipeline>
*
* @version $Id: PipelineNodeBuilder.java 607152 2007-12-28 01:32:07Z vgritsenko $
*/
public class PipelineNodeBuilder extends AbstractParentProcessingNodeBuilder {
private static final String ATTRIBUTE_INTERNAL_ONLY = "internal-only";
private static final String PROPERTY_SITEMAP_INTERNALONLY = "org.apache.cocoon.sitemap.internalonly.disable";
/** Will the ignore-internal flag of a pipeline be ignored? */
protected boolean ignoreInternalOnly;
/**
* @see org.apache.cocoon.components.treeprocessor.AbstractProcessingNodeBuilder#setBuilder(org.apache.cocoon.components.treeprocessor.TreeBuilder)
*/
public void setBuilder(TreeBuilder treeBuilder) {
super.setBuilder(treeBuilder);
// check ssettings for ignoring of internal only pipeline flags
this.ignoreInternalOnly = false;
final Settings settings = (Settings)treeBuilder.getWebApplicationContext().getBean(Settings.ROLE);
final String value = settings.getProperty(PipelineNodeBuilder.PROPERTY_SITEMAP_INTERNALONLY);
if ( value != null ) {
this.ignoreInternalOnly = Boolean.valueOf(value).booleanValue();
}
}
/** This builder can have parameters -- return <code>true</code> */
protected boolean hasParameters() {
return true;
}
/**
* @see org.apache.cocoon.components.treeprocessor.ProcessingNodeBuilder#buildNode(org.apache.avalon.framework.configuration.Configuration)
*/
public ProcessingNode buildNode(Configuration config)
throws Exception {
String type = this.treeBuilder.getTypeForStatement(config, ProcessingPipeline.ROLE);
PipelineNode node = new PipelineNode(type);
this.treeBuilder.setupNode(node, config);
// if internal only is ignore, all pipelines are directly accessible
if ( this.ignoreInternalOnly ) {
node.setInternalOnly(false);
} else {
node.setInternalOnly(config.getAttributeAsBoolean(PipelineNodeBuilder.ATTRIBUTE_INTERNAL_ONLY, false));
}
// Error handler node
HandleErrorsNode handler = null;
Configuration[] childConfigs = config.getChildren();
List children = new ArrayList();
for (int i = 0; i < childConfigs.length; i++) {
Configuration childConfig = childConfigs[i];
if (isChild(childConfig)) {
ProcessingNodeBuilder builder = this.treeBuilder.createNodeBuilder(childConfig);
if (builder instanceof HandleErrorsNodeBuilder) {
if (handler != null) {
throw new ConfigurationException("Duplicate <handle-errors> at " + handler.getLocation());
}
// Error handler : check type
handler = (HandleErrorsNode) builder.buildNode(childConfig);
} else {
// Regular builder
children.add(builder.buildNode(childConfig));
}
}
}
node.setChildren(toNodeArray(children));
node.setErrorHandler(handler);
return node;
}
}