001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.wicket.markup;
018
019import org.apache.wicket.MarkupContainer;
020
021/**
022 * To be implemented by MarkupContainers that wish to implement their own algorithms for the markup
023 * cache key.
024 * 
025 * <p>
026 * If {@link #getCacheKey(MarkupContainer, Class)} method returns <code>null</code> the markup is
027 * not cached.
028 * </p>
029 * 
030 * @see IMarkupResourceStreamProvider
031 * 
032 * @author Juergen Donnerstag
033 */
034public interface IMarkupCacheKeyProvider
035{
036        /**
037         * Provide the markup cache key for the associated Markup resource stream.
038         * 
039         * @see IMarkupResourceStreamProvider
040         * 
041         * @param container
042         *            The MarkupContainer object requesting the markup cache key
043         * @param containerClass
044         *            The container the markup should be associated with
045         * @return A IResourceStream if the resource was found
046         */
047        String getCacheKey(final MarkupContainer container, Class<?> containerClass);
048}