org.mule.cache.CachingStrategy Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mule-core

Mule server and core classes

There is a newer version: 3.9.0

/*
 * $Id: CachingStrategy.java 22607 2011-08-08 02:13:54Z pablo.kraan $
 * --------------------------------------------------------------------------------------
 * Copyright (c) MuleSoft, Inc.  All rights reserved.  http://www.mulesoft.com
 *
 * The software in this package is published under the terms of the CPAL v1.0
 * license, a copy of which has been included with this distribution in the
 * LICENSE.txt file.
 */

package org.mule.cache;

import org.mule.api.MuleEvent;
import org.mule.api.MuleException;
import org.mule.api.processor.MessageProcessor;

/**
 * Defines a way to process a {@link MuleEvent} using a cache.
 */
public interface CachingStrategy
{

    /**
     * Processes a {@link MuleEvent} using a caching schema. Uses a message processor
     * to process the request when it is not found in the cache or when it must
     * be processed without using the cache.
     * 
     * Different calls to this method using the same request does not implies
     * that the same instance will be returned. Each implementation could
     * choose to create new instances every time.
     *
     * @param request          the event to process
     * @param messageProcessor the message processor that will be executed when
     *                         the response for the event is not in the cache.
     * @return a response for the request that could be obtained using the
     *         cache.
     * @throws MuleException
     */
    MuleEvent process(MuleEvent request, MessageProcessor messageProcessor) throws MuleException;
}