001 /* 002 * CDDL HEADER START 003 * 004 * The contents of this file are subject to the terms of the 005 * Common Development and Distribution License, Version 1.0 only 006 * (the "License"). You may not use this file except in compliance 007 * with the License. 008 * 009 * You can obtain a copy of the license at 010 * trunk/opends/resource/legal-notices/OpenDS.LICENSE 011 * or https://OpenDS.dev.java.net/OpenDS.LICENSE. 012 * See the License for the specific language governing permissions 013 * and limitations under the License. 014 * 015 * When distributing Covered Code, include this CDDL HEADER in each 016 * file and include the License file at 017 * trunk/opends/resource/legal-notices/OpenDS.LICENSE. If applicable, 018 * add the following below this CDDL HEADER, with the fields enclosed 019 * by brackets "[]" replaced with your own identifying information: 020 * Portions Copyright [yyyy] [name of copyright owner] 021 * 022 * CDDL HEADER END 023 * 024 * 025 * Copyright 2006-2008 Sun Microsystems, Inc. 026 */ 027 package org.opends.server.api; 028 029 030 031 import org.opends.server.types.BackupConfig; 032 033 034 035 /** 036 * This interface defines a set of methods that may be used to notify 037 * various Directory Server components whenever a backend backup task 038 * is about to begin or has just completed. Note that these methods 039 * will only be invoked for the backup task and not for offline backup 040 * processing. 041 */ 042 @org.opends.server.types.PublicAPI( 043 stability=org.opends.server.types.StabilityLevel.VOLATILE, 044 mayInstantiate=false, 045 mayExtend=true, 046 mayInvoke=false) 047 public interface BackupTaskListener 048 { 049 /** 050 * Performs any processing that might be necessary just before the 051 * server begins processing on a backup task. This may include 052 * flushing any outstanding writes to disk so they are included in 053 * the backup and/or pausing interaction with the provided backend 054 * while the backup is in progress. 055 * 056 * @param backend The backend to be archived. 057 * @param config Configuration information about the backup to be 058 * performed. 059 */ 060 public void processBackupBegin(Backend backend, 061 BackupConfig config); 062 063 064 065 /** 066 * Performs any processing that might be necessary after the server 067 * has completed processing on a backup task. Note that this will 068 * always be called when backup processing completes, regardless of 069 * whether it was successful. 070 * 071 * @param backend The backend that was archived. 072 * @param config Configuration information about the backup 073 * that was performed. 074 * @param successful Indicates whether the backup operation 075 * completed successfully. 076 */ 077 public void processBackupEnd(Backend backend, BackupConfig config, 078 boolean successful); 079 } 080