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.management.geronimo;
018    
019    import java.util.Date;
020    
021    /**
022     * A web container access log manager.
023     *
024     * @version $Rev: 706640 $ $Date: 2008-10-21 14:44:05 +0000 (Tue, 21 Oct 2008) $
025     */
026    public interface WebAccessLog extends Log {
027        /**
028         * Gets the name of all logs used by this system.  Typically there
029         * is only one, but specialized cases may use more.
030         *
031         * @return An array of all log names
032         *
033         */
034        String[] getLogNames();
035    
036        /**
037         * Gets the name of all log files used by this log.  Typically there
038         * is only one, but specialized cases may use more.
039         *
040         * @param log The name of the log for which to return the specific file names. 
041         *
042         * @return An array of all log file names
043         *
044         */
045        String[] getLogFileNames(String log);
046    
047        /**
048         * Searches the log for records matching the specified parameters.  The
049         * maximum results returned will be the lesser of 1000 and the
050         * provided maxResults argument.
051         *
052         * @see #MAX_SEARCH_RESULTS
053         */
054        SearchResults getMatchingItems(String logName, String host, String user, String method,
055                                       String uri, Date startDate, Date endDate,
056                                       Integer skipResults, Integer maxResults);
057    
058    }