/**
 * This file Copyright (c) 2003-2012 Magnolia International
 * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
 *
 *
 * This file is dual-licensed under both the Magnolia
 * Network Agreement and the GNU General Public License.
 * You may elect to use one or the other of these licenses.
 *
 * This file is distributed in the hope that it will be
 * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
 * implied warranty of MERCHANTABILITY or FITNESS FOR A
 * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
 * Redistribution, except as permitted by whichever of the GPL
 * or MNA you select, is prohibited.
 *
 * 1. For the GPL license (GPL), you can redistribute and/or
 * modify this file under the terms of the GNU General
 * Public License, Version 3, as published by the Free Software
 * Foundation.  You should have received a copy of the GNU
 * General Public License, Version 3 along with this program;
 * if not, write to the Free Software Foundation, Inc., 51
 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * 2. For the Magnolia Network Agreement (MNA), this file
 * and the accompanying materials are made available under the
 * terms of the MNA which accompanies this distribution, and
 * is available at http://www.magnolia-cms.com/mna.html
 *
 * Any modifications to this file must keep this entire header
 * intact.
 *
 */
package info.magnolia.cms.beans.config;

/**
 * VirtualURIMapping implementations are used by {@link info.magnolia.cms.beans.config.VirtualURIManager} and
 * {@link info.magnolia.cms.filters.VirtualUriFilter} to transform incoming URI requests.
 *
 * @author philipp
 * @version $Id$
 *
 * @content2bean.component path="/modules/.../virtualURIMapping"
 */
public interface VirtualURIMapping {

    /**
     * Maps an incoming URI to a new target URI. Returns a {@link VirtualURIMapping.MappingResult} describing the new
     * URI and the level of match. The new URI can be prefixed with "redirect:", "permanent:" or "forward:" to trigger
     * either a temporary redirect, a permanent redirect or a forward respectively. For redirects the URI can be
     * absolute or relative within the web application (the context path is added automatically). If the mapping does
     * not apply to the input URI this method returns null.
     *
     * @param uri the URI of the current request, decoded and without the context path
     * @return a {@link VirtualURIMapping.MappingResult} with the target URI and level or null if the mapping doesn't apply
     */
    MappingResult mapURI(String uri);

    /**
     * Mapping information returned by {@link VirtualURIMapping#mapURI(String)}.
     */
    public static class MappingResult{

        private String toURI;

        /**
         * Qualifies the matching (the length of the pattern). The best matching will win.
         */
        private int level;

        public int getLevel() {
            return this.level;
        }

        public void setLevel(int level) {
            this.level = level;
        }

        public String getToURI() {
            return this.toURI;
        }

        public void setToURI(String toURI) {
            this.toURI = toURI;
        }
    }
}