View Javadoc

1   /***
2    *
3    * Copyright 2004 Hiram Chirino
4    *
5    * Licensed under the Apache License, Version 2.0 (the "License");
6    * you may not use this file except in compliance with the License.
7    * You may obtain a copy of the License at
8    *
9    * http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   *
17   **/
18  package org.codehaus.activemq.journal;
19  
20  /***
21   * Defines an object which listens for Journal Events.
22   * 
23   * @version $Revision: 1.1 $
24   */
25  public interface JournalEventListener {
26  
27  	/***
28  	 * This event is issues when a Journal implementations wants to recover 
29  	 * disk space used by old records.  If journal space is not reliquised 
30  	 * by setting the Journal's mark at or past the <code>safeLocation</code>
31  	 * further write opperations against the Journal may casuse IOExceptions 
32  	 * to occur due to a log overflow condition.
33  	 * 
34  	 * @param safeLocation the oldest location that the journal recomends the mark to be set.
35  	 */
36  	void overflowNotification(RecordLocation safeLocation);
37  
38  }