View Javadoc

1   /*
2    * $Id: ResponseGenerator.java 22607 2011-08-08 02:13:54Z pablo.kraan $
3    * --------------------------------------------------------------------------------------
4    * Copyright (c) MuleSoft, Inc.  All rights reserved.  http://www.mulesoft.com
5    *
6    * The software in this package is published under the terms of the CPAL v1.0
7    * license, a copy of which has been included with this distribution in the
8    * LICENSE.txt file.
9    */
10  
11  package org.mule.cache.responsegenerator;
12  
13  import org.mule.api.MuleEvent;
14  
15  /**
16   * Generates {@link MuleEvent} responses from an request event and a previously
17   * cached response.
18   * <p/>
19   * There is no constraint on the way the response is generated, it could be the
20   * same cached response, or could be a new instance with different properties.
21   */
22  public interface ResponseGenerator
23  {
24  
25      /**
26       * Generates a response event from a request and a cached response for the
27       * request.
28       *
29       * @param request        the request event
30       * @param cachedResponse the cached response for the request
31       * @return a response event generated form the passed information. Could
32       *         be null.
33       */
34      MuleEvent create(MuleEvent request, MuleEvent cachedResponse);
35  }