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.action;
17  
18  import javax.servlet.http.HttpServletRequest;
19  import javax.servlet.http.HttpServletResponse;
20  
21  /**
22   * エラーの応答を返すことを示す {@link ActionResult} です。
23   * <p>
24   * アクションメソッドの戻り値としてこのインスタンスを指定すると、エラーの応答を返します。
25   * </p>
26   * 
27   * @author baba
28   */
29  public class SendError implements ActionResult {
30  
31  	/** ステータスコード。 */
32  	private final int statusCode;
33  
34  	/** メッセージ。 */
35  	private final String message;
36  
37  	/**
38  	 * インスタンスを生成します。
39  	 * 
40  	 * @param statusCode
41  	 *            ステータスコード
42  	 * @see HttpServletResponse#sendError(int)
43  	 */
44  	public SendError(final int statusCode) {
45  		this(statusCode, null);
46  	}
47  
48  	/**
49  	 * インスタンスを生成します。
50  	 * 
51  	 * @param statusCode
52  	 *            ステータスコード
53  	 * @param message
54  	 *            メッセージ
55  	 * @see HttpServletResponse#sendError(int, String)
56  	 */
57  	public SendError(final int statusCode, final String message) {
58  		this.statusCode = statusCode;
59  		this.message = message;
60  	}
61  
62  	/**
63  	 * {@inheritDoc}
64  	 */
65  	public void execute(final ActionContext actionContext,
66  			final HttpServletRequest request, final HttpServletResponse response)
67  			throws Exception {
68  		if (message == null) {
69  			response.sendError(statusCode);
70  		} else {
71  			response.sendError(statusCode, message);
72  		}
73  	}
74  
75  	/**
76  	 * ステータスコードを取得します。
77  	 * 
78  	 * @return ステータスコード
79  	 * @since 2.0.2
80  	 */
81  	public int getStatusCode() {
82  		return statusCode;
83  	}
84  
85  	/**
86  	 * メッセージを取得します。
87  	 * 
88  	 * @return メッセージ
89  	 * @since 2.0.2
90  	 */
91  	public String getMessage() {
92  		return message;
93  	}
94  
95  }