Spring/spring-integration
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Added configurable 'requestKey' and 'replyKey' for the model map when response rendering is handled by a provided View instance.

Browse Source
This commit is contained in:
Mark Fisher
2009-02-26 21:29:10 +00:00
parent f687c6b9ac
commit f9f4832582
1 changed files with 38 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

50
org.springframework.integration.http/src/main/java/org/springframework/integration/http/HttpInboundEndpoint.java
View File

@@ -72,9 +72,10 @@ import org.springframework.web.servlet.View;
* {@link #setRequestChannel(org.springframework.integration.core.MessageChannel) request channel},
* a response will be generated. If a {@link #setView(View) view} has been
* provided, it will be invoked to render the response, and it will have
* access to the 'requestMessage' in the model map. If no view is provided,
* and the 'expectReply' value is <code>false</code> then a simple OK
* status response will be issued.
* access to the request message in the model map. The corresponding key
* in that map is determined by the {@link #requestKey} property (with a
* default of "requestMessage"). If no view is provided, and the 'expectReply'
* value is <code>false</code> then a simple OK status response will be issued.
* <p/>
* To handle request-reply scenarios, set the 'expectReply' flag to
* <code>true</code>. By default, the reply Message's payload will be
@@ -86,15 +87,21 @@ import org.springframework.web.servlet.View;
* In the request-reply case, if a 'view' is provided, the response will
* not be generated directly from the reply Message or its extracted payload.
* Instead, the model map will be passed to that view, and it will contain
* either 'replyMessage' or 'replyPayload' depending on the value of
* {@link #extractReplyPayload}. The model map will also contain the
* original 'requestMessage'.
* either the reply Message or payload depending on the value of
* {@link #extractReplyPayload}. The corresponding key in the map will be
* determined by the {@link #replyKey} property (with a default of "reply").
* The map will also contain the original request Message as described above.
*
* @author Mark Fisher
* @since 1.0.2
*/
public class HttpInboundEndpoint extends SimpleMessagingGateway implements HttpRequestHandler {
private static final String DEFAULT_REQUEST_KEY = "requestMessage";
private static final String DEFAULT_REPLY_KEY = "reply";
private volatile List<String> supportedMethods = Arrays.asList("GET", "POST");
private volatile boolean expectReply;
@@ -105,6 +112,10 @@ public class HttpInboundEndpoint extends SimpleMessagingGateway implements HttpR
private volatile View view;
private volatile String requestKey = DEFAULT_REQUEST_KEY;
private volatile String replyKey = DEFAULT_REPLY_KEY;
/**
* Specify the supported request methods for this endpoint.
@@ -161,6 +172,24 @@ public class HttpInboundEndpoint extends SimpleMessagingGateway implements HttpR
this.view = view;
}
/**
* Specify the key to be used when storing the request Message in the model
* map. This is only necessary when a {@link #setView(View) view} has been
* provided for rendering the response. The default key is "requestMessage".
*/
public void setRequestKey(String requestKey) {
this.requestKey = (requestKey != null) ? requestKey : DEFAULT_REQUEST_KEY;
}
/**
* Specify the key to be used when storing the reply Message or payload in
* the model map. This is only necessary when a {@link #setView(View) view}
* has been provided for rendering the response. The default key is "reply".
*/
public void setReplyKey(String replyKey) {
this.replyKey = (replyKey != null) ? replyKey : DEFAULT_REPLY_KEY;
}
public void handleRequest(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
if (!this.supportedMethods.contains(request.getMethod())) {
response.setStatus(HttpServletResponse.SC_METHOD_NOT_ALLOWED);
@@ -286,12 +315,9 @@ public class HttpInboundEndpoint extends SimpleMessagingGateway implements HttpR
HttpServletRequest httpRequest, HttpServletResponse httpResponse) throws ServletException, IOException {
if (this.view != null) {
Map<String, Object> model = new HashMap<String, Object>();
model.put("requestMessage", requestMessage);
if (reply instanceof Message) {
model.put("replyMessage", reply);
}
else if (reply != null) {
model.put("replyPayload", reply);
model.put(this.requestKey, requestMessage);
if (reply != null) {
model.put(this.replyKey, reply);
}
try {
this.view.render(model, httpRequest, httpResponse);