/*
* Copyright 1999-2004 The Apache Software Foundation.
*
* Licensed 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.Map;
import org.apache.avalon.framework.component.ComponentManager;
import org.apache.avalon.framework.component.Composable;
import org.apache.avalon.framework.logger.AbstractLogEnabled;
import org.apache.cocoon.Constants;
import org.apache.cocoon.components.notification.Notifying;
import org.apache.cocoon.components.notification.NotifyingBuilder;
import org.apache.cocoon.components.treeprocessor.InvokeContext;
import org.apache.cocoon.components.treeprocessor.ProcessingNode;
import org.apache.cocoon.environment.Environment;
import org.apache.cocoon.environment.ObjectModelHelper;
/**
* Helps to call error handlers from PipelineNode and PipelinesNode.
*
* @author <a href="mailto:juergen.seitz@basf-it-services.com">Jürgen Seitz</a>
* @author <a href="mailto:bluetkemeier@s-und-n.de">Björn Lütkemeier</a>
* @version CVS $Id: ErrorHandlerHelper.java,v 1.5 2004/03/13 22:02:30 unico Exp $
*/
public class ErrorHandlerHelper extends AbstractLogEnabled implements Composable {
private ComponentManager manager;
/**
* The component manager is used to create notifying builders.
*/
public void compose(ComponentManager manager) {
this.manager = manager;
}
public boolean invokeErrorHandler(ProcessingNode node, Exception ex, Environment env)
throws Exception {
Map objectModel = env.getObjectModel();
InvokeContext errorContext = null;
boolean nodeSuccessful = false;
try {
if (objectModel.get(Constants.NOTIFYING_OBJECT) == null) {
// error has not been processed by another handler before
// Try to reset the response to avoid mixing already produced output
// and error page.
env.tryResetResponse();
// Create a Notifying
NotifyingBuilder notifyingBuilder= (NotifyingBuilder)this.manager.lookup(NotifyingBuilder.ROLE);
Notifying currentNotifying = null;
try {
currentNotifying = notifyingBuilder.build(this, ex);
} finally {
this.manager.release(notifyingBuilder);
}
// Add it to the object model
objectModel.put(Constants.NOTIFYING_OBJECT, currentNotifying);
// Also add the exception
objectModel.put(ObjectModelHelper.THROWABLE_OBJECT, ex);
}
// Build a new context
errorContext = new InvokeContext();
errorContext.enableLogging(getLogger());
errorContext.compose(this.manager);
nodeSuccessful = node.invoke(env, errorContext);
} catch (Exception subEx) {
getLogger().error("An exception occured while handling errors at " + node.getLocation(), subEx);
// Rethrow it : it will either be handled by the parent sitemap or by the environment (e.g. Cocoon servlet)
throw subEx;
} finally {
if (errorContext != null) {
errorContext.dispose();
}
}
if (nodeSuccessful) {
return true;
} else {
throw ex;
}
}
}