View Javadoc

1   /*
2    * $Id: HttpHeaders.java 651946 2008-04-27 13:41:38Z apetrelli $
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 javax.servlet.http.HttpServletRequest;
25  import javax.servlet.http.HttpServletResponse;
26  
27  /***
28   * Type-safe rest-related informtion to apply to a response
29   */
30  public interface HttpHeaders {
31  
32      /***
33       * Applies the configured information to the response
34       * @param request The request
35       * @param response The response
36       * @param target The target object, usually the action
37       * @return The result code to process
38       */
39      String apply(HttpServletRequest request,
40              HttpServletResponse response, Object target);
41      
42      /***
43       * The HTTP status code
44       */
45      int getStatus();
46  }