All Downloads are FREE. Search and download functionalities are using the official Maven repository.
  • Log In
  • Register

    • ratpack.http.Request Maven / Gradle / Ivy

    There is a newer version: 2.0.0-rc-1
    Show newest version
    /*
 * Copyright 2013 the original author or authors.
 *
 * Licensed 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 ratpack.http;

import io.netty.handler.codec.http.Cookie;
import ratpack.api.Nullable;
import ratpack.registry.MutableRegistry;
import ratpack.util.MultiValueMap;

import java.util.Set;

/**
 * A request to be handled.
 */
@SuppressWarnings("UnusedDeclaration")
public interface Request extends MutableRegistry {

  /**
   * The method of the request.
   *
   * @return The method of the request.
   */
  HttpMethod getMethod();

  /**
   * The complete URI of the request (path + query string).
   * 
    
   * This value is always absolute (i.e. begins with "{@code /}").
   *
   * @return The complete URI of the request (path + query string).
   */
  String getUri();

  /**
   * The query string component of the request URI, without the "?".
   * 
    
   * If the request does not contain a query component, an empty string will be returned.
   *
   * @return The query string component of the request URI, without the "?".
   */
  String getQuery();

  /**
   * The URI without the query string and leading forward slash.
   *
   * @return The URI without the query string and leading forward slash
   */
  String getPath();

  /**
   * TBD.
   *
   * @return TBD.
   */
  MultiValueMap getQueryParams();

  /**
   * The cookies that were sent with the request.
   * 
    
   * An empty set will be returned if no cookies were sent.
   *
   * @return The cookies that were sent with the request.
   */
  Set getCookies();

  /**
   * Returns the value of the cookie with the specified name if it was sent.
   * 
    
   * If there is more than one cookie with this name, this method will throw an exception.
   *
   * @param name The name of the cookie to get the value of
   * @return The cookie value, or null if not present
   */
  @Nullable
  String oneCookie(String name);

  /**
   * The body of the request.
   * 
    
   * If this request does not have a body, an non null object is still returned but it effectively has no data.
   *
   * @return the body of the request
   */
  TypedData getBody();

  /**
   * The request headers.
   *
   * @return The request headers.
   */
  Headers getHeaders();
}
    
    
    
    

    




    
    
    © 2015 - 2025 Weber Informatics LLC | Privacy Policy