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.io.Serializable;
020    
021    /**
022     * A general log manager.
023     *
024     * @version $Rev: 476049 $ $Date: 2006-11-16 23:35:17 -0500 (Thu, 16 Nov 2006) $
025     */
026    public interface Log {
027        /**
028         * The most search lines that will ever be returned, no matter what you
029         * ask for.  This is to conserve memory and transfer bandwidth.
030         */
031        public final static int MAX_SEARCH_RESULTS = 1000;
032        
033        public static class LogMessage implements Serializable {
034            private final int lineNumber;
035            private final String lineContent;
036    
037            public LogMessage(int lineNumber, String lineContent) {
038                this.lineNumber = lineNumber;
039                this.lineContent = lineContent;
040            }
041    
042            public int getLineNumber() {
043                return lineNumber;
044            }
045    
046            public String getLineContent() {
047                return lineContent;
048            }
049        }
050    
051        public static class SearchResults implements Serializable {
052            private final int lineCount; // total lines in log file
053            private final LogMessage[] results;
054            private final boolean capped; // whether there were more matched than are returned here
055    
056            public SearchResults(int lineCount, LogMessage[] results, boolean capped) {
057                this.lineCount = lineCount;
058                this.results = results;
059                this.capped = capped;
060            }
061    
062            public int getLineCount() {
063                return lineCount;
064            }
065    
066            public LogMessage[] getResults() {
067                return results;
068            }
069    
070            public boolean isCapped() {
071                return capped;
072            }
073        }
074    }