View Javadoc

1   /*
2    * Copyright 2012 The Netty Project
3    *
4    * The Netty Project licenses this file to you under the Apache License,
5    * version 2.0 (the "License"); you may not use this file except in compliance
6    * with the License. You may obtain a copy of the License at:
7    *
8    *   http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12   * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13   * License for the specific language governing permissions and limitations
14   * under the License.
15   */
16  package io.netty.handler.codec.http;
17  
18  
19  /**
20   * An HTTP response.
21   *
22   * <h3>Accessing Cookies</h3>
23   * <p>
24   * Unlike the Servlet API, {@link io.netty.handler.codec.http.cookie.Cookie} support is provided
25   * separately via {@link io.netty.handler.codec.http.cookie.ServerCookieDecoder},
26   * {@link io.netty.handler.codec.http.cookie.ClientCookieDecoder},
27   * {@link io.netty.handler.codec.http.cookie.ServerCookieEncoder},
28   * and {@link @io.netty.handler.codec.http.cookie.ClientCookieEncoder}.
29   *
30   * @see HttpRequest
31   * @see io.netty.handler.codec.http.cookie.ServerCookieDecoder
32   * @see io.netty.handler.codec.http.cookie.ClientCookieDecoder
33   * @see io.netty.handler.codec.http.cookie.ServerCookieEncoder
34   * @see io.netty.handler.codec.http.cookie.ClientCookieEncoder
35   */
36  public interface HttpResponse extends HttpMessage {
37  
38      /**
39       * Returns the status of this {@link HttpResponse}.
40       *
41       * @return The {@link HttpResponseStatus} of this {@link HttpResponse}
42       */
43      HttpResponseStatus getStatus();
44  
45      /**
46       * Set the status of this {@link HttpResponse}.
47       */
48      HttpResponse setStatus(HttpResponseStatus status);
49  
50      @Override
51      HttpResponse setProtocolVersion(HttpVersion version);
52  }