001package org.apache.commons.jcs.auxiliary.remote.http.client.behavior;
002
003/*
004 * Licensed to the Apache Software Foundation (ASF) under one
005 * or more contributor license agreements.  See the NOTICE file
006 * distributed with this work for additional information
007 * regarding copyright ownership.  The ASF licenses this file
008 * to you under the Apache License, Version 2.0 (the
009 * "License"); you may not use this file except in compliance
010 * 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,
015 * software distributed under the License is distributed on an
016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017 * KIND, either express or implied.  See the License for the
018 * specific language governing permissions and limitations
019 * under the License.
020 */
021
022import org.apache.commons.jcs.auxiliary.remote.http.client.RemoteHttpCacheAttributes;
023import org.apache.commons.jcs.engine.behavior.ICacheServiceNonLocal;
024
025import java.io.IOException;
026
027
028/**
029 * It's not entirely clear that this interface is needed. I simply wanted the initialization method.
030 * This could be added to the ICacheSerice method.
031 */
032public interface IRemoteHttpCacheClient<K, V>
033    extends ICacheServiceNonLocal<K, V>
034{
035    /**
036     * The provides an extension point. If you want to extend this and use a special dispatcher,
037     * here is the place to do it.
038     * <p>
039     * @param attributes
040     */
041    void initialize( RemoteHttpCacheAttributes attributes );
042
043    /**
044     * Make and alive request.
045     * <p>
046     * @return true if we make a successful alive request.
047     * @throws IOException
048     */
049    boolean isAlive()
050        throws IOException;
051}