Source code

001package org.apache.archiva.metadata.repository.stats.model;
002
003/*
004 * Licensed to the Apache Software Foundation (ASF) under one
005 * or more contributor license agreements.  See the NOTICE file
006 * distributed with this work for additional information
007 * regarding copyright ownership.  The ASF licenses this file
008 * to you under the Apache License, Version 2.0 (the
009 * "License"); you may not use this file except in compliance
010 * with the License.  You may obtain a copy of the License at
011 *
012 *   http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing,
015 * software distributed under the License is distributed on an
016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017 * KIND, either express or implied.  See the License for the
018 * specific language governing permissions and limitations
019 * under the License.
020 */
021
022import org.apache.archiva.metadata.repository.MetadataRepository;
023import org.apache.archiva.metadata.repository.MetadataRepositoryException;
024import org.apache.archiva.metadata.repository.RepositorySession;
025
026/**
027 *
028 * This interface is used for populating statistics data. It should be implemented
029 * by metadata store implementations in the MetadataRepository class, if the store
030 * implementation can provide a faster implementation than walking the tree.
031 *
032 * @author Martin Stockhammer
033 * @since 2.3
034 */
035public interface RepositoryStatisticsProvider
036{
037
038    /**
039     * Populate the statistics object with the statistics data of this repository.
040     *
041     *
042     * @param repositorySession
043     * @param repository The current metadata repository implementation
044     * @param repositoryId The repository Id
045     * @param statistics The statistics object that should be filled.
046     * @throws MetadataRepositoryException Is thrown, if an error occurs while accessing the repository
047     */
048    void populateStatistics( RepositorySession repositorySession, MetadataRepository repository, String repositoryId, RepositoryStatistics statistics )
049        throws MetadataRepositoryException;
050}