View Javadoc

1   /*
2    * Copyright 2004-2009 the Seasar Foundation and the Others.
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * 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,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
13   * either express or implied. See the License for the specific language
14   * governing permissions and limitations under the License.
15   */
16  package org.seasar.cubby.controller;
17  
18  import java.util.Map;
19  
20  import javax.servlet.http.HttpServletRequest;
21  
22  /**
23   * リクエスト解析器です。
24   * 
25   * @author baba
26   * @since 1.0.0
27   */
28  public interface RequestParser {
29  
30  	/**
31  	 * 指定されたリクエストのリクエストパラメータ等から、アクションにバインドするパラメータを取得します。
32  	 * 
33  	 * @param request
34  	 *            リクエスト
35  	 * @return アクションにバインドするパラメータの {@link Map}
36  	 * @throws RequestParseException
37  	 *             リクエストの解析に失敗した場合
38  	 */
39  	Map<String, Object[]> getParameterMap(HttpServletRequest request);
40  
41  	/**
42  	 * このリクエスト解析器が解析可能なリクエストかを示します。
43  	 * 
44  	 * @param request
45  	 *            リクエスト
46  	 * @return 解析可能なリクエストの場合は <code>true</code>、そうでない場合は <code>false</code>
47  	 * @since 1.1.0
48  	 */
49  	boolean isParsable(HttpServletRequest request);
50  
51  }