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 org.jboss.netty.handler.codec.http;
17  
18  
19  /**
20   * An HTTP request.
21   *
22   * <h3>Accessing Query Parameters and Cookie</h3>
23   * <p>
24   * Unlike the Servlet API, a query string is constructed and decomposed by
25   * {@link QueryStringEncoder} and {@link QueryStringDecoder}.  {@link Cookie}
26   * support is also provided separately via {@link CookieEncoder} and
27   * {@link CookieDecoder}.
28   * @see HttpResponse
29   * @see CookieEncoder
30   * @see CookieDecoder
31   */
32  public interface HttpRequest extends HttpMessage {
33  
34      /**
35       * Returns the method of this request.
36       */
37      HttpMethod getMethod();
38  
39      /**
40       * Sets the method of this request.
41       */
42      void setMethod(HttpMethod method);
43  
44      /**
45       * Returns the URI (or path) of this request.
46       */
47      String getUri();
48  
49      /**
50       * Sets the URI (or path) of this request.
51       */
52      void setUri(String uri);
53  }