/*
 * Licensed to Elasticsearch under one or more contributor
 * license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright
 * ownership. Elasticsearch 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.elasticsearch.rest;

import java.util.List;
import java.util.Map;

/**
 * Classes that carry rest headers should implement this interface. Specifically, exceptions that
 * get translated to a rest response, can implement this interface and the headers will be added
 * the the response.
 *
 * @see org.elasticsearch.ElasticsearchException.WithRestHeaders
 */
public interface HasRestHeaders {

    /**
     * @return The rest headers
     */
    Map<String, List<String>> getHeaders();
}
