mosgi/jmx.httpconnector/src/main/java/org/apache/felix/mosgi/jmx/httpconnector/mx4j/tools/adaptor/http/ProcessorMBean.java

/* 
 * 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.felix.mosgi.jmx.httpconnector.mx4j.tools.adaptor.http;

import java.io.IOException;
import org.w3c.dom.Document;

/**
 * Processor ManagementBean, just defines a generic description
 *
 * @author <a href="mailto:tibu@users.sourceforge.net">Carlos Quiroz</a>
 * @version $Revision: 1.1.1.1 $
 */
public interface ProcessorMBean
{
   public String getName();

   /**
    * The method will process the result string and produce an output. The
    * implementor is also responsible to set the mime type, response code and
    * send the headers before answering as follow:
    * <code>
    *    out.setCode(HttpConstants.STATUS_OKAY);
    *    out.setHeader("Content-type", "text/html");
    *    out.sendHeaders();
    *    out.write("some text");
    * </code>
    *
    * @param out The output stream
    * @param in The input stream
    * @param document A document containing the data
    */
   public void writeResponse(HttpOutputStream out, HttpInputStream in, Document document) throws IOException;

   /**
    * The method will process the result exception and produce output. The
    * implementor is also responsible to set the mime type, response code and
    * send the headers before answering as follow:
    * <code>
    *    out.setCode(HttpConstants.STATUS_OKAY);
    *    out.setHeader("Content-type", "text/html");
    *    out.sendHeaders();
    *    out.write("some text");
    * </code>
    *
    * @param out The output stream
    * @param in The input stream
    * @param e The exception to be reported
    */
   public void writeError(HttpOutputStream out, HttpInputStream in, Exception e) throws IOException;

   /**
    * Preprocess a path and return a replacement path. For instance the / path
    * could be replaced by the server path
    *
    * @param path The original path
    * @return the replacement path. If not modification the path param should
    * be returned
    */
   public String preProcess(String path);

   /**
    * Let the processor load internally a not found element. This can be used
    * to load images, stylesheets and so on. If return is not null, the path is
    * processed
    *
    * @param path The request element
    * @param out The output stream
    * @param in The input stream
    */
   public String notFoundElement(String path, HttpOutputStream out, HttpInputStream in) throws IOException, HttpException;
}