View Javadoc

    1   /*
    2    * Copyright 2009 Red Hat, Inc.
    3    *
    4    * Red Hat licenses this file to you under the Apache License, version 2.0
    5    * (the "License"); you may not use this file except in compliance with the
    6    * 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   *
    29   * @author <a href="http://www.jboss.org/netty/">The Netty Project</a>
    30   * @author Andy Taylor (andy.taylor@jboss.org)
    31   * @version $Rev: 2080 $, $Date: 2010-01-26 18:04:19 +0900 (Tue, 26 Jan 2010) $
    32   *
    33   * @see HttpResponse
    34   * @see CookieEncoder
    35   * @see CookieDecoder
    36   */
    37  public interface HttpRequest extends HttpMessage {
    38
    39      /**
    40       * Returns the method of this request.
    41       */
    42      HttpMethod getMethod();
    43
    44      /**
    45       * Sets the method of this request.
    46       */
    47      void setMethod(HttpMethod method);
    48
    49      /**
    50       * Returns the URI (or path) of this request.
    51       */
    52      String getUri();
    53
    54      /**
    55       * Sets the URI (or path) of this request.
    56       */
    57      void setUri(String uri);
    58  }