org.elasticsearch.rest.RestResponse Maven / Gradle / Ivy

Go to download
/*
 * 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.io.IOException;
import java.util.List;
import java.util.Map;

/**
 *
 */
public interface RestResponse {

    /**
     * Can the content byte[] be used only with this thread (false), or by any thread (true).
     */
    boolean contentThreadSafe();

    String contentType();

    /**
     * Returns the actual content. Note, use {@link #contentLength()} in order to know the
     * content length of the byte array.
     */
    byte[] content() throws IOException;

    /**
     * The content length.
     */
    int contentLength() throws IOException;

    int contentOffset() throws IOException;

    byte[] prefixContent();

    int prefixContentLength();

    int prefixContentOffset();

    byte[] suffixContent();

    int suffixContentLength();

    int suffixContentOffset();

    RestStatus status();

    void addHeader(String name, String value);

    /**
     * @return The custom headers or null if none have been set
     */
    Map> getHeaders();
}