org.apache.sling.rewriter.Processor Maven / Gradle / Ivy
/*
* 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.sling.rewriter;
import java.io.IOException;
import java.io.PrintWriter;
import org.xml.sax.ContentHandler;
/**
* A Processor post processes the output.
*/
public interface Processor {
/**
* Initialize this component.
* @param context The invocation context.
* @param config The configuration for this component.
* @throws IOException If an error occurs
*/
void init(ProcessingContext context,
ProcessorConfiguration config)
throws IOException;
/**
* Get the writer to write the output to.
* @return A print writer.
*/
PrintWriter getWriter();
/**
* Get the content handler to write the output to.
* @return A content handler
*/
ContentHandler getContentHandler();
/**
* Clean up the processor.
* This method should always be called after a processor run, regardless if it was successfull or failed.
* @param errorOccured Indicates if an error occured during processing
*/
void finished(boolean errorOccured) throws IOException;
}