ConfigurationPersistenceStrategyMultiplexer.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.caconfig.management.multiplexer;

import java.util.Collection;

import javax.annotation.Nonnull;

import org.apache.sling.caconfig.spi.ConfigurationPersistenceStrategy2;
import org.osgi.annotation.versioning.ProviderType;

/**
 * Detects all {@link ConfigurationPersistenceStrategy2} implementations in the container
 * and consolidates their result based on service ranking.
 */
@ProviderType
public interface ConfigurationPersistenceStrategyMultiplexer extends ConfigurationPersistenceStrategy2 {
    
    /**
     * Get all configuration names from all configuration persistence strategies. This can be used when no nested parent resources is known.
     * @param configName Configuration name
     * @return Possible configuration names in order of persistence strategy service ranking.
     */
    @Nonnull Collection<String> getAllConfigNames(@Nonnull String configName);

    /**
     * Get all configuration names from all configuration persistence strategies. This can be used when no nested parent resources is known.
     * @param configName Configuration name
     * @return Possible configuration names in order of persistence strategy service ranking.
     */
    @Nonnull Collection<String> getAllCollectionParentConfigNames(@Nonnull String configName);

    /**
     * Get all configuration names from all configuration persistence strategies. This can be used when no nested parent resources is known.
     * @param configName Configuration name
     * @return Possible configuration names in order of persistence strategy service ranking.
     */
    @Nonnull Collection<String> getAllCollectionItemConfigNames(@Nonnull String configName);
        
}