remote-content-api/document-aggregator/src/main/java/org/apache/sling/documentaggregator/api/DocumentAggregator.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.documentaggregator.api;

import org.apache.sling.api.resource.Resource;
import org.jetbrains.annotations.NotNull;
import org.osgi.annotation.versioning.ProviderType;

/**
 * Maps Sling {@link Resource} to a {@link DocumentTree.DocumentNode}
 */
@ProviderType
public interface DocumentAggregator {

    interface UrlBuilder {
        String pathToUrl(String path);
    }

    public static class Options {
        public final boolean debug;
        public final UrlBuilder urlBuilder;
        public Options(boolean debug, UrlBuilder urlBuilder) {
            this.debug = debug;
            this.urlBuilder = urlBuilder;
        }
    }
    
    void aggregate(@NotNull Resource r, @NotNull DocumentTree.DocumentNode destination, Options opt);
}