View Javadoc

1   /*
2    * Copyright 2004-2008 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 java.io.Writer;
19  
20  import javax.servlet.http.HttpServletRequest;
21  import javax.servlet.http.HttpServletResponse;
22  
23  import org.seasar.cubby.controller.ActionContext;
24  import org.seasar.framework.util.JSONSerializer;
25  import org.seasar.framework.util.StringUtil;
26  
27  /**
28   * JSON 形式のレスポンスを返す {@link ActionResult} です。
29   * <p>
30   * アクションメソッドの戻り値としてこのインスタンスを指定することで、指定された JavaBean を JSON/JSONP 形式に変換してレスポンスを返します。
31   * ブラウザの JavaScript から発行されたリクエストを処理する場合等に使用してください。
32   * </p>
33   * <p>
34   * 使用例1 : JSON 形式のレスポンスを返す
35   * 
36   * <pre>
37   * MyBean bean = ...;
38   * return new Json(bean);
39   * </pre>
40   * 
41   * </p>
42   * <p>
43   * 使用例2 : コールバック関数名を指定して JSONP 形式のレスポンスを返す
44   * 
45   * <pre>
46   * MyBean bean = ...;
47   * return new Json(bean, &quot;callback&quot;);
48   * </pre>
49   * 
50   * </p>
51   * 
52   * @see <a href="http://www.json.org/">JSON(JavaScript Object Notation)</a>
53   * @see <a href="http://ajaxian.com/archives/jsonp-json-with-padding">JSONP(JSON with Padding)</a>
54   * @see JSONSerializer#serialize(Object)
55   * @author baba
56   */
57  public class Json extends AbstractActionResult {
58  
59  	private Object bean;
60  
61  	private String calllback;
62  
63  	/**
64  	 * JSON 形式でレスポンスを返すインスタンスを生成します。
65  	 * 
66  	 * @param bean
67  	 *            JSON 形式に変換する JavaBean
68  	 */
69  	public Json(final Object bean) {
70  		this(bean, null);
71  	}
72  
73  	/**
74  	 * JSONP 形式でレスポンスを返すインスタンスを生成します。
75  	 * 
76  	 * @param bean
77  	 *            JSON 形式に変換する JavaBean
78  	 * @param callback
79  	 *            コールバック関数名
80  	 */
81  	public Json(final Object bean, final String callback) {
82  		this.bean = bean;
83  		this.calllback = callback;
84  	}
85  	
86  	/**
87  	 * JSON 形式に変換する JavaBeanを取得します。
88  	 * @return JSON 形式に変換する JavaBean
89  	 */
90  	public Object getBean() {
91  		return this.bean;
92  	}
93  	
94  	/**
95  	 * コールバック関数名を取得します。
96  	 * @return コールバック関数名
97  	 */
98  	public String getCallback() {
99  		return this.calllback;
100 	}
101 	
102 	public void execute(final ActionContext context,
103 			final HttpServletRequest request, final HttpServletResponse response)
104 			throws Exception {
105 
106 		response.setContentType("text/javascript; charset=utf-8");
107 		response.setHeader("Cache-Control", "no-cache");
108 		response.setHeader("Pragma", "no-cache");
109 
110 		final String script;
111 		if (isJsonp()) {
112 			script = appendCallbackFunction(JSONSerializer.serialize(bean),
113 					calllback);
114 		} else {
115 			script = JSONSerializer.serialize(bean);
116 		}
117 
118 		final Writer writer = response.getWriter();
119 		writer.write(script);
120 		writer.flush();
121 	}
122 
123 	private boolean isJsonp() {
124 		return !StringUtil.isEmpty(calllback);
125 	}
126 
127 	private static String appendCallbackFunction(final String script,
128 			final String callback) {
129 		final StringBuilder builder = new StringBuilder(script.length()
130 				+ callback.length() + 10);
131 		builder.append(callback);
132 		builder.append("(");
133 		builder.append(script);
134 		builder.append(");");
135 		return builder.toString();
136 	}
137 
138 }