odata2-lib/odata-api/src/main/java/org/apache/olingo/odata2/api/ODataDebugResponseWrapperCallback.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.olingo.odata2.api;

import org.apache.olingo.odata2.api.processor.ODataContext;
import org.apache.olingo.odata2.api.processor.ODataRequest;
import org.apache.olingo.odata2.api.processor.ODataResponse;
import org.apache.olingo.odata2.api.uri.UriInfo;

/**
 * Debug handler.
 */
public interface ODataDebugResponseWrapperCallback extends ODataCallback {

  /**
   * Handles the output of a response helpful in case of debugging.
   * @param context generic context information
   * @param request the original request
   * @param response the original response
   * @param uriInfo structured parts of the request URI
   * @param exception the exception in case of an error
   * @return the debug response
   */
  ODataResponse handle(ODataContext context, ODataRequest request, ODataResponse response, UriInfo uriInfo,
      Exception exception);
}