/*
* 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.pipeline.impl;
import org.apache.avalon.framework.activity.Disposable;
import org.apache.avalon.framework.component.ComponentException;
import org.apache.avalon.framework.parameters.ParameterException;
import org.apache.avalon.framework.parameters.Parameters;
import org.apache.cocoon.caching.Cache;
import org.apache.cocoon.components.pipeline.AbstractProcessingPipeline;
import org.apache.cocoon.components.sax.XMLDeserializer;
import org.apache.cocoon.components.sax.XMLSerializer;
/**
* This is the base class for all caching pipeline implementations.
* The pipeline can be configured with the {@link Cache} to use
* by specifying the <code>cache-role</code> parameter.
*
* @since 2.1
* @author <a href="mailto:cziegeler@apache.org">Carsten Ziegeler</a>
* @version CVS $Id: BaseCachingProcessingPipeline.java,v 1.2 2004/03/05 13:02:50 bdelacretaz Exp $
*/
public abstract class BaseCachingProcessingPipeline
extends AbstractProcessingPipeline
implements Disposable {
/** This is the Cache holding cached responses */
protected Cache cache;
/** The deserializer */
protected XMLDeserializer xmlDeserializer;
/** The serializer */
protected XMLSerializer xmlSerializer;
/**
* Parameterizable Interface - Configuration
*/
public void parameterize(Parameters params)
throws ParameterException {
super.parameterize(params);
String cacheRole = params.getParameter("cache-role", Cache.ROLE);
if ( this.getLogger().isDebugEnabled()) {
this.getLogger().debug("Using cache " + cacheRole);
}
try {
this.cache = (Cache)this.manager.lookup(cacheRole);
} catch (ComponentException ce) {
throw new ParameterException("Unable to lookup cache: " + cacheRole, ce);
}
}
/**
* Recyclable Interface
*/
public void recycle() {
this.manager.release( this.xmlDeserializer );
this.xmlDeserializer = null;
this.manager.release( this.xmlSerializer );
this.xmlSerializer = null;
super.recycle();
}
/**
* Disposable Interface
*/
public void dispose() {
if ( null != this.manager ) {
this.manager.release(this.cache);
}
this.cache = null;
this.manager = null;
}
}