org.apache.sling.caconfig.resource.spi.ContextPathStrategy Maven / Gradle / Ivy
/*
* 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.caconfig.resource.spi;
import java.util.Iterator;
import javax.annotation.Nonnull;
import org.apache.sling.api.resource.Resource;
import org.osgi.annotation.versioning.ConsumerType;
/**
* Allows application to define a strategy to find context paths and config references for content paths.
* A context paths is the root path of a "configuration context", which is a subtree in the resource hierarchy.
* Each context may have it's own context-aware configuration attached to.0
* If multiple context path strategy implementations are defined the results of them are merged.
*/
@ConsumerType
public interface ContextPathStrategy {
/**
* Finds context paths for the given resource.
* @param resource Context resource
* @return Root resource and config reference for each context found (in order of closest matching first).
* Only one of the parent resources or the resource itself may be included in the result.
* If none are found an empty list is returned.
*/
@Nonnull Iterator findContextResources(@Nonnull Resource resource);
}