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    *   https://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.netty5.handler.codec.http;
17  
18  import io.netty5.handler.codec.http.cookie.ClientCookieDecoder;
19  import io.netty5.handler.codec.http.cookie.ClientCookieEncoder;
20  import io.netty5.handler.codec.http.cookie.Cookie;
21  import io.netty5.handler.codec.http.cookie.ServerCookieDecoder;
22  import io.netty5.handler.codec.http.cookie.ServerCookieEncoder;
23  
24  /**
25   * An HTTP response.
26   *
27   * <h3>Accessing Cookies</h3>
28   * <p>
29   * Unlike the Servlet API, {@link Cookie} support is provided separately via {@link ServerCookieDecoder},
30   * {@link ClientCookieDecoder}, {@link ServerCookieEncoder}, and {@link ClientCookieEncoder}.
31   *
32   * @see HttpRequest
33   * @see ServerCookieDecoder
34   * @see ClientCookieDecoder
35   * @see ServerCookieEncoder
36   * @see ClientCookieEncoder
37   */
38  public interface HttpResponse extends HttpMessage {
39      /**
40       * Returns the status of this {@link HttpResponse}.
41       *
42       * @return The {@link HttpResponseStatus} of this {@link HttpResponse}
43       */
44      HttpResponseStatus status();
45  
46      /**
47       * Set the status of this {@link HttpResponse}.
48       */
49      HttpResponse setStatus(HttpResponseStatus status);
50  
51      @Override
52      HttpResponse setProtocolVersion(HttpVersion version);
53  }