| /* |
| * 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; |
| |
| import aQute.bnd.annotation.ProviderType; |
| |
| import org.jetbrains.annotations.NotNull; |
| |
| /** |
| * A {@link org.apache.sling.distribution.DistributionRequest} represents the need from the caller to have |
| * some content being distributed from a source instance to a target instance. |
| */ |
| @ProviderType |
| public interface DistributionRequest { |
| |
| |
| /** |
| * Get the {@link DistributionRequestType} associated with this request |
| * |
| * @return the type of the request as a {@link DistributionRequestType} |
| */ |
| @NotNull |
| DistributionRequestType getRequestType(); |
| |
| /** |
| * Get the root paths for this distribution request |
| * |
| * @return an array of paths |
| */ |
| @NotNull |
| public String[] getPaths(); |
| |
| /** |
| * Returns whether the paths are covering the entire subtree (deep) or just the specified nodes (shallow) |
| * |
| * @param path the path to be checked |
| * @return <code>true</code> if the paths are deep |
| */ |
| public boolean isDeep(@NotNull String path); |
| |
| |
| |
| /** |
| * Get the filters applicable for a specific path |
| * +/foo/.* - include all content under /foo |
| * -/foo - exclude /foo node |
| * |
| * filters are checked in order and the last matched filter determines inclusion/exclusion |
| * |
| * @return an array of filters |
| */ |
| @NotNull |
| public String[] getFilters(String path); |
| } |