1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 *
19 */
20
21 package org.apache.mina.http.api;
22
23 import java.util.List;
24 import java.util.Map;
25
26 /**
27 * An HTTP request element
28 *
29 * @author <a href="http://mina.apache.org">Apache MINA Project</a>
30 */
31 public interface HttpRequest extends HttpMessage {
32
33 /**
34 * Determines whether this request contains at least one parameter with the specified name
35 *
36 * @param name The parameter name
37 * @return <tt>true</tt> if this request contains at least one parameter with the specified name
38 */
39 boolean containsParameter(String name);
40
41 /**
42 * Returns the value of a request parameter as a String, or null if the parameter does not exist.
43 *
44 * If the request contained multiple parameters with the same name, this method returns the first parameter
45 * encountered in the request with the specified name
46 *
47 * @param name The parameter name
48 * @return The value
49 */
50 String getParameter(String name);
51
52 /**
53 * @return The query part
54 */
55 String getQueryString();
56
57 /**
58 * @return a read only {@link Map} of query parameters whose key is a {@link String} and whose value is a
59 * {@link List} of {@link String}s.
60 */
61 Map<String, List<String>> getParameters();
62
63 /**
64 * Return the HTTP method used for this message {@link HttpMethod}
65 *
66 * @return the method
67 */
68 HttpMethod getMethod();
69
70 /**
71 * Return the HTTP request path
72 *
73 * @return the request path
74 */
75 String getRequestPath();
76 }