001    /**
002     *  Licensed to the Apache Software Foundation (ASF) under one or more
003     *  contributor license agreements.  See the NOTICE file distributed with
004     *  this work for additional information regarding copyright ownership.
005     *  The ASF licenses this file to You under the Apache License, Version 2.0
006     *  (the "License"); you may not use this file except in compliance with
007     *  the License.  You may obtain a copy of the License at
008     *
009     *     http://www.apache.org/licenses/LICENSE-2.0
010     *
011     *  Unless required by applicable law or agreed to in writing, software
012     *  distributed under the License is distributed on an "AS IS" BASIS,
013     *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014     *  See the License for the specific language governing permissions and
015     *  limitations under the License.
016     */
017    package org.apache.geronimo.kernel.repository;
018    
019    import java.util.SortedSet;
020    
021    /**
022     * For repositories that can provide a list of their contents.
023     * Normally local ones can handle it, but remote ones may or may
024     * not implement this.
025     *
026     * @version $Rev: 706640 $ $Date: 2008-10-21 14:44:05 +0000 (Tue, 21 Oct 2008) $
027     */
028    public interface ListableRepository extends Repository {
029        /**
030         * Gets a set (with entries of type Artifact) of all the items available
031         * in the repository.
032         * @return sorted list of artifacts in the repository
033         */
034        public SortedSet<Artifact> list();
035    
036        /**
037         * Gets a set (with entries of type Artifact) of all the available items
038         * matching the specified artifact, which is normally not fully resolved
039         * (so the results all match whatever fields are specified on the argument
040         * Artifact).
041         * @param query match for repository
042         * @return sorted list of artifacts in the repository that match the query.
043         */
044        public SortedSet<Artifact> list(Artifact query);
045    }