src/main/java/org/apache/sling/spi/resource/mapping/ResourceUriMapper.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.sling.spi.resource.mapping;

import javax.servlet.http.HttpServletRequest;

import org.apache.sling.api.resource.uri.ResourceUri;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import org.osgi.annotation.versioning.ConsumerType;

/** SPI interface that contributes to resource mapping and resolving of the resource resolver's map() and resolve() methods.
 * 
 * All registered services build a conceptual chain sorted by service ranking. The resource URI is passed through the chain while any
 * ResourceUriMapper chain member may or may not make adjustments to the resource URI.
 * 
 * rr.resolve() passes through the chain starting at the ResourceUriMapper with the <strong>highest</strong> service ranking and rr.map()
 * passes through the chain starting at the ResourceUriMapper with the <strong>lowest</strong> service ranking */
@ConsumerType
public interface ResourceUriMapper {

    /** Contributes to the map process, may or may not make adjustments to the resource URI.
     * 
     * @param resourceUri the URI to be mapped
     * @param request the request to be taken as example
     * @param context can be used to skip further processing of the chain or for sharing state between instances of ResourceUriMapper
     *            services
     * @return the adjusted ResourceUri or if no adjustments are necessary, just return resourceUri as passed in by first parameter */
    ResourceUri map(@NotNull ResourceUri resourceUri, @Nullable HttpServletRequest request, @NotNull MappingChainContext context);

    /** Contributes to the resolve process, may or may not make adjustments to the resource URI
     * 
     * @param resourceUri the URI to be resolved
     * @param request the request context that may or may not influence the resolution process (request may be null)
     * @param context can be used to skip further processing of the chain or for sharing state between instances of ResourceUriMapper
     *            services
     * @return the adjusted ResourceUri or if no adjustments are necessary, just return resourceUri as passed in by first parameter */
    ResourceUri resolve(@NotNull ResourceUri resourceUri, @Nullable HttpServletRequest request, @NotNull MappingChainContext context);

}