maint-5-2/tapestry-core/src/main/java/org/apache/tapestry5/services/URLRewriter.java

// Copyright 2009, 2010 The Apache Software Foundation
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package org.apache.tapestry5.services;

import org.apache.tapestry5.services.linktransform.LinkTransformer;
import org.apache.tapestry5.urlrewriter.URLRewriteContext;


/**
 * Service that implements URL and link rewriting.
 *
 *
 * @since 5.1.0.2
 * @deprecated Use {@link LinkTransformer} instead
 */
public interface URLRewriter
{
    /**
     * Processes an incoming {@linkplain org.apache.tapestry5.services.Request}.
     * This method must check if they need to rewrite this request. If no, it must return the received
     * request unchanged. This method cannot return null.
     * 
     * @param request
     *            a {@link org.apache.tapestry5.services.Request}.
     * @return request a {@link org.apache.tapestry5.services.Request}. It cannot be null.
     */
    Request processRequest(Request request);

    /**
     * Processes rules for rewriting links.
     * @param request the request to examine
     * @param context the context providing additional information for rewriting
     * @return the original request if the URLRewriter does nothing, a modified request otherwise, but never null
     */
    Request processLink(Request request, URLRewriteContext context);
    
    /**
     *
     * 
     * @return true if the urlrewriter has any rules for rewriting inbound request urls
     */
    boolean hasRequestRules();


    /**
     * @return true if the URLRewriter has any rules for rewriting outbound links.
     */
    boolean hasLinkRules();

}