001    /*
002    // $Id: XmlaOlap4jCachedProxy.java 247 2009-06-20 05:52:40Z jhyde $
003    // This software is subject to the terms of the Eclipse Public License v1.0
004    // Agreement, available at the following URL:
005    // http://www.eclipse.org/legal/epl-v10.html.
006    // Copyright (C) 2007-2009 Julian Hyde
007    // All Rights Reserved.
008    // You must accept the terms of that agreement to use this software.
009    */
010    package org.olap4j.driver.xmla.proxy;
011    
012    import java.util.Map;
013    
014    import org.olap4j.OlapException;
015    import org.olap4j.driver.xmla.cache.XmlaOlap4jCache;
016    
017    /**
018     *
019     * Extended Proxy interface which supports cached SOAP calls.
020     *
021     * @author Luc Boudreau
022     * @version $Id: XmlaOlap4jCachedProxy.java 247 2009-06-20 05:52:40Z jhyde $
023     *
024     */
025    public interface XmlaOlap4jCachedProxy extends XmlaOlap4jProxy {
026    
027        /**
028         * <p>Sets the cache class to use as a SOAP message cache.
029         *
030         * <p>Calling this method is not mandatory. If it isn't called,
031         * no cache will be used and all SOAP requests will be sent to
032         * the service end-point.
033         *
034         * @param configParameters This contains all the parameters used
035         * to configure the Olap4j driver. It contains the full class name
036         * of the cache implementation to use as well as the raw Cache
037         * config parameters.
038         * @param properties The properties to configure the cache,
039         * so all config parameters which started
040         * by Cache.* are inside this convenient thigny.
041         * @see XmlaOlap4jCache
042         */
043        void setCache(
044            Map<String, String> configParameters,
045            Map<String, String> properties) throws OlapException;
046    
047    }
048    
049    // End XmlaOlap4jCachedProxy.java