| /* |
| * 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.distribution.packaging.impl; |
| |
| import javax.annotation.CheckForNull; |
| import javax.annotation.Nonnull; |
| |
| import aQute.bnd.annotation.ConsumerType; |
| import org.apache.sling.api.resource.ResourceResolver; |
| import org.apache.sling.distribution.DistributionRequest; |
| import org.apache.sling.distribution.common.DistributionException; |
| import org.apache.sling.distribution.packaging.DistributionPackage; |
| import org.apache.sling.distribution.queue.spi.DistributionQueue; |
| |
| /** |
| * A {@link DistributionPackageExporter) is responsible of exporting {@link DistributionPackage }s from a local or remote |
| * Sling instance. |
| * Such packages are usually imported by a {@link DistributionPackageImporter } or put inside |
| * {@link DistributionQueue }s for others to consume them. |
| * Exporting a {@link DistributionPackage} means obtaining that package by e.g. directly creating it by bundling local |
| * Sling resources, retrieving it from a remote endpoint (by executing an HTTP POST request on another Sling |
| * instance exposing packages ina queue). |
| */ |
| @ConsumerType |
| public interface DistributionPackageExporter { |
| |
| /** |
| * Exports the {@link DistributionPackage}s built from the |
| * passed {@link org.apache.sling.distribution.DistributionRequest}. |
| * |
| * @param resourceResolver the resource resolver used to export the packages, for example a 'local' exporter |
| * will use the resource resolver to read the content and assemble the binary in a certain |
| * location in the repository while a 'remote' exporter will use the resolver just to |
| * store the binary of the remotely fetched packages in the repository. |
| * @param distributionRequest the request containing the needed information for content to be exported |
| * @param packageProcessor a callback to process the exported package |
| */ |
| void exportPackages(@Nonnull ResourceResolver resourceResolver, @Nonnull DistributionRequest distributionRequest, |
| @Nonnull DistributionPackageProcessor packageProcessor) throws DistributionException; |
| |
| /** |
| * Retrieves a {@link DistributionPackage} given its identifier, if it already exists. |
| * This will be used for example to get already created (and cached) packages that were not yet distributed to the |
| * target instance. |
| * |
| * @param resourceResolver - the resource resolver use to obtain the package. |
| * @param distributionPackageId - the {@link DistributionPackage#getId() id of the package} to be retrieved |
| * @return a {@link DistributionPackage} if available, {@code null} otherwise |
| */ |
| @CheckForNull |
| DistributionPackage getPackage(@Nonnull ResourceResolver resourceResolver, @Nonnull String distributionPackageId) throws DistributionException; |
| } |