001    /*
002    // $Id: XmlaOlap4jCachedProxy.java 482 2012-01-05 23:27:27Z jhyde $
003    //
004    // Licensed to Julian Hyde under one or more contributor license
005    // agreements. See the NOTICE file distributed with this work for
006    // additional information regarding copyright ownership.
007    //
008    // Julian Hyde licenses this file to you under the Apache License,
009    // Version 2.0 (the "License"); you may not use this file except in
010    // compliance with the License. You may obtain a copy of the License at:
011    //
012    // http://www.apache.org/licenses/LICENSE-2.0
013    //
014    // Unless required by applicable law or agreed to in writing, software
015    // distributed under the License is distributed on an "AS IS" BASIS,
016    // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
017    // See the License for the specific language governing permissions and
018    // limitations under the License.
019    */
020    package org.olap4j.driver.xmla.proxy;
021    
022    import org.olap4j.OlapException;
023    import org.olap4j.driver.xmla.cache.XmlaOlap4jCache;
024    
025    import java.util.Map;
026    
027    /**
028     *
029     * Extended Proxy interface which supports cached SOAP calls.
030     *
031     * @author Luc Boudreau
032     * @version $Id: XmlaOlap4jCachedProxy.java 482 2012-01-05 23:27:27Z jhyde $
033     *
034     */
035    public interface XmlaOlap4jCachedProxy extends XmlaOlap4jProxy {
036    
037        /**
038         * <p>Sets the cache class to use as a SOAP message cache.
039         *
040         * <p>Calling this method is not mandatory. If it isn't called,
041         * no cache will be used and all SOAP requests will be sent to
042         * the service end-point.
043         *
044         * @param configParameters This contains all the parameters used
045         * to configure the Olap4j driver. It contains the full class name
046         * of the cache implementation to use as well as the raw Cache
047         * config parameters.
048         * @param properties The properties to configure the cache,
049         * so all config parameters which started
050         * by Cache.* are inside this convenient thigny.
051         * @see XmlaOlap4jCache
052         */
053        void setCache(
054            Map<String, String> configParameters,
055            Map<String, String> properties) throws OlapException;
056    
057    }
058    
059    // End XmlaOlap4jCachedProxy.java