View Javadoc

1   /*
2    * $Id$
3    *
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *  http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  package org.apache.struts2.rest;
23  
24  import org.apache.struts2.rest.handler.ContentTypeHandler;
25  
26  import javax.servlet.http.HttpServletRequest;
27  import javax.servlet.http.HttpServletResponse;
28  
29  import com.opensymphony.xwork2.config.entities.ActionConfig;
30  
31  import java.io.IOException;
32  
33  /***
34   * Manages content type handlers
35   */
36  public interface ContentTypeHandlerManager {
37      String STRUTS_REST_HANDLER_OVERRIDE_PREFIX = "struts.rest.handlerOverride.";
38  
39      /***
40       * Gets the handler for the request by looking at the request content type and extension
41       * @param req The request
42       * @return The appropriate handler
43       */
44      ContentTypeHandler getHandlerForRequest(HttpServletRequest req);
45  
46      /***
47       * Gets the handler for the response by looking at the extension of the request
48       * @param req The request
49       * @return The appropriate handler
50       */
51      ContentTypeHandler getHandlerForResponse(HttpServletRequest req, HttpServletResponse res);
52  
53      /***
54       * Handles the result using handlers to generate content type-specific content
55       *
56       * @param actionConfig The action config for the current request
57       * @param methodResult The object returned from the action method
58       * @param target The object to return, usually the action object
59       * @return The new result code to process
60       * @throws IOException If unable to write to the response
61       */
62      String handleResult(ActionConfig actionConfig, Object methodResult, Object target)
63              throws IOException;
64  }