package org.apache.archiva.metadata.repository.stats.model;

/*
 * 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.
 */

import org.apache.archiva.metadata.repository.MetadataRepository;
import org.apache.archiva.metadata.repository.MetadataRepositoryException;
import org.apache.archiva.metadata.repository.RepositorySession;

/**
 *
 * This interface is used for populating statistics data. It should be implemented
 * by metadata store implementations in the MetadataRepository class, if the store
 * implementation can provide a faster implementation than walking the tree.
 *
 * @author Martin Stockhammer
 * @since 2.3
 */
public interface RepositoryStatisticsProvider
{

    /**
     * Populate the statistics object with the statistics data of this repository.
     *
     *
     * @param repositorySession
     * @param repository The current metadata repository implementation
     * @param repositoryId The repository Id
     * @param statistics The statistics object that should be filled.
     * @throws MetadataRepositoryException Is thrown, if an error occurs while accessing the repository
     */
    void populateStatistics( RepositorySession repositorySession, MetadataRepository repository, String repositoryId, RepositoryStatistics statistics )
        throws MetadataRepositoryException;
}
