lib/server-api/src/main/java/org/apache/olingo/server/api/debug/DebugResponseHelper.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.server.api.debug;

import org.apache.olingo.server.api.ODataResponse;

/**
 * Support for applications creating debug responses.
 */
public interface DebugResponseHelper {

  /**
   * Creates a debug response based on the given parameters. Will never throw an exception.
   * @param debugInfo debug information
   * @return the debug response or the raw application response in case an exception occurred
   */
  ODataResponse createDebugResponse(DebugInformation debugInfo);
}