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.html;
018
019import org.apache.wicket.markup.head.IHeaderResponse;
020
021/**
022 * Setting an IHeaderResponseDecorator on an application allows you to wrap any {@link IHeaderResponse}
023 * created by Wicket in a separate implementation that adds functionality to it when used by all
024 * {@link IHeaderContributor} components or behaviors.
025 * <p>
026 * Everywhere that Wicket creates an instance of IHeaderResponse, it will call to your application
027 * and give it the opportunity to decorate that IHeaderResponse before using it.
028 * 
029 * @see IHeaderResponse
030 * @see DecoratingHeaderResponse
031 * @author Jeremy Thomerson
032 */
033public interface IHeaderResponseDecorator
034{
035
036        /**
037         * The method that does the decorating of the IHeaderResponse.
038         * 
039         * @param response
040         *            the original response created by Wicket
041         * @return the response to be used by IHeaderContributors
042         */
043        IHeaderResponse decorate(IHeaderResponse response);
044}