jasenautoupdatelistener.java

spam source codejasen-0.9jASEN - java Anti Spam ENgine.zip 如标题所示

/*
 * @(#)JasenAutoUpdateListener.java	7/01/2005
 *
 * Copyright (c) 2005 jASEN.org
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *   1. Redistributions of source code must retain the above copyright notice,
 *      this list of conditions and the following disclaimer.
 *
 *   2. Redistributions in binary form must reproduce the above copyright
 *      notice, this list of conditions and the following disclaimer in
 *      the documentation and/or other materials provided with the distribution.
 *
 *   3. The names of the authors may not be used to endorse or promote products
 *      derived from this software without specific prior written permission.
 *
 *   4. Any modification or additions to the software must be contributed back
 *      to the project.
 *
 *   5. Any investigation or reverse engineering of source code or binary to
 *      enable emails to bypass the filters, and hence inflict spam and or viruses
 *      onto users who use or do not use jASEN could subject the perpetrator to
 *      criminal and or civil liability.
 *
 * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED WARRANTIES,
 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL JASEN.ORG,
 * OR ANY CONTRIBUTORS TO THIS SOFTWARE BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
 * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 */
package org.jasen.event;

import org.jasen.interfaces.JasenEventListener;
import org.jasen.update.JasenAutoUpdateParcelWrapper;
import org.jasen.update.JasenAutoUpdateReport;

/**
 * <p>
 * Listens for update events.
 * </p>
 * <P>
 * This listener is notified when the auto update engine passes through the various 
 * stages of updating, as inicated by the method signatutes.
 * </P>
 * <P>
 * NOTE:  It is VERY important that extended classes do not block inside event callbacks.
 * <br/>
 * When the auto update engine notifies the listener, in all cases (except onUpdateEnd) the 
 * auto update engine will block until the notification has completed.
 * </P>
 * In most circumstances, the listener has the option of aborting further processing of the 
 * update engine by returning a value of false.
 * <br/>
 * @author Jason Polites
 */
public abstract class JasenAutoUpdateListener implements JasenEventListener {
    
    public static final int DO_NOTHING = 0;
    public static final int RESTART_ENGINE = 1;
 
    /**
     * Called when an update commences
     * @param parcel The parcel of data containig the details of the update
     * @return A boolean indicating if the auto update engine should continue processing events
     */
    public abstract boolean onUpdateStart(JasenAutoUpdateParcelWrapper parcel);
    
    /**
     * Called when an auto update completes, but before any remaining tasks (like restarting) have completed
     * @param report The report from the update event
     * @return A boolean indicating if the auto update engine should continue processing events
     */
    public abstract boolean onUpdateEnd(JasenAutoUpdateReport report);
    
    /**
     * Called during the download of an update
     * @param bytes
     */
    public abstract void onUpdateDownload(long bytes);
    
    /**
     * Called when an auto update completion signalled an engine restart and the engine has been restarted.
     * @return A boolean indicating if the auto update engine should continue processing events
     */
    public abstract boolean onAfterUpdate();   
    
    /**
     * Called before an update commences
     * @return A boolean indicating if the auto update engine should continue processing events
     */
    public abstract boolean onBeforeUpdate();

}