/*
============================================================================
The Apache Software License, Version 1.1
============================================================================
Copyright (C) 1999-2003 The Apache Software Foundation. All rights reserved.
Redistribution and use in source and binary forms, with or without modifica-
tion, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
3. The end-user documentation included with the redistribution, if any, must
include the following acknowledgment: "This product includes software
developed by the Apache Software Foundation (http://www.apache.org/)."
Alternately, this acknowledgment may appear in the software itself, if
and wherever such third-party acknowledgments normally appear.
4. The names "Apache Cocoon" and "Apache Software Foundation" must not be
used to endorse or promote products derived from this software without
prior written permission. For written permission, please contact
apache@apache.org.
5. Products derived from this software may not be called "Apache", nor may
"Apache" appear in their name, without prior written permission of the
Apache Software Foundation.
THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
APACHE SOFTWARE FOUNDATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLU-
DING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
This software consists of voluntary contributions made by many individuals
on behalf of the Apache Software Foundation and was originally created by
Stefano Mazzocchi <stefano@apache.org>. For more information on the Apache
Software Foundation, please see <http://www.apache.org/>.
*/
package org.apache.cocoon.components.modules.output;
import java.util.Map;
import org.apache.avalon.framework.activity.Disposable;
import org.apache.avalon.framework.configuration.Configurable;
import org.apache.avalon.framework.configuration.Configuration;
import org.apache.avalon.framework.configuration.ConfigurationException;
import org.apache.avalon.framework.logger.AbstractLogEnabled;
import org.apache.cocoon.environment.ObjectModelHelper;
import org.apache.cocoon.environment.Request;
import org.apache.cocoon.util.HashMap;
//import java.util.HashMap;
/**
* AbstractOutputModule gives you the infrastructure for easily
* deploying more output modules. In order to get at the
* Logger, use getLogger().
*
* @author <a href="mailto:haul@apache.org">Christian Haul</a>
* @version CVS $Id: AbstractOutputModule.java,v 1.2 2003/03/12 13:27:34 haul Exp $
*/
public abstract class AbstractOutputModule extends AbstractLogEnabled
implements OutputModule, Configurable, Disposable {
/**
* Stores (global) configuration parameters as <code>key</code> /
* <code>value</code> pairs.
*/
protected HashMap settings = null;
/**
* Configures the module.
*
* Takes all elements nested in component declaration and stores
* them as key-value pairs in <code>settings</code>. Nested
* configuration option are not catered for. This way global
* configuration options can be used.
*
* For nested configurations override this function.
* */
public void configure(Configuration conf) throws ConfigurationException {
Configuration[] parameters = conf.getChildren();
this.settings = new HashMap(parameters.length);
for (int i = 0; i < parameters.length; i++) {
String key = parameters[i].getName();
String val = parameters[i].getValue("");
this.settings.put(key, val);
}
}
/**
* dispose
*/
public void dispose() {
// Purposely empty so that we don't need to implement it in every
// class.
}
/**
* Utility method to store parameters in a map as request attribute until
* either {@link #rollback rollback} or {@link #prepareCommit prepareCommit}
* is called.
* @param objectModel - the objectModel
* @param trans_place - request attribute name used for the transient data
* @param name - name of the attribute to set
* @param value - attribute value
*/
protected void transientSetAttribute( Map objectModel, String trans_place, String name, Object value ) {
Request request = ObjectModelHelper.getRequest(objectModel);
Object temp = request.getAttribute(trans_place);
Map aMap = null;
if (temp == null) {
aMap = new java.util.HashMap();
// need java.util.HashMap here since JXPath does not like the extended version...
} else {
aMap = (Map) temp;
}
aMap.put(name,value);
request.setAttribute(trans_place, aMap);
}
/**
* Clears all uncommitted transient attributes.
* @param objectModel - the objectModel
* @param trans_place - request attribute name used for the transient data
*/
protected void rollback( Map objectModel, String trans_place) {
ObjectModelHelper.getRequest(objectModel).setAttribute(trans_place, null);
}
/**
* Returns a whether an transient attribute already exists.
* {@link #transientSetAttribute transientSetAttribute} since the last call to
* {@link #rollback rollback} or {@link #prepareCommit prepareCommit}
* @param objectModel - the objectModel
* @param trans_place - request attribute name used for the transient data
*/
protected boolean attributeExists( Map objectModel, String trans_place, String name )
{
Request request = ObjectModelHelper.getRequest(objectModel);
Object temp = request.getAttribute(trans_place);
if (temp == null) {
return false;
} else {
return ((Map) temp).containsKey(name);
}
}
/**
* Returns a map containing all transient attributes and remove them i.e. attributes set with
* {@link #transientSetAttribute transientSetAttribute} since the last call to
* {@link #rollback rollback} or {@link #prepareCommit prepareCommit}
* @param objectModel - the objectModel
* @param trans_place - request attribute name used for the transient data
*/
protected Map prepareCommit( Map objectModel, String trans_place )
{
Request request = ObjectModelHelper.getRequest(objectModel);
Object temp = request.getAttribute(trans_place);
request.setAttribute(trans_place, null);
if (temp == null) {
return null;
} else {
return (Map) temp;
}
}
}