CarteRequestHandler.java

/*! ******************************************************************************
 *
 * Pentaho Data Integration
 *
 * Copyright (C) 2002-2016 by Pentaho : http://www.pentaho.com
 *
 *******************************************************************************
 *
 * 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.pentaho.di.www;

import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.io.PrintWriter;
import java.util.Collection;
import java.util.Map;

/**
 * @see BaseCartePlugin
 * @author nhudak
 */
public interface CarteRequestHandler {
  void handleRequest( CarteRequest request ) throws IOException;

  interface CarteRequest {
    String getMethod();

    Map<String, Collection<String>> getHeaders();

    String getHeader( String name );

    Map<String, Collection<String>> getParameters();

    String getParameter( String name );

    InputStream getInputStream() throws IOException;

    CarteResponse respond( int status );
  }

  interface CarteResponse {
    void with( String contentType, WriterResponse response ) throws IOException;

    void with( String contentType, OutputStreamResponse response ) throws IOException;

    void withMessage( String text ) throws IOException;
  }

  interface WriterResponse {
    void write( PrintWriter writer ) throws IOException;
  }

  interface OutputStreamResponse {
    void write( OutputStream outputStream ) throws IOException;
  }
}