src/main/java/org/apache/sling/api/resource/mapping/spi/ResourceMapping.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.api.resource.mapping.spi;

import java.util.Map;

import org.apache.sling.api.SlingHttpServletRequest;
import org.apache.sling.api.resource.uri.ResourceURI;
import org.jetbrains.annotations.NotNull;
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 are sorted by service ranking and put in a list that forms a pipeline. The resource link is passed through the
 * pipeline while any ResourceMapping pipeline member may or may not make adjustments to the resource link.
 * 
 * rr.resolve() passes through the pipeline starting at the ResourceMapping with the <strong>highest</strong> service ranking rr.map()
 * passes through the pipeline starting at the ResourceMapping with the <strong>lowest</strong> service ranking */
@ConsumerType
public interface ResourceMapping {
    
    /** Contributes to the resolve process, may or may not make adjustments to the resource link
     * 
     * @param resourceURI the URI to be resolved
     * @param request the servlet request
     * @param pipelineContext can be used for sharing state between instances of ResourceMapping
     * @return true if no other ResourceMapping services should be considered after this, false if the pipeline should continue */
    boolean resolve(@NotNull ResourceURI resourceURI, SlingHttpServletRequest request, Map<String, Object> pipelineContext);

    /** Contributes to the map process, may or may not make adjustments to the resource link.
     * 
     * @param resourceURI the URI to be mapped
     * @param request the servlet request
     * @param pipelineContext can be used for sharing state between instances of ResourceMapping
     * @return true if no other ResourceMapping services should be considered after this, false if the pipeline should continue */
    boolean map(@NotNull ResourceURI resourceURI, SlingHttpServletRequest request, Map<String, Object> pipelineContext);

}